Class MPBuildingCollection

A simple collection holder for buildings.

Export

Hierarchy

default<MPBuilding>
- MPBuildingCollection

Index

Constructors

Properties

Accessors

Methods

getAll getBuildingByAdminId getById create

Constructors

`Private` constructor

new MPBuildingCollection(buildings): MPBuildingCollection
Private
Creates an instance of MPBuildingCollection.
Parameters
- buildings: MPBuilding[]
  
  A collection of buildings used in MapsIndoors.
Returns MPBuildingCollection
Overrides MPCollection<MPBuilding>.constructor
- Defined in src/core/MPBuildingCollection.ts:28

Properties

`Protected` map

map: Map<String, MPBuilding>

The map the objects are kept in.

`Private` nameMap

nameMap: Map<String, MPBuilding>

A custom map of buildings by their names.

Accessors

size

get size(): number
The number of objects in the collection.

Returns number
Inherited from MPCollection.size
- Defined in src/core/MPCollection.ts:56

Methods

getAll

getAll(): MPBuilding[]
Gets all objects contained in the collection.

Returns MPBuilding[]
Inherited from MPCollection.getAll
- Defined in src/core/MPCollection.ts:34

getBuildingByAdminId

getBuildingByAdminId(id): MPBuilding
Get a building by its administrativeId.
Parameters
- id: string
Returns MPBuilding
- Defined in src/core/MPBuildingCollection.ts:41

getById

getById(id): MPBuilding
Get a object by its identifier.
Parameters
- id: string
Returns MPBuilding
Inherited from MPCollection.getById
- Defined in src/core/MPCollection.ts:45

`Static` create

create(object?): MPBuildingCollection
Creator for MPBuildingCollection, used to decode JSON from the MapsIndoors SDK.
Parameters
- Optional object: any
Returns MPBuildingCollection

Static
- Defined in src/core/MPBuildingCollection.ts:53

Generated using TypeDoc