Class Navigation

When a user needs to get from point A to point B, drawing a path on the map helps them to navigate to their destination. It can help them to visualize the route they'll need to take, like a good treasure map.

Navigation is a helper class to display wayfinding easily on the map. Functionality of Navigation could be replicated by drawing the paths using Paths and adding well designed tooltips at connection points.

This class is accessed using MapView.Navigation.

Navigation.draw allows for easily drawing multiple components that make up a wayfinding illustration. It shows a human figure to mark the start point, a path with animated directional arrows, pulses in the direction of travel and a pin to mark the destination. Each of these components can be customized to match an app's style.

Refer to the Drawing Navigation in the Wayfinding Guide for more information and interactive examples.

Accessors

  • get activeDirections(): undefined | Directions
  • The currently active directions.

    Returns undefined | Directions

  • get activePath(): undefined | Path
  • The currently active path.

    Returns undefined | Path

  • get floorStacks(): FloorStack[]
  • The current list of floor stacks along the navigation paths.

    Returns FloorStack[]

  • get isMultiFloor(): boolean
  • Returns true if the navigation is for a multi-floor path.

    Returns boolean

Methods

  • Clears any drawn navigation paths or directions from the map.

    Returns void

  • Sets the active path.

    Parameters

    Returns void

  • Sets the active path by directions.

    Parameters

    Returns void

  • Sets the active path by index.

    Parameters

    • target: number

    Returns void