Type Alias TPathState

Type declaration

• Experimental__EXPERIMENTAL_BILLBOARDING: boolean

  When true and using ribbon geometry, the path will always face the camera (billboard effect). Most useful for vertical paths between floors.

  Default

  false
  Copy

• Optional Experimental__EXPERIMENTAL_BORDER?: { color: BorderColor; enabled: boolean; width?: number }

  Border configuration for ribbon path geometry. Renders darkened edges along both sides of the ribbon.

  • color: BorderColor

    Border color - 'darken' to auto-darken main color, or explicit hex color string

  • enabled: boolean

    Whether the border is enabled

  • Optionalwidth?: number

    Border width as fraction of total ribbon width (0-0.5).

    Default

    0.1
    Copy

• Optional Experimental__EXPERIMENTAL_DASH_OPTIONS?:
      | {
          __EXPERIMENTAL_DASH_GAP: number;
          __EXPERIMENTAL_DASH_LENGTH: number;
          __EXPERIMENTAL_DASH_MODE: "length-scaling";
      }
      | {
          __EXPERIMENTAL_DASH_MODE: "width-scaling";
          __EXPERIMENTAL_DASH_SIZE: number;
          __EXPERIMENTAL_GAP_SIZE: number;
      }
      | {
          __EXPERIMENTAL_DASH_METERS: number;
          __EXPERIMENTAL_DASH_MODE: "absolute";
          __EXPERIMENTAL_GAP_METERS: number;
      }

  Dash configuration. When dashed=true, controls dash/gap sizing. Uses discriminated union - mode determines which properties are valid.

• Experimental__EXPERIMENTAL_ENDCAP_ENABLED: boolean

  Whether to add end cap points to the path.

  Default

  false
  Copy

• Experimental__EXPERIMENTAL_GEOMETRY: "tube" | "ribbon"

  Geometry type for path rendering.

  • 'tube': Original tube geometry with 8 radial segments (default)
  • 'ribbon': Flat ribbon geometry with 2 vertices per segment

  Default

  'tube'
  Copy

• Experimental__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS: number

  Distance in meters from corners where control points are inserted for smoothing. Only applies when __EXPERIMENTAL_SMOOTHING_TENSION > 0. Typical values are 0.5-2.0 meters.

  Default

  0.5
  Copy

• Experimental__EXPERIMENTAL_SMOOTHING_TENSION: number

  Controls the smoothness of path corners using CatmullRom curve tension. Higher values create smoother curves. Values between 0.1-0.3 provide subtle smoothing.

  Default

  0.0
  Copy

• color: string

  The color of the path.

  Default

  #4b90e2
  Copy

• completeFraction: number

  The fraction of the path that should be complete. This can be used to animate the path.

  Default

  0
  Copy

• dashed: boolean

  Whether the path should be rendered as a dashed line.

  Default

  false
  Copy

• highlightColor: string

  The color of the highlight.

  Default

  red
  Copy

• highlightCompleteFraction: number

  The fraction of the highlighted path that should be complete. This can be used to animate the highlight.

  Default

  1
  Copy

• highlightEndFraction: number

  The end fraction of the path that should be highlighted. Indicates the end of the highlighted section.

  Default

  0
  Copy

• highlightStartFraction: number

  The start fraction of the path that should be highlighted. Indicates the start of the highlighted section.

  Default

  0
  Copy

• highlightWidthMultiplier: number

  The width multiplier of the highlight. Setting this to 1 will result in no changes to path width.

  Default

  1.1
  Copy

• type: "path"

• verticalOffset: number

  The altitude of the geometry, in meters

  Default

  0.1
  Copy

• visible: boolean

  Whether the path is visible.

  Default

  true
  Copy

• width: number | Interpolation<"zoom-level", number[]>

  The width of the path in meters. Can be a number or an Interpolation.

• xrayOpacity: number

  The opacity of the path when it's behind geometry (x-ray effect). Value from 0 to 1.

  Default

  0.25
  Copy