Class MPLocation

A MapsIndoors geographical entity. A location can exist anywhere, but it is usually only used inside MPVenues and MPBuildings.

Export

Hierarchy

Constructors

constructor

Properties

bounds? geometry? id properties? restrictions type

Accessors

activeFrom activeTo aliases baseType buildingName categories description externalId floorIndex floorName imageUrl isPoint name position typeName venueName

Methods

getProperty isBookable toJson create

Constructors

Private constructor

  • Private

    Creates an instance of MPLocation.

    Parameters

    • id: string

      The location's ID.

    • restrictions: string[]

      An array of restrictions placed on the location.

    • Optional geometry: MPGeometry

      The geometry of the location.

    • Optional properties: default

      The location's properties.

    Returns MPLocation

Properties

Optional Private bounds

bounds?: MPBounds

The locations bounds

Optional Readonly geometry

geometry?: MPGeometry

The geometry of the location.

Readonly id

id: string

The location's ID.

Private Optional properties

properties?: default

The location's properties.

Readonly restrictions

restrictions: string[]

An array of restrictions placed on the location.

Readonly type

type: string

The type of the entity (eg. MPLocation).

Accessors

activeFrom

  • get activeFrom(): number

  • Get the time location is active from.

    Returns number

activeTo

  • get activeTo(): number

  • Get the time location is active to.

    Returns number

aliases

  • get aliases(): string[]

  • Get the location's aliases.

    Returns string[]

baseType

buildingName

  • get buildingName(): string

  • Get the name of the building the location is in.

    Returns string

categories

  • get categories(): string[]

  • Get the location's categories.

    Returns string[]

description

  • get description(): string

  • Get the location's description.

    Returns string

externalId

  • get externalId(): string

  • Get the location's external identifier.

    Returns string

floorIndex

  • get floorIndex(): number

  • Get the location's floorIndex.

    Returns number

floorName

  • get floorName(): string

  • Get the name of the floor the location is on.

    Returns string

imageUrl

  • get imageUrl(): string

  • Get the URL of the location's icon image.

    Returns string

isPoint

  • get isPoint(): boolean

  • Get whether this location's geometry is a MPPoint.

    Returns boolean

name

  • get name(): string

  • Get the location's name.

    Returns string

position

  • get position(): MPPoint

  • Get the location's position.

    Returns MPPoint

typeName

  • get typeName(): string

  • Get the location's type name.

    Returns string

venueName

  • get venueName(): string

  • Get the name of the venue the location is on.

    Returns string

Methods

getProperty

  • Get a property of the location.

    Parameters

    Returns any

isBookable

  • Get whether the location is bookable.

    Returns boolean

toJson

  • Stringifies the entity.

    Returns string

Static create

  • Creator for MPLocation, used to decode JSON from the MapsIndoors SDK.

    Parameters

    • Optional object: any

    Returns MPLocation

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc