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<AreaCollection["features"][number]>
    • Area

Implements

Properties

id

Accessors

center description externalId floor geoJSON geoJSONBoundingBox images links locationProfiles name

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

Accessors

center

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.

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.

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" }

geoJSONBoundingBox

  • get geoJSONBoundingBox(): {}

  • Gets the bounding box of the geoJSON geometry.

    Returns {}

    The bounding box of the geoJSON geometry

images

  • get images(): ImageData[]

  • Gets the array of Images associated with this map feature.

    Returns ImageData[]

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

links

  • 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.

locationProfiles

name

  • get name(): string

  • Gets the name of the map feature.

    Returns string

    The name of the map feature.

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.

Staticis

  • 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.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR