Class MPLocation

Optional Readonlygeometry

Readonlyid

Readonlyrestrictions

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

• get baseType(): MPLocationType

  Get the location's basetype.

  Returns MPLocationType

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

selectable

• get selectable(): boolean

  Get the location's selectable flag.

  Returns boolean

• set selectable(selectable: boolean): void

  Set the location's selectable flag.

  Parameters

  • selectable: boolean

  Returns void

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

getAdditionalDetail

• getAdditionalDetail(type: MPDetailType): MPAdditionalDetail

  Gets a specific additional detail from the location's additional details

  Parameters

  • type: MPDetailType

    the type of the additional detail to get

  Returns MPAdditionalDetail

  the additional detail of the specified type, or null if it does not exist

getAdditionalDetails

• getAdditionalDetails(): MPAdditionalDetail[]

  Gets the location's additional details, if any

  Returns MPAdditionalDetail[]

  a list of additional details, or null if none were set

getProperty

• getProperty(key: MPLocationPropertyNames): any

  Get a property of the location.

  Parameters

  • key: MPLocationPropertyNames

  Returns any

isBookable

• isBookable(): boolean

  Get whether the location is bookable.

  Returns boolean

Staticcreate

• create(object?: any): MPLocation

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

  Parameters

  • Optionalobject: any

  Returns MPLocation

  Static