Class MPVenueCollection

Description placeholder.

Export

Hierarchy

default<MPVenue>
- MPVenueCollection

Index

Constructors

Properties

Accessors

Methods

getAll getById getVenueByAdminId create

Constructors

`Private` constructor

new MPVenueCollection(venues): MPVenueCollection
Private
Creates an instance of MPVenueCollection.
Parameters
- venues: MPVenue[]
  
  A collection of venues used in MapsIndoors.
Returns MPVenueCollection
Overrides MPCollection<MPVenue>.constructor
- Defined in src/core/MPVenueCollection.ts:30

Properties

`Private` adminIdMap

adminIdMap: Map<String, MPVenue>

Internal.

Map between administrative ID and venues.

`Protected` map

map: Map<String, MPVenue>

The map the objects are kept in.

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(): MPVenue[]
Gets all objects contained in the collection.

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

getById

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

getVenueByAdminId

getVenueByAdminId(id): MPVenue
Fetch a venue by its administrative id.
Parameters
- id: string
Returns MPVenue
- Defined in src/core/MPVenueCollection.ts:43

`Static` create

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

Static
- Defined in src/core/MPVenueCollection.ts:54

Generated using TypeDoc