Type Alias TAddPathOptions

TAddPathOptions: {
    __EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number;
    __EXPERIMENTAL_SMOOTHING_TENSION?: number;
    accentColor?: string;
    animateArrowsOnPath?: boolean;
    animateDrawing?: boolean;
    color?: string;
    dashed?: boolean;
    displayArrowsOnPath?: boolean;
    drawDuration?: number;
    flattenPath?: boolean;
    interactive?: boolean;
    pulseIterations?: number;
    pulsePauseDuration?: number;
    showPulse?: boolean;
    verticalOffset?: number;
    visible?: boolean;
    width?: number | Interpolation<"zoom-level", number[]>;
    xrayOpacity?: number;
}

Options for controlling the behavior of a Path.

Type declaration

  • Optional Experimental__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number

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

    Default Value

    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 suitable for most use cases.

    Default Value

    0.0
  • OptionalaccentColor?: string

    Accent color that is applied to the path pulse and path arrows

    Default Value

    '#ffffff'
  • OptionalanimateArrowsOnPath?: boolean

    Animate arrows on path.

    Default Value

    true
  • OptionalanimateDrawing?: boolean

    Animate the drawing of the path in the direction of travel.

    Default Value

    true
  • Optionalcolor?: string

    Path Colour. Color can be set using CSS colors names DarkGoldenRod, as Hex strings #0000FF or the rgb values rgb(255,0,0).

    Default Value

    #4b90e2
  • Optionaldashed?: boolean

    Whether the path should be dashed.

    Default Value

    false
  • OptionaldisplayArrowsOnPath?: boolean

    Show arrows on path.

    Default Value

    false
  • OptionaldrawDuration?: number

    Duration of path drawing in milliseconds.

    Default Value

    1500
  • OptionalflattenPath?: boolean

    Flatten the path to a 2D line.

    Default Value

    false
  • Optionalinteractive?: boolean

    Whether the path should be clickable.

    Default Value

    false
  • OptionalpulseIterations?: number

    Number of iterations to pulse to indicate direction.

    Default Value

    1
  • OptionalpulsePauseDuration?: number

    How many milliseconds to wait before starting the next pulse after the current pulse travels the entirety of the path.

    Default Value

    750
  • OptionalshowPulse?: boolean

    Show an animated pulse indicating the direction of travel.

    Default Value

    true
  • OptionalverticalOffset?: number

    How much the path hovers above the floor plane in meters.

    Default Value

    0.1
  • Optionalvisible?: boolean

    Whether the path should be visible.

    Default Value

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

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

    Default Value

    Interpolation { on: 'zoom-level', input: [17, 22], output: [0.8, 0.4] }
  • OptionalxrayOpacity?: number

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

    Default Value

    0.25

Settings

Member Visibility