Class Wayfinding

map

• get map(): Map

• Returns Map

• set map(instance): void

• Parameters

  • instance: Map

  Returns void

renderer

• get renderer(): Renderer

• Returns Renderer

constructor

• new Wayfinding(venueMap): Wayfinding

• Parameters

  • venueMap: VenueMap

  Returns Wayfinding

clearPathLayers

• clearPathLayers(): void

• Returns void

clearPathSelection

• clearPathSelection(): void

• Clears the current WF path

  Returns void

  Todo

  Fire a custom event

clearWayPathFromMap

• clearWayPathFromMap(): void

• Returns void

createTurnByTurnDirectionsForWaypath

• createTurnByTurnDirectionsForWaypath(waypath): MapDirectionStep[]

• Parameters

  • waypath: Waypath

  Returns MapDirectionStep[]

  An array of direction steps

findClosestWaypointForUnit

• findClosestWaypointForUnit(unitId): Waypoint

• Parameters

  • unitId: string

  Returns Waypoint

findPath

• findPath(start, end, options?): Waypath

• Find waypath between two Waypoints

  Parameters

  • start: Waypoint

    the id of the wayfinding node to start the route

  • end: Waypoint

    the id of the wayfinding node to end the route

  • options: WayfindingOptions = ...

  Returns Waypath

  A waypath object

fixCameraToSegment

• fixCameraToSegment(wp1, wp2): void

• Parameters

  • wp1: Waypoint

  • wp2: Waypoint

  Returns void

getDirections

• getDirections(startUnitId, endUnitId): MapDirectionStep[]

• Get turn by turn directions from two unit points

  Parameters

  • startUnitId: string

    Start unit id

  • endUnitId: string

    End unit id

  Returns MapDirectionStep[]

  An array of direction steps

getVmd

• getVmd(): VenueMapData

• Returns VenueMapData

hideFloor

• hideFloor(floorId): void

• Parameters

  • floorId: string

  Returns void

isActiveFloor

• isActiveFloor(floorId): boolean

• Parameters

  • floorId: string

  Returns boolean

loadImage

• loadImage(sourceUrl, key): Promise<unknown>

• Parameters

  • sourceUrl: string

  • key: string

  Returns Promise<unknown>

loadStyles

• loadStyles(): void

• Returns void

onSegmentSelected

• onSegmentSelected(segmentIndex): void

• Parameters

  • segmentIndex: number

  Returns void

renderWaypath

• renderWaypath(directions): void

• Manual render of the way path with the provided directions

  Parameters

  • directions: MapDirectionStep[]

    An array of map direction steps

  Returns void

  Since

  2.0.0

selectEndingPoint

• selectEndingPoint(unitId): void

• Parameters

  • unitId: string

  Returns void

selectStartingPoint

• selectStartingPoint(unitId): void

• Parameters

  • unitId: string

  Returns void

setWaypathPoint

• setWaypathPoint(unitId, type?): Waypoint

• Parameters

  • unitId: string

  • type: "start" | "end" = 'end'

  Returns Waypoint

setWaypointIcon

• setWaypointIcon(wp, type?): void

• Parameters

  • wp: Waypoint

  • type: "start" | "end" = 'end'

  Returns void

showFloor

• showFloor(floorId): void

• Parameters

  • floorId: string

  Returns void

  Todo

  Remove seems not usable

toggleSelection

• toggleSelection(unitId, clearOnNextSelection?): {
      end: Waypoint;
      start: Waypoint;
  }

• Parameters

  • unitId: string

  • clearOnNextSelection: boolean = false

  Returns {
      end: Waypoint;
      start: Waypoint;
  }

  • end: Waypoint

  • start: Waypoint

Static getInstance

• getInstance(vmd): Wayfinding

• Factory method to create a

  Parameters

  • vmd: VenueMapData

  Returns Wayfinding

Optional aegir

endPin

Optional endPoint

Optional endUnit

logger

startPin

Optional startPoint

Optional startUnit

Readonly venueMap