Class Space

A Space represents an area enclosed by walls, such as a hall or room. Spaces can be Interactive and have Labels and Markers added to them. Spaces can also be customized with a color, texture and hover color.

Refer to the Spaces Guide for more information and interactive examples.

Hierarchy (View Summary)

DetailedMapData<SpaceFeature>
- Space

Implements

Index

Properties

Accessors

center description doors enterpriseLocations externalId floor geoJSON geoJSONBoundingBox icon images images3D links locationProfiles locations name type

Methods

toJSON is

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

center

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

Returns Coordinate
The space'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

doors

get doors(): Door[]
Gets the array of Doors associated with the space.

Returns Door[]
The doors array.

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.

enterpriseLocations

get enterpriseLocations(): EnterpriseLocation[]
Gets the EnterpriseLocations attached to this space.

Returns EnterpriseLocation[]
An array of enterprise locations.

Remarks
Data Source: Enterprise - This property is only populated when using CMS/Enterprise credentials (clientId/clientSecret or API keys that do NOT start with mik_). Returns an empty array when using Maker credentials. For Maker data, access locations via LocationProfile.spaces instead.

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

Returns Floor
The floor object.

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

geoJSON

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

Returns { geometry: Point | LineString | 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 space.

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

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

locations

get locations(): EnterpriseLocation[]
Gets the EnterpriseLocations attached to this space.

Returns EnterpriseLocation[]
An array of enterprise locations.

Deprecated
Use enterpriseLocations instead. This property will be removed in a future release.

Remarks
Data Source: Enterprise - This property is only populated when using CMS/Enterprise credentials.

name

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

Returns string
The name of the map feature.

Inherited from DetailedMapData.name

type

get type(): TSpaceType
Gets the type/kind of the space.

Returns TSpaceType
The type of the space.

Methods

toJSON

toJSON(): {
    __type: string;
    center: {
        __type: string;
        floorId: string
        | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
    type: TSpaceType;
}
Serializes the space data to JSON.

Returns {
    __type: string;
    center: {
        __type: string;
        floorId: string | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
    type: TSpaceType;
}
An object representing the space.

`Static`is

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

Class Space

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

Readonlyid

Accessors

center

Returns Coordinate

description

Returns string

doors

Returns Door[]

Remarks

enterpriseLocations

Returns EnterpriseLocation[]

Remarks

externalId

Returns string

floor

Returns Floor

Throws

geoJSON

Returns { geometry: Point | LineString | Polygon; properties: null; type: "Feature" }

geoJSONBoundingBox

Returns BBox | undefined

icon

Returns ImageMetaData | undefined

images

Returns ImageMetaData[]

images3D

Returns Image3DView[]

links

Returns Hyperlink[]

locationProfiles

Returns LocationProfile[]

Remarks

locations

Returns EnterpriseLocation[]

Deprecated

Remarks

name

Returns string

type

Returns TSpaceType

Methods

toJSON

Returns { __type: string; center: { __type: string; floorId: string | undefined; latitude: number; longitude: number; verticalOffset: number; }; floor: string; id: string; name: string; type: TSpaceType;}

Staticis

Parameters

Returns instance is Space

Settings

On This Page

`Readonly`id

Returns {
type: string;
center: {
type: string;
floorId: string | undefined;
latitude: number;
longitude: number;
verticalOffset: number;
};
floor: string;
id: string;
name: string;
type: TSpaceType;
}

`Static`is