Type alias TAddPathOptions

TAddPathOptions: {
    adjustedAltitude?: boolean;
    animateArrowsOnPath?: boolean;
    animateDrawing?: boolean;
    color?: string;
    displayArrowsOnPath?: boolean;
    drawDuration?: number;
    farRadius?: number;
    farZoom?: number;
    flattenPath?: boolean;
    interactive?: boolean;
    maxAdjustedAltitude?: number;
    minAdjustedAltitude?: number;
    nearRadius?: number;
    nearZoom?: number;
    pulseColor?: string;
    pulseIterations?: number;
    pulsePauseDuration?: number;
    showPulse?: boolean;
}

Options for controlling the behavior of a Path.

Type declaration

  • Optional adjustedAltitude?: boolean

    The path will be adjusted vertically to the tallest polygon altitude. The altitude is in meters.

    Default Value

    false
  • 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 Colour

    Default Value

    #4b90e2
  • Optional displayArrowsOnPath?: boolean

    Show arrows on path

    Default Value

    false
  • Optional drawDuration?: number

    Duration of path drawing

    Default Value

    1500
  • Optional farRadius?: number

    Radius of path at furthest zoom, in metres

    Default Value

    2.3 times nearRadius
  • Optional farZoom?: number

    Zoom level in meters where the path size is farRadiustions.nearRadius

    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 maxAdjustedAltitude?: number

    The maximum altitude of the path in meters The altitude is in meters.

    Default Value

    Infinite
  • Optional minAdjustedAltitude?: number

    The minimum altitude of the path in meters The altitude is in meters.

    Default Value

    -Infinite
  • Optional nearRadius?: number

    Radius of path at nearest zoom, in metres

    Default Value

    1.8
  • Optional nearZoom?: number

    Zoom level in meters where the path size is nearRadius

    Default Value

    375
  • Optional pulseColor?: string

    Colour of path pulse

    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