Type Alias TNavigationOptions

Type declaration

• OptionalcreateMarkers?: {
      connection?: boolean;
      departure?: boolean;
      destination?: boolean;
  }

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

  • Optionalconnection?: boolean

    Controls whether markers are created for connection points.

    Default

    true
    Copy

  • Optionaldeparture?: boolean

    Controls whether a marker is created for the departure point.

    Default

    true
    Copy

  • Optionaldestination?: boolean

    Controls whether a marker is created for the destination point.

    Default

    true
    Copy

• OptionalpathOptions?: {
      accentColor?: string;
      animateArrowsOnPath?: boolean;
      color?: string;
      displayArrowsOnPath?: boolean;
      farRadius?: number;
      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'
    Copy

  • OptionalanimateArrowsOnPath?: boolean

    Controls whether arrows are animated.

    Default

    false
    Copy

  • Optionalcolor?: string

    The color of the path.

    Default

    '#40A9FF'
    Copy

  • OptionaldisplayArrowsOnPath?: boolean

    Controls whether arrows are displayed on the path.

    Default

    false
    Copy

  • OptionalfarRadius?: number

    The radius of the path far from the markers.

    Default

    1
    Copy

  • OptionalnearRadius?: number

    The radius of the path near the markers.

    Default

    0.25
    Copy

• Optionalpolygons?: {
      departure?: string;
  }

  Options for the departure and destination polygons.

  • Optionaldeparture?: string

    The color of the departure polygon.

    Default

    '#40A9FF'
    Copy