@mapsindoors/react-native-maps-indoors-google-maps
    Preparing search index...

    Class MPBuilding

    An entity that contains information about a specific building.

    MPBuilding

    Hierarchy (View Summary)

    Index

    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

    address: string

    The building's address.

    administrativeId: string

    The building's readable ID.

    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.

    type: string

    The type of the entity (eg. MPLocation).

    venueId: string

    The ID of the venue this building lies within.

    Accessors

    • get aliases(): string[]

      Get a list of aliases for the building.

      Returns string[]

    • get bounds(): MPBounds

      Get the building's bounds.

      Returns MPBounds

    • get buildingId(): string

      Get the building's id.

      Returns string

    • get floorCount(): number

      Get the number of MPFloors in the building.

      Returns number

    • get floors(): MPFloor[]

      Get a list of the floors in the building.

      Returns MPFloor[]

    • get initialFloorIndex(): number

      Get the default floor index.

      Returns number

    • get isPoint(): boolean

      Overload from MPEntity, will return false.

      Returns boolean

    • get name(): string

      Get the building's name.

      Returns string

    • get position(): MPPoint

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

      Returns MPPoint

    Methods

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

      Parameters

      Returns Promise<boolean>

    • Fetch a custom field from the building.

      Parameters

      • Optionalkey: string

      Returns MPDataField

    • Get a floor by its floor index.

      Parameters

      • floorIndex: number

      Returns MPFloor

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

      Parameters

      • floorIndex: number

      Returns boolean

    • Stringifies the entity.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods