Type Alias TTetherOptions

TTetherOptions: {
    coordinateOutsideThresholdMode?:
        | "tether-and-dash"
        | "tether-only"
        | "untether";
    hideMarkersOutsideThreshold?: boolean;
    outsideThresholdPathOptions?: Partial<TAddPathOptions>;
    outsideThresholdPathStyle?: TOutsideThresholdPathStyle;
    tetherPathOptions?: Partial<TAddPathOptions>;
    tetherThresholdDistance?: number;
}

Options for tethering to a coordinate.

Type declaration

  • OptionalcoordinateOutsideThresholdMode?: "tether-and-dash" | "tether-only" | "untether"

    Controls behavior when the coordinate is outside the threshold distance from the path.

    • 'tether-and-dash': Creates both the tethered path and a dashed line from user to threshold point (default)
    • 'tether-only': Creates only the tethered path, no dashed line
    • 'untether': Untethers from the path until a coordinate within threshold is provided

    Default

    'tether-and-dash'
  • OptionalhideMarkersOutsideThreshold?: boolean

    Whether to hide markers on the portion of the path the user has already travelled past. Markers on the remaining path (current segment ahead of the user and all subsequent segments, including the destination marker) stay enabled.

    Default

    false
  • OptionaloutsideThresholdPathOptions?: Partial<TAddPathOptions>

    Low-level overrides applied on top of outsideThresholdPathStyle. Anything specified here wins over the preset.

  • OptionaloutsideThresholdPathStyle?: TOutsideThresholdPathStyle

    Visual preset for the connector line drawn from the tracked coordinate to the path when outside the tether threshold. See TOutsideThresholdPathStyle for the list of presets.

    For finer control, use outsideThresholdPathOptions which is merged on top of the preset.

    Default

    'dashed-boxes'
  • OptionaltetherPathOptions?: Partial<TAddPathOptions>

    Options for the tether path (solid path from threshold point to destination).

  • OptionaltetherThresholdDistance?: number

    The distance threshold within which the coordinate will be tethered to the path (meters).

    Default

    10

Settings

Member Visibility