Type Alias TNavigationOptions

TNavigationOptions: {
    createMarkers?: {
        connection?: boolean | ((instruction: TDirectionInstruction) => Marker);
        departure?: boolean | ((instruction: TDirectionInstruction) => Marker);
        destination?: boolean | ((instruction: TDirectionInstruction) => Marker);
    };
    markerOptions?: {
        departureColor?: string;
        destinationColor?: string;
    };
    pathOptions?: {
        accentColor?: string;
        animateArrowsOnPath?: boolean;
        color?: string;
        displayArrowsOnPath?: boolean;
        drawDuration: number;
        farRadius?: number;
        interactive?: boolean;
        nearRadius?: number;
    };
}

Options for navigation.

Type declaration

  • OptionalcreateMarkers?: {
        connection?: boolean | ((instruction: TDirectionInstruction) => Marker);
        departure?: boolean | ((instruction: TDirectionInstruction) => Marker);
        destination?: boolean | ((instruction: TDirectionInstruction) => Marker);
    }

    Controls whether markers are created for the departure, destination, and connection points.

    • Optionalconnection?: boolean | ((instruction: TDirectionInstruction) => Marker)

      Controls whether markers are created for connection points and allows a custom marker to be created.

      Default

      true
    • Optionaldeparture?: boolean | ((instruction: TDirectionInstruction) => Marker)

      Controls whether a marker is created for the departure point and allows a custom marker to be created.

      Default

      true
    • Optionaldestination?: boolean | ((instruction: TDirectionInstruction) => Marker)

      Controls whether a marker is created for the destination point and allows a custom marker to be created.

      Default

      true
  • OptionalmarkerOptions?: {
        departureColor?: string;
        destinationColor?: string;
    }

    Options for the markers at the departure and destination.

    • OptionaldepartureColor?: string

      The color of the departure marker.

      Default

      '#1890FF'
    • OptionaldestinationColor?: string

      The color of the destination marker.

      Default

      '#722ED1'
  • OptionalpathOptions?: {
        accentColor?: string;
        animateArrowsOnPath?: boolean;
        color?: string;
        displayArrowsOnPath?: boolean;
        drawDuration: number;
        farRadius?: number;
        interactive?: boolean;
        nearRadius?: number;
    }

    Options for the path.

    • OptionalaccentColor?: string

      The accent color of the path. This is applied to arrows if they are displayed

      Default

      'blue'
    • OptionalanimateArrowsOnPath?: boolean

      Controls whether arrows are animated.

      Default

      false
    • Optionalcolor?: string

      The color of the path.

      Default

      '#40A9FF'
    • OptionaldisplayArrowsOnPath?: boolean

      Controls whether arrows are displayed on the path.

      Default

      false
    • drawDuration: number

      duration in milliseconds for the path to be drawn

      Default
    • OptionalfarRadius?: number

      The radius of the path far from the markers.

      Default

      1
    • Optionalinteractive?: boolean

      Whether the path should be clickable.

      Default Value

      false
    • OptionalnearRadius?: number

      The radius of the path near the markers.

      Default

      0.25

Settings

Member Visibility