Class MPBuilding

An entity that contains information about a specific building.

Export

Hierarchy

Constructors

constructor

Properties

_floors address administrativeId anchor buildingInfo? defaultFloor externalId geometry id type venueId

Accessors

aliases bounds buildingId floorCount floors initialFloorIndex isPoint name position

Methods

contains getField getFloorByIndex hasFloorIndex toJSON toJson create

Constructors

Private constructor

  • new MPBuilding(id, administrativeId, externalId, venueId, anchor, geometry, _floors, defaultFloor, address, buildingInfo?): MPBuilding
  • 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

Private Readonly _floors

_floors: Map<number, MPFloor>

A map of the floors inside the building.

Readonly address

address: string

The building's address.

Readonly administrativeId

administrativeId: string

The building's readable ID.

Private Readonly anchor

anchor: MPPoint

The anchor point for the building.

Private Optional Readonly buildingInfo

buildingInfo?: default

A collection of information about the building.

Readonly defaultFloor

defaultFloor: number

The default floor index for the building.

Readonly externalId

externalId: string

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

Readonly geometry

geometry: MPPolygon

The geometry of the building.

Private Readonly id

id: string

The building's ID.

Readonly type

type: string

The type of the entity (eg. MPLocation).

Readonly venueId

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): Promise<boolean>

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

    Parameters

    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

toJson

  • toJson(): string

  • Stringifies the entity.

    Returns string

Static create

  • create(object): MPBuilding

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

    Parameters

    Returns MPBuilding

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc