Type Alias TPathState

TPathState: {
    __EXPERIMENTAL_SMOOTHING_CORNER_RADIUS: number;
    __EXPERIMENTAL_SMOOTHING_TENSION: number;
    color: string;
    completeFraction: number;
    highlightColor: string;
    highlightCompleteFraction: number;
    highlightEndFraction: number;
    highlightStartFraction: number;
    highlightWidthMultiplier: number;
    type: "path";
    verticalOffset: number;
    visible: boolean;
    width: number | Interpolation<"zoom-level", number[]>;
    xrayOpacity: number;
}

Type declaration

  • 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
  • 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
  • color: string

    The color of the path.

    Default

    #4b90e2
  • completeFraction: number

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

    Default

    0
  • highlightColor: string

    The color of the highlight.

    Default

    red
  • highlightCompleteFraction: number

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

    Default

    1
  • highlightEndFraction: number

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

    Default

    0
  • highlightStartFraction: number

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

    Default

    0
  • highlightWidthMultiplier: number

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

    Default

    1.1
  • type: "path"
  • verticalOffset: number

    The altitude of the geometry, in meters

    Default

    0.1
  • visible: boolean

    Whether the path is visible.

    Default

    true
  • 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

Settings

Member Visibility