Class MappedinMapGroup

A MappedinMapGroup is a collection of maps, usually representing the different floors of a single building. All Maps will be in a MapGroup, but if your Venue is only a single building (like a mall) you can likely ignore MapGroups entirely.

Hierarchy

MappedinMapGroup

Index

Constructors

Properties

__type id name __type

Accessors

Methods

toJSON fetch hydrate is updateInPlace

Constructors

constructor

new MappedinMapGroup(mappedin, data): MappedinMapGroup
Parameters
- mappedin: Mappedin
- data: any
Returns MappedinMapGroup

Properties

`Readonly` __type

__type: "MappedinMapGroup" = "MappedinMapGroup"

id

id: string

name

name: string

`Static` `Readonly` __type

__type: "MappedinMapGroup" = "MappedinMapGroup"

Accessors

maps

get maps(): MappedinMap[]
Maps within this MapGroup.

Returns MappedinMap[]

Methods

toJSON

toJSON(): any
Returns any

`Static` fetch

fetch(mappedin): Promise<MappedinMapGroup[]>
Parameters
- mappedin: Mappedin
Returns Promise<MappedinMapGroup[]>

`Static` hydrate

hydrate(mapGroups, mappedin): MappedinMapGroup[]
Parameters
- mapGroups: any
- mappedin: Mappedin
Returns MappedinMapGroup[]

`Static` is

is(instance): instance is MappedinMapGroup
Parameters
- instance: object
Returns instance is MappedinMapGroup

`Static` updateInPlace

updateInPlace(mappedin, hydrateData?): Promise<void>
Parameters
- mappedin: Mappedin
- Optional hydrateData: any
Returns Promise<void>