Class MPFloor

A MapsIndoors geographical entity. A floor is contained within a MPBuilding.

Export

Hierarchy

Constructors

constructor

Properties

aliases? buildingId? floorIndex? geometry? id name type defaultGroundFloorIndex

Accessors

bounds displayName floorId isPoint position

Methods

toJson create

Constructors

Private constructor

  • Private

    Creates an instance of MPFloor.

    Parameters

    • Optional id: string

      The floor's ID.

    • Optional name: string

      The floor's name.

    • Optional geometry: MPMultiPolygon

      The geometry of the floor.

    • Optional aliases: string[]

      An array of aliases used by the floor.

    • Optional floorIndex: number

      The floor index of the floor.

    • Optional buildingId: string

      The ID of the building this floor lies within.

    Returns MPFloor

Properties

Optional Readonly aliases

aliases?: string[]

An array of aliases used by the floor.

Optional buildingId

buildingId?: string

The ID of the building this floor lies within.

Optional Readonly floorIndex

floorIndex?: number

The floor index of the floor.

Optional Readonly geometry

geometry?: MPMultiPolygon

The geometry of the floor.

Private Readonly id

id: string

The floor's ID.

Private Readonly name

name: string

The floor's name.

Readonly type

type: string

The type of the entity (eg. MPLocation).

Static Readonly defaultGroundFloorIndex

defaultGroundFloorIndex: number = 0

The default floor index is 0, as that is the index of ground floors and any point outside a building.

Static

Accessors

bounds

  • get bounds(): MPBounds

  • Get the floor's bounds.

    Returns MPBounds

displayName

  • get displayName(): string

  • Get the floor's displayName.

    Returns string

floorId

  • get floorId(): string

  • Get the floor's id.

    Returns string

isPoint

  • get isPoint(): boolean

  • Whether the entity's geometry is a point.

    Returns boolean

    Abstract

position

  • get position(): MPPoint

  • Get the floor's position, this is usually the center of the floors geometry.

    Returns MPPoint

Methods

toJson

  • Stringifies the entity.

    Returns string

Static create

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

    Parameters

    Returns MPFloor

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc