Class MPBuilding

An entity that contains information about a specific building.

Export

MPBuilding

Hierarchy (View Summary)

Properties

address administrativeId defaultFloor externalId geometry type venueId

Accessors

aliases bounds buildingId floorCount floors initialFloorIndex isPoint name position

Methods

contains getField getFloorByIndex hasFloorIndex toJson toJSON create

Properties

Readonlyaddress

address: string

The building's address.

ReadonlyadministrativeId

administrativeId: string

The building's readable ID.

ReadonlydefaultFloor

defaultFloor: number

The default floor index for the building.

ReadonlyexternalId

externalId: string

An ID used to map the building to a customer's ID.

Readonlygeometry

geometry: MPPolygon

The geometry of the building.

Readonlytype

type: string

The type of the entity (eg. MPLocation).

ReadonlyvenueId

venueId: string

The ID of the venue this building lies within.

Accessors

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

Methods

contains

  • contains(point: MPPoint): Promise<boolean>

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

    Parameters

    Returns Promise<boolean>

    Async

getField

  • getField(key?: string): MPDataField

  • Fetch a custom field from the building.

    Parameters

    • Optionalkey: string

    Returns MPDataField

getFloorByIndex

  • getFloorByIndex(floorIndex: number): MPFloor

  • Get a floor by its floor index.

    Parameters

    • floorIndex: number

    Returns MPFloor

hasFloorIndex

  • hasFloorIndex(floorIndex: number): boolean

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

    Parameters

    • floorIndex: number

    Returns boolean

toJson

  • toJson(): string

  • Stringifies the entity.

    Returns string

toJSON

Staticcreate

Settings

Member Visibility

On This Page

Properties
Accessors
Methods