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

Properties

id

Accessors

coordinate description externalId floor geoJSON geoJSONBoundingBox icon images links locationProfiles name

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

Accessors

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.

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

geoJSONBoundingBox

  • get geoJSONBoundingBox(): undefined | BBox

    Gets the bounding box of the geoJSON geometry.

    Returns undefined | BBox

    The bounding box of the geoJSON geometry

icon

  • get icon(): undefined | ImageMetaData

    Gets the URL of the icon for the map feature.

    Returns undefined | ImageMetaData

    The icon of the map feature.

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.

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(): {
        __type: string;
        coordinate: {
            __type: string;
            floorId: undefined
            | string;
            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: undefined | string;
            latitude: number;
            longitude: number;
            verticalOffset: number;
        };
        floor: string;
        id: string;
        name: string;
    }

    An object representing the POI.

Staticis

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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods