Class BaseMapBuildingFloorAbstract

constructor

• new BaseMapBuildingFloor(id, name, building): BaseMapBuildingFloor

• Initializer used if there is a name for the floor.

  Parameters

  • id: string

    ID of the floor.

  • name: string

    name of the floor.

  • building: BaseMapBuilding

  Returns BaseMapBuildingFloor

addEdge

• addEdge(nodeOneId, nodeTwoId): void

• Adds an edge that connects two waypoints.

  Parameters

  • nodeOneId: string

    ID of first waypoint.

  • nodeTwoId: string

    ID of second waypoint.

  Returns void

addMapUnit

• addMapUnit(mapUnit): void

• Parameters

  • mapUnit: MapUnit

  Returns void

  Since

  1.1

addWaypoint

• addWaypoint(wp): void

• Adds a waypoint to the floor.

  Parameters

  • wp: Waypoint

    Waypoint to add.

  Returns void

findClosestWaypoint

• findClosestWaypoint(location): Waypoint

• Parameters

  • location: LatLng

  Returns Waypoint

  Since

  1.1

getClassName

• getClassName(): string

• Returns string

getCoordinates

• getCoordinates(): LatLng[][]

• Returns LatLng[][]

  the coordinates that make up the perimiter of this floor

  Since

  1.1

getEdgeCollection

• getEdgeCollection(): EdgeCollection

• Returns EdgeCollection

  All of the edgeCollection on the floor excluding those connected to stairs/elevators.

  Since

  1.1

getEdges

• getEdges(): Edge[]

• Returns Edge[]

  All of the edges on the floor excluding those connected to stairs/elevators.

getElevatorEdgeCollection

• getElevatorEdgeCollection(): EdgeCollection

• This will be used to dynamically add/remove elevators from the Dijkstra graph.

  Returns EdgeCollection

  Edges on the floor that consist of at least one elevator waypoint.

  Since

  1.1

getElevatorEdges

• getElevatorEdges(): Edge[]

• This will be used to dynamically add/remove elevators from the Dijkstra graph.

  Returns Edge[]

  Edges on the floor that consist of at least one elevator waypoint.

getExitEdgeCollection

• getExitEdgeCollection(): EdgeCollection

• This will be used to dynamically add/remove exits from the Dijkstra graph.

  Returns EdgeCollection

  Edges on the floor that consist of at least 1 exit waypoint.

  Since

  1.1

getExitEdges

• getExitEdges(): Edge[]

• This will be used to dynamically add/remove exits from the Dijkstra graph.

  Returns Edge[]

  Edges on the floor that consist of at least 1 exit waypoint.

getFeatureId

• getFeatureId(): string

• Returns string

getFloorNumber

• getFloorNumber(): number

• Returns number

  the floor ordinal

  Deprecated

  since 1.2, use getOrdinal instead

getGeojsonCoordinates

• getGeojsonCoordinates(): number[]

• Returns number[]

  Since

  1.2.1

getGeometryType

• getGeometryType(): string

• Returns string

  Since

  1.2.1

getId

• getId(): string

• Returns string

  Unique identifier for this floor.

getLegacyId

• getLegacyId(): string

• Returns string

  the legacy id associated with this floor

  Since

  1.2

getMapBuilding

• getMapBuilding(): BaseMapBuilding

• Returns BaseMapBuilding

  the building that contains this floor

  Since

  1.1

getMapUnit

• getMapUnit(mapUnitId): MapUnit

• Parameters

  • mapUnitId: string

  Returns MapUnit

  Since

  1.1

getMapUnits

• getMapUnits(): MapUnit[]

• Helper getter to return just the values of the map since that is typically all that is needed.

  Returns MapUnit[]

  A collection of map units.

  Since

  1.1

getMapUnitsMap

• getMapUnitsMap(): Record<string, MapUnit>

• Returns Record<string, MapUnit>

  A map of the map units.

  Since

  1.1

getName

• getName(): string

• Returns string

  the name of the floor

getOrdinal

• getOrdinal(): number

• Identifies the floor's ordinal value. An ordinal value of 0 is ground level. Negative values are below ground and positive numbers are above ground.

  Returns number

  the floor ordinal

  Since

  1.2

getPlaceId

• getPlaceId(): string

• Returns string

getStairEdgeCollection

• getStairEdgeCollection(): EdgeCollection

• This will be used to dynamically add/remove stairs from the Dijkstra graph.

  Returns EdgeCollection

  Edges on the floor that consist of at least 1 stair waypoint.

  Since

  1.1

getStairEdges

• getStairEdges(): Edge[]

• This will be used to dynamically add/remove stairs from the Dijkstra graph.

  Returns Edge[]

  Edges on the floor that consist of at least 1 stair waypoint.

getWaypointWithId

• getWaypointWithId(nodeId): Waypoint

• Finds a waypoint with a given ID.

  Parameters

  • nodeId: string

    ID of waypoint to find.

  Returns Waypoint

  Waypoint that is found or null if not found.

getWaypoints

• getWaypoints(): Waypoint[]

• Returns Waypoint[]

  waypoints that are on this floor.

getWaypointsMap

• getWaypointsMap(): Record<string, Waypoint>

• Returns Record<string, Waypoint>

  Map of waypoints on this floor where the keys are the waypoint's uid

  Since

  1.1

removeUnit

• removeUnit(unitId): void

• Parameters

  • unitId: string

  Returns void

setClassName

• setClassName(value): BaseMapBuildingFloor

• Parameters

  • value: string

  Returns BaseMapBuildingFloor

setCoordinates

• setCoordinates(coordinates): void

• Set coordinates that make up the perimeter of this floor

  Parameters

  • coordinates: LatLng[][]

  Returns void

  Since

  1.1

setFeatureId

• setFeatureId(value): BaseMapBuildingFloor

• Parameters

  • value: string

  Returns BaseMapBuildingFloor

setGeojsonCoordinates

• setGeojsonCoordinates(geojsonCoordinates): BaseMapBuildingFloor

• Parameters

  • geojsonCoordinates: any[]

  Returns BaseMapBuildingFloor

  Since

  1.2.1

setGeometryType

• setGeometryType(geometryType): BaseMapBuildingFloor

• Parameters

  • geometryType: string

  Returns BaseMapBuildingFloor

  Since

  1.2.1

setId

• setId(id): void

• Parameters

  • id: string

    the new unique identifier for this floor.

  Returns void

setLegacyId

• setLegacyId(legacyId): void

• Parameters

  • legacyId: string

    set the legacy Id associated with this floor

  Returns void

  Since

  1.2

setMapBuilding

• setMapBuilding(mapBuilding): void

• Parameters

  • mapBuilding: BaseMapBuilding

  Returns void

  Since

  1.1

setName

• setName(name): void

• Parameters

  • name: string

    the new name of the floor

  Returns void

setOrdinal

• setOrdinal(ordinal): void

• Parameters

  • ordinal: number

    the new floor ordinal

  Returns void

  Since

  1.2

setPlaceId

• setPlaceId(value): BaseMapBuildingFloor

• Parameters

  • value: string

  Returns BaseMapBuildingFloor

setWaypoints

• setWaypoints(waypoints): void

• Parameters

  • waypoints: Waypoint[]

    new waypoints that are on this floor.

  Returns void

setWaypointsMap

• setWaypointsMap(waypointsMap): void

• Set map of waypoints

  Parameters

  • waypointsMap: Record<string, Waypoint>

    a map of the waypoints on this floor, keyed by the floor uid

  Returns void

  Since

  1.1

toString

• toString(): string

• Returns string

  A string represenation of this floor

Static extractFloorNumberFromID

• extractFloorNumberFromID(id): number

• Parameters

  • id: string

  Returns number

id

Optional legacyId

mapBuilding

name

ordinal

waypoints

waypointsMap