Type alias TPathOptions

TPathOptions: {
    adjustedAltitude?: boolean;
    animateArrowsOnPath?: boolean;
    animateDrawing?: boolean;
    color?: string;
    displayArrowsOnPath?: boolean;
    drawDuration?: number;
    farRadius?: number | (() => number);
    farZoom?: number;
    flattenPath?: boolean;
    interactive?: boolean;
    maxAdjustedAltitude?: number;
    minAdjustedAltitude?: number;
    nearRadius?: number | (() => number);
    nearZoom?: number;
    pulseColor?: string;
    pulseIterations?: number;
    pulsePauseDuration?: number;
    showPulse?: boolean;
}

Type declaration

  • Optional Experimental adjustedAltitude?: boolean

    Default Value

    false
    The path will be adjusted vertically to the tallest polygon altitude.
  • Optional animateArrowsOnPath?: boolean

    Animate arrows on path.

    Default Value

    true
  • Optional animateDrawing?: boolean

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

    Default Value

    true
  • Optional color?: string

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

    Default Value

    #4b90e2
  • Optional displayArrowsOnPath?: boolean

    Show arrows on path.

    Default Value

    true
  • Optional drawDuration?: number

    Duration of path drawing in milliseconds.

    Default Value

    1500
  • Optional farRadius?: number | (() => number)

    Radius of path at furthest zoom, in metres.

    Default Value

    2.3 times nearRadius
  • Optional farZoom?: number

    Zoom level where the path size is farRadius.

    Default Value

    10000
  • Optional flattenPath?: boolean

    Flatten the path to a 2D line.

    Default Value

    false
  • Optional interactive?: boolean

    Whether the path should be clickable.

    Default Value

    false
  • Optional Experimental maxAdjustedAltitude?: number

    The maximum altitude of the path in meters.

    Default Value

    Infinite
  • Optional Experimental minAdjustedAltitude?: number

    Default Value

    -Infinite
    The minimum altitude of the path in meters.
  • Optional nearRadius?: number | (() => number)

    Radius of path at nearest zoom, in metres.

    Default Value

    1.8
  • Optional nearZoom?: number

    Zoom level where the path size is nearRadius.

    Default Value

    375
  • Optional pulseColor?: string

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

    Default Value

    '#ffffff'
  • Optional pulseIterations?: number

    Number of iterations to pulse to indicate direction.

    Default Value

    1
  • Optional pulsePauseDuration?: number

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

    Default Value

    750
  • Optional showPulse?: boolean

    Show an animated pulse indicating the direction of travel.

    Default Value

    true

Settings

Member Visibility

Theme