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 (View Summary)

DetailedMapData<AreaCollection["features"][number]>
- Area

Implements

Index

Properties

Accessors

center description externalId floor geoJSON geoJSONBoundingBox icon images images3D links locationProfiles name

Methods

Properties

`Readonly`id

id: string

The identity of the map data.

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 map feature.

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

Inherited from DetailedMapData.description

externalId

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

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

Inherited from DetailedMapData.externalId

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 DetailedMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): BBox | undefined
Gets the bounding box of the geoJSON geometry.

Returns BBox | undefined
The bounding box of the geoJSON geometry

Inherited from DetailedMapData.geoJSONBoundingBox

icon

get icon(): ImageMetaData | undefined
Gets the URL of the icon for the map feature.

Returns ImageMetaData | undefined
The icon of the map feature.

Inherited from DetailedMapData.icon

images

get images(): ImageMetaData[]
Gets the array of ImageMetaDatas associated with this map feature.

Returns ImageMetaData[]
An array of Image objects, or an empty array if no images exist.

Inherited from DetailedMapData.images

images3D

get images3D(): Image3DView[]
Gets the 3D images anchored to this area.

Returns Image3DView[]
An array of Image3DView objects representing 3D images attached to this area.

links

get links(): Hyperlink[]
Gets the array of Hyperlinks associated with this map feature.

Returns Hyperlink[]
An array of Hyperlink objects, or an empty array if no links exist.

Inherited from DetailedMapData.links

locationProfiles

get locationProfiles(): LocationProfile[]
Gets the LocationProfiles attached to this feature.

Returns LocationProfile[]
An array of location profiles.

Remarks
Data Source: Maker - This property is only populated when using Maker credentials (API keys starting with mik_). Returns an empty array when using CMS/Enterprise credentials. For Enterprise data, use Space.enterpriseLocations or MapObject.enterpriseLocations instead.

Inherited from DetailedMapData.locationProfiles

name

get name(): string
Gets the name of the map feature.

Returns string
The name of the map feature.

Inherited from DetailedMapData.name

Methods

toJSON

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

Returns { __type: string; 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.