Class MPCategoryCollection

A simple collection holder for categories.

Export

Hierarchy

default<MPCategory>
- MPCategoryCollection

Index

Constructors

Properties

Accessors

Methods

getAll getById getFields getValue create

Constructors

`Private` constructor

new MPCategoryCollection(category): MPCategoryCollection
Private
Creates an instance of MPCategoryCollection.
Parameters
- category: MPCategory[]
  
  A collection of categories used in MapsIndoors.
Returns MPCategoryCollection
Overrides MPCollection<MPCategory>.constructor
- Defined in src/core/MPCategoryCollection.ts:21

Properties

`Protected` map

map: Map<String, MPCategory>

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

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

getById

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

getFields

getFields(key): Map<string, MPDataField>
Get a category's fields directly.
Parameters
- key: string
Returns Map<string, MPDataField>
- Defined in src/core/MPCategoryCollection.ts:45

getValue

getValue(key): string
Get a category's value directly.
Parameters
- key: string
Returns string
- Defined in src/core/MPCategoryCollection.ts:33

`Static` create

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

Static
- Defined in src/core/MPCategoryCollection.ts:58

Generated using TypeDoc