Type Alias TNavigationOptions

TNavigationOptions: {
    animatePathDrawing?: boolean;
    createMarkers?: {
        connection?: TCreateMarker;
        departure?: TCreateMarker;
        destination?: TCreateMarker;
    };
    inactivePathOptions?: Partial<TAddPathOptions>;
    markerOptions?: { departureColor?: string; destinationColor?: string };
    pathOptions?: Partial<TAddPathOptions>;
    setMapOnConnectionClick?: boolean;
    setMapToDeparture?: boolean;
}

Options for navigation.

Type declaration

  • OptionalanimatePathDrawing?: boolean

    Controls whether the path drawing is animated across floors.

    Default

    true
  • OptionalcreateMarkers?: {
        connection?: TCreateMarker;
        departure?: TCreateMarker;
        destination?: TCreateMarker;
    }

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

    • Optionalconnection?: TCreateMarker

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

      Default

      true
    • Optionaldeparture?: TCreateMarker

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

      Default

      true
    • Optionaldestination?: TCreateMarker

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

      Default

      true
  • OptionalinactivePathOptions?: Partial<TAddPathOptions>

    Path Options for the non-current path in multi-destination mode.

  • 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?: Partial<TAddPathOptions>

    Options for the path.

  • OptionalsetMapOnConnectionClick?: boolean

    Controls whether the map should be set to the floor of the connection point when a connection point is clicked.

    Default

    true
  • OptionalsetMapToDeparture?: boolean

    Controls whether the map should be set to the floor of the departure point when the path is drawn.

    Default

    true

Settings

Member Visibility