Type Alias TAddPathOptions

TAddPathOptions: {
    __EXPERIMENTAL_BILLBOARDING?: boolean | number;
    __EXPERIMENTAL_BORDER?: {
        color: "darken" | string;
        enabled: boolean;
        width?: number;
    };
    __EXPERIMENTAL_DASH_OPTIONS?: TExperimentalDashOptions;
    __EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number];
    __EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon";
    __EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean;
    __EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number;
    __EXPERIMENTAL_SMOOTHING_TENSION?: number;
    __EXPERIMENTAL_XRAY_STYLE?: {
        color?: string;
        dithering?: number;
        opacity?: number;
        tint?: 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?: PathWidth;
    xrayOpacity?: number;
}

Options for controlling the behavior of a Path.

Type declaration

Optional Experimental__EXPERIMENTAL_BILLBOARDING?: boolean | number
Controls billboarding for ribbon path geometry.
- true: Every vertex faces the camera (unconditional billboard)
- false: Flat world-space orientation
- number: Angle threshold in degrees (0-90). Billboard only when path tangent verticality >= threshold. E.g. 80 means billboard only nearly-vertical segments.
Default Value
```
80
```
Optional Experimental__EXPERIMENTAL_BORDER?: { color: "darken" | string; enabled: boolean; width?: number }
Border configuration for ribbon path geometry. Renders darkened edges along both sides of the ribbon.
- color: "darken" | string
  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
```
Optional Experimental__EXPERIMENTAL_DASH_OPTIONS?: TExperimentalDashOptions
Dash configuration. When dashed=true, controls dash/gap sizing. Uses discriminated union - mode determines which properties are valid.

See
TExperimentalDashOptions
Optional Experimental__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]
Endcap extension for ribbon geometry as [start, end] tuple in meters.
- Value > 0: extends path and renders rounded cap
- Value = 0: square/flat end (no extension, no rounded cap)
Default Value
```
[0.5, 0.5]
```
Optional 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 Value
```
'tube'
```
Optional Experimental__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean
When true, prevents the xray path from rendering multiple overlapping pixels when the path crosses over itself. Uses stencil buffer to ensure single-pixel rendering.
Default Value
```
false
```
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
```
Optional Experimental__EXPERIMENTAL_XRAY_STYLE?: { color?: string; dithering?: number; opacity?: number; tint?: number }
Consolidated x-ray appearance configuration. Controls how paths look when behind geometry.
- Optionalcolor?: string
  Explicit color override for the x-ray portion. Omit to auto-compute from path color.
- Optionaldithering?: number
  Dithering cell size in screen pixels (e.g. 4 = 4x4px checkerboard). 0 or undefined = off.
- Optionalopacity?: number
  The opacity when behind geometry (0-1).
  Default
```
0.25
```
- Optionaltint?: number
  Tint strength (0-1). 0 = no muting, 1 = fully muted.
  Default
```
0.3
```
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?: PathWidth
The width of the path.
- number — meters (e.g. 1.5)
- 'Npx' — screen-space pixels (e.g. '20px'), ribbon geometry only
- Interpolation — zoom-interpolated meters
- Interpolation<'zoom-level', PixelWidth[]> — zoom-interpolated pixels (e.g. output: ['10px', '20px']), ribbon geometry only
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.

Prefer __EXPERIMENTAL_XRAY_STYLE.opacity instead. If both are set, __EXPERIMENTAL_XRAY_STYLE.opacity takes precedence.
Default Value
```
0.25
```

Type Alias TAddPathOptions

Type declaration

Optional Experimental__EXPERIMENTAL_BILLBOARDING?: boolean | number

Default Value

Optional Experimental__EXPERIMENTAL_BORDER?: { color: "darken" | string; enabled: boolean; width?: number }

color: "darken" | string

enabled: boolean

Optionalwidth?: number

Default

Optional Experimental__EXPERIMENTAL_DASH_OPTIONS?: TExperimentalDashOptions

See

Optional Experimental__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]

Default Value

Optional Experimental__EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon"

Default Value

Optional Experimental__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean

Default Value

Optional Experimental__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number

Default Value

Optional Experimental__EXPERIMENTAL_SMOOTHING_TENSION?: number

Default Value

Optional Experimental__EXPERIMENTAL_XRAY_STYLE?: { color?: string; dithering?: number; opacity?: number; tint?: number }

Optionalcolor?: string

Optionaldithering?: number

Optionalopacity?: number

Default

Optionaltint?: number

Default

OptionalaccentColor?: string

Default Value

OptionalanimateArrowsOnPath?: boolean

Default Value

OptionalanimateDrawing?: boolean

Default Value

Optionalcolor?: string

Default Value

Optionaldashed?: boolean

Default Value

OptionaldisplayArrowsOnPath?: boolean

Default Value

OptionaldrawDuration?: number

Default Value

OptionalflattenPath?: boolean

Default Value

Optionalinteractive?: boolean

Default Value

OptionalpulseIterations?: number

Default Value

OptionalpulsePauseDuration?: number

Default Value

OptionalshowPulse?: boolean

Default Value

OptionalverticalOffset?: number

Default Value

Optionalvisible?: boolean

Default Value

Optionalwidth?: PathWidth

Default Value

OptionalxrayOpacity?: number

Default Value

Settings

`Optional` `Experimental`__EXPERIMENTAL_BILLBOARDING?: boolean | number

`Optional` `Experimental`__EXPERIMENTAL_BORDER?: { color: "darken" | string; enabled: boolean; width?: number }

`Optional`width?: number

`Optional` `Experimental`__EXPERIMENTAL_DASH_OPTIONS?: TExperimentalDashOptions

`Optional` `Experimental`__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]

`Optional` `Experimental`__EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon"

`Optional` `Experimental`__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean

`Optional` `Experimental`__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number

`Optional` `Experimental`__EXPERIMENTAL_SMOOTHING_TENSION?: number

`Optional` `Experimental`__EXPERIMENTAL_XRAY_STYLE?: { color?: string; dithering?: number; opacity?: number; tint?: number }

`Optional`color?: string

`Optional`dithering?: number

`Optional`opacity?: number

`Optional`tint?: number

`Optional`accentColor?: string

`Optional`animateArrowsOnPath?: boolean

`Optional`animateDrawing?: boolean

`Optional`color?: string

`Optional`dashed?: boolean

`Optional`displayArrowsOnPath?: boolean

`Optional`drawDuration?: number

`Optional`flattenPath?: boolean

`Optional`interactive?: boolean

`Optional`pulseIterations?: number

`Optional`pulsePauseDuration?: number

`Optional`showPulse?: boolean

`Optional`verticalOffset?: number

`Optional`visible?: boolean

`Optional`width?: PathWidth

`Optional`xrayOpacity?: number