Type Alias TPathUpdateState

TPathUpdateState: {
    __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

  • Optional 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.

    0.5
    
  • Optional 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.

    0.0
    
  • Optionalcolor?: string

    The color of the path.

    #4b90e2
    
  • OptionalcompleteFraction?: number

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

    0
    
  • OptionalhighlightColor?: string

    The color of the highlight.

    red
    
  • OptionalhighlightCompleteFraction?: number

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

    1
    
  • OptionalhighlightEndFraction?: number

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

    0
    
  • OptionalhighlightStartFraction?: number

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

    0
    
  • OptionalhighlightWidthMultiplier?: number

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

    1.1
    
  • Optionaltype?: "path"
  • OptionalverticalOffset?: number

    The altitude of the geometry, in meters

    0.1
    
  • Optionalvisible?: boolean

    Whether the path is visible.

    true
    
  • Optionalwidth?: number | Interpolation<"zoom-level", number[]>

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

  • OptionalxrayOpacity?: number

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

    0.25