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

  • OptionaladjustedAltitude?: boolean

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

    Default Value

    false
  • 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
  • OptionaldisplayArrowsOnPath?: boolean

    Show arrows on path.

    Default Value

    false
  • OptionaldrawDuration?: number

    Duration of path drawing in milliseconds.

    Default Value

    1500
  • OptionalfarRadius?: number

    Radius of path at furthest zoom, in metres.

    Default Value

    0.4
  • OptionalfarZoom?: number

    Zoom level in meters where the path size is farRadius.

    Default Value

    1000
  • OptionalflattenPath?: boolean

    Flatten the path to a 2D line.

    Default Value

    false
  • Optionalinteractive?: boolean

    Whether the path should be clickable.

    Default Value

    false
  • OptionalmaxAdjustedAltitude?: number

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

    Default Value

    Infinite
  • OptionalminAdjustedAltitude?: number

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

    Default Value

    -Infinite
  • OptionalnearRadius?: number

    Radius of path at nearest zoom, in metres.

    Default Value

    0.2
  • OptionalnearZoom?: number

    Zoom level in meters where the path size is nearRadius.

    Default Value

    5
  • OptionalpulseColor?: string

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

Settings

Member Visibility