Class MPFloor

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

Export

MPFloor

Hierarchy (View Summary)

Properties

aliases? buildingId? floorIndex? geometry? type defaultGroundFloorIndex

Accessors

bounds displayName floorId isPoint position

Methods

toJson create

Properties

Optional Readonlyaliases

aliases?: string[]

An array of aliases used by the floor.

OptionalbuildingId

buildingId?: string

The ID of the building this floor lies within.

Optional ReadonlyfloorIndex

floorIndex?: number

The floor index of the floor.

Optional Readonlygeometry

geometry?: MPMultiPolygon

The geometry of the floor.

Readonlytype

type: string

The type of the entity (eg. MPLocation).

Static ReadonlydefaultGroundFloorIndex

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

AbstractisPoint

  • get isPoint(): boolean

    Whether the entity's geometry is a point.

    Returns boolean

position

  • get position(): MPPoint

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

    Returns MPPoint

Methods

toJson

  • toJson(): string

    Stringifies the entity.

    Returns string

Staticcreate

Settings

Member Visibility

On This Page

Properties
Accessors
Methods