Class VenueMap

waypointsMap

• get waypointsMap(): {
      [key: string]: Waypoint;
  }

• Returns {
      [key: string]: Waypoint;
  }

  • [key: string]: Waypoint

addNeighborForWaypointWithId

• addNeighborForWaypointWithId(waypointId, neighbor): void

• Adds a waypoint as a neighbor.

  Parameters

  • waypointId: string

    ID of waypoint to be given a neighbor.

  • neighbor: Waypoint

    The neighbor waypoint.

  Returns void

addNeighborForWaypoints

• addNeighborForWaypoints(waypointId, neighborId): void

• Adds a waypoint as a neighbor.

  Parameters

  • waypointId: string

    ID of waypoint to be given a neighbor.

  • neighborId: string

    ID of neighbor waypoint.

  Returns void

createTurnByTurnDirectionsForWaypath

• createTurnByTurnDirectionsForWaypath(path, customMapInfo?, options?): MapDirectionStep[]

• Creates turn by turn text directions for a given waypath.

  Parameters

  • path: Waypath

    The waypath to create text directions for.

  • customMapInfo: CustomMapInfo = ...

    A CustomMapInfo object that contains custom information for directions.

  • options: TurnByTurnDirectionOptions = ...

    Options to use when creating directions.

  Returns MapDirectionStep[]

  the list of directions

  Throws

  Exception if there are any failures during processing

  Since

  2.0

findClosestUnitForFixture

• findClosestUnitForFixture(floor, __namedParameters): MapUnit

• Parameters

  • floor: BaseMapBuildingFloor

  • __namedParameters: Waypoint

  Returns MapUnit

findClosestWaypointForUnit

• findClosestWaypointForUnit(unitId): Waypoint

• Parameters

  • unitId: string

  Returns Waypoint

findFloorWithId

• findFloorWithId(floorId): BaseMapBuildingFloor

• Iterates through all buildings to find a floor with the given id. All floors will have a unique id regardless of what building they are in.

  Parameters

  • floorId: string

    The id of the floor to search for

  Returns BaseMapBuildingFloor

  The floor that is found or null if one is not found for the given ID

findWaypathBetweenWaypoints

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

• Parameters

  • start: Waypoint

  • end: Waypoint

  • options: WayfindingOptions = ...

  Returns Waypath

findWaypointWithId

• findWaypointWithId(waypointId): Waypoint

• Iterates through buildings and floors until it finds a waypoint with the given ID.

  Parameters

  • waypointId: string

    The waypoint ID to search for.

  Returns Waypoint

  The waypoint that is found or null if one is not found for the given ID.

getAllBuildings

• getAllBuildings(): BuildingsMap

• Returns BuildingsMap

getAllFloors

• getAllFloors(): Map<string, BaseMapBuildingFloor>

• Returns Map<string, BaseMapBuildingFloor>

getAllUnits

• getAllUnits(): MapUnit[]

• Returns MapUnit[]

getAllWaypoints

• getAllWaypoints(): Waypoint[]

• Returns Waypoint[]

getBuildings

• getBuildings(): BuildingsMap

• Returns BuildingsMap

getDestinations

• getDestinations(): WayFindingNodeToUnitMap[]

• Returns WayFindingNodeToUnitMap[]

getNeighborsForWaypointWithId

• getNeighborsForWaypointWithId(waypointId): Waypoint[]

• Parameters

  • waypointId: string

  Returns Waypoint[]

getNodeUnits

• getNodeUnits(): Record<string, WayFindingNodeToUnitMap[]>

• Returns Record<string, WayFindingNodeToUnitMap[]>

getUnit

• getUnit(id): MapUnit

• Parameters

  • id: string

  Returns MapUnit

getUnitIdFromNodeId

• getUnitIdFromNodeId(nodeId): string

• Parameters

  • nodeId: string

  Returns string

labelWaypoints

• labelWaypoints(options?): void

• Labels waypoints with options.

  Parameters

  • options: WaypointLabelOptions = ...

    Options to use while labeling.

  Returns void

setBuildings

• setBuildings(__namedParameters): void

• Parameters

  • __namedParameters: BuildingState

  Returns void

Static load

• load(vmd, options?): VenueMap

• Loads a vmd file and extracts all necessary data

  Parameters

  • vmd: VenueMapData

  • options: WaypointLabelOptions = ...

  Returns VenueMap

Optional centerPoint