An entity that contains information about a specific building.

Export

Hierarchy

Constructors

  • Private

    Creates an instance of MPBuilding.

    Parameters

    • id: string

      The building's ID.

    • administrativeId: string

      The building's readable ID.

    • externalId: string

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

    • venueId: string

      The ID of the venue this building lies within.

    • anchor: MPPoint

      The anchor point for the building.

    • geometry: MPPolygon

      The geometry of the building.

    • _floors: Map<number, MPFloor>

      A map of the floors inside the building.

    • defaultFloor: number

      The default floor index for the building.

    • address: string

      The building's address.

    • Optional buildingInfo: default

      A collection of information about the building.

    Returns MPBuilding

Properties

_floors: Map<number, MPFloor>

A map of the floors inside the building.

address: string

The building's address.

administrativeId: string

The building's readable ID.

anchor: MPPoint

The anchor point for the building.

buildingInfo?: default

A collection of information about the building.

defaultFloor: number

The default floor index for the building.

externalId: string

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

geometry: MPPolygon

The geometry of the building.

id: string

The building's ID.

type: string

The type of the entity (eg. MPLocation).

venueId: string

The ID of the venue this building lies within.

Accessors

  • get isPoint(): boolean
  • Overload from MPEntity, will return false.

    Returns boolean

Methods

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

    Parameters

    Returns Promise<boolean>

    Async

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

    Parameters

    • floorIndex: number

    Returns boolean

Generated using TypeDoc