Class Area

An Area represents some grouping of multiple pieces of geometry, not necessarily bounded by walls or any other physical feature of the map.

Areas are currently in a preview state, and may have changes to existing functionality or new features added in the future.

Hierarchy

default
- Area

Implements

IGeoJSONData
IFocusable
IAnchorable

Index

Properties

id images links

Accessors

center description externalId floor geoJSON geoJSONBoundingBox name

Methods

Properties

`Readonly`id

id: string

The identity of the map data.

images

images: ImageData[]

Gets the array of images associated with this data type.

Returns

An array of Image objects, or an empty array if no images exist.

links

links: Hyperlink[]

Gets the links associated with this data type.

Returns

The links associated with this data type

Accessors

center

get center(): Coordinate
Gets the center Coordinate of the area.

Returns Coordinate
The area's center coordinate.

description

get description(): string
Gets the description of the area.

Returns string
The description of the area, or an empty string if no description exists.

externalId

get externalId(): string
Gets the external identifier of the area.

Returns string
The external ID of the area, or an empty string if no external ID exists.

floor

get floor(): Floor
Gets the Floor object associated with the area.

Returns Floor
The floor object.

Throws
Will throw an error if the floor is not found.

geoJSON

get geoJSON(): { geometry: Polygon; properties: null; type: "Feature" }
Gets the underlying GeoJSON Feature representation of this Area.

Returns { geometry: Polygon; properties: null; type: "Feature" }
Implementation of IGeoJSONData.geoJSON
Overrides BaseMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): {}
Gets the bounding box of the geoJSON geometry.

Returns {}
The bounding box of the geoJSON geometry

Inherited from BaseMapData.geoJSONBoundingBox

name

get name(): string
Gets the name of the area.

Returns string
The name of the area.

Methods

toJSON

toJSON(): { floor: string; id: string; name: string }
Serializes the space data to JSON.

Returns { floor: string; id: string; name: string }
An object representing the space.

`Static`is

is(instance: object): instance is Area
Checks if the provided instance is of type Area.
Parameters
- instance: object
  The instance to check.
Returns instance is Area
True if the instance is a Area, false otherwise.