Class PointOfInterest

A class representing point of interest data within the map.

Points of interest are used to represent specific points on the map with additional information(e.g. ATMs, Water Fountains).

Hierarchy (View Summary)

DetailedMapData<FeatureCollection<Point, SpaceProperties>["features"][number]>
- PointOfInterest

Implements

Index

Properties

Accessors

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

Methods

toJSON is

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

coordinate

get coordinate(): Coordinate
Gets the Coordinate of the POI.

Returns Coordinate
The POI's 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 POI.

Returns Floor
The floor object.

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

geoJSON

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

Returns { geometry: Point; 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 point of interest.

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

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;
    coordinate: {
        __type: string;
        floorId: string
        | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
}
Serializes the POI data to JSON.

Returns {
    __type: string;
    coordinate: {
        __type: string;
        floorId: string | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
}
An object representing the POI.

`Static`is

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

Class PointOfInterest

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

Readonlyid

Accessors

coordinate

Returns Coordinate

description

Returns string

externalId

Returns string

floor

Returns Floor

Throws

geoJSON

Returns { geometry: Point; 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

name

Returns string

Methods

toJSON

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

Staticis

Parameters

Returns instance is PointOfInterest

Settings

On This Page

`Readonly`id

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

`Static`is