Class MPBuilding

Readonly address

Readonly administrativeId

Readonly defaultFloor

Readonly externalId

Readonly geometry

Readonly venueId

aliases

• get aliases(): string[]

• Get a list of aliases for the building.

  Returns string[]

bounds

• get bounds(): MPBounds

• Get the building's bounds.

  Returns MPBounds

buildingId

• get buildingId(): string

• Get the building's id.

  Returns string

floorCount

• get floorCount(): number

• Get the number of MPFloors in the building.

  Returns number

floors

• get floors(): MPFloor[]

• Get a list of the floors in the building.

  Returns MPFloor[]

initialFloorIndex

• get initialFloorIndex(): number

• Get the default floor index.

  Returns number

isPoint

• get isPoint(): boolean

• Overload from MPEntity, will return false.

  Returns boolean

name

• get name(): string

• Get the building's name.

  Returns string

position

• get position(): MPPoint

• Get the position of the building, this will correspond to the building's anchor point.

  Returns MPPoint

contains

• contains(point): Promise<boolean>

• Check whether the building's geometry contains the point.

  Parameters

  • point: MPPoint

  Returns Promise<boolean>

  Async

getField

• getField(key?): MPDataField

• Fetch a custom field from the building.

  Parameters

  • Optional key: string

  Returns MPDataField

getFloorByIndex

• getFloorByIndex(floorIndex): MPFloor

• Get a floor by its floor index.

  Parameters

  • floorIndex: number

  Returns MPFloor

hasFloorIndex

• hasFloorIndex(floorIndex): boolean

• Check whether the building contains a floor with the floorIndex.

  Parameters

  • floorIndex: number

  Returns boolean

toJSON

• toJSON(): MPBuildingParams

• Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

  Returns MPBuildingParams

Static create

• create(object): MPBuilding

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

  Parameters

  • object: MPBuildingParams

  Returns MPBuilding

  Static