Mappedin JS - v6.14.0
    Preparing search index...

    Type Alias TNavigationOptions

    Options for navigation.

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

    Properties

    animatePathDrawing? createMarkers? inactivePathOptions? markerOptions? pathOptions? setMapOnConnectionClick? setMapToDeparture?

    Properties

    animatePathDrawing?: boolean

    Controls whether the path drawing is animated across floors.

    true
    createMarkers?: {
        connection?: TCreateMarker;
        departure?: TCreateMarker;
        destination?: TCreateMarker;
    }

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

    Type Declaration

    • Optionalconnection?: TCreateMarker

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

      true
    • Optionaldeparture?: TCreateMarker

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

      true
    • Optionaldestination?: TCreateMarker

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

      true
    inactivePathOptions?: Partial<TAddPathOptions>

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

    markerOptions?: { departureColor?: string; destinationColor?: string }

    Options for the markers at the departure and destination.

    Type Declaration

    • OptionaldepartureColor?: string

      The color of the departure marker.

      '#1890FF'
    • OptionaldestinationColor?: string

      The color of the destination marker.

      '#722ED1'
    pathOptions?: Partial<TNavigationPathOptions>

    Options for the path. Connection paths inherit these options unless overridden with __EXPERIMENTAL__CONNECTION_* properties.

    setMapOnConnectionClick?: boolean

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

    true
    setMapToDeparture?: boolean

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

    true

    Settings

    Member Visibility

    On This Page

    Properties