Class Annotation

A class representing annotation data within the map.

Annotations are used to mark specific points or areas on the map with additional information. It includes some details on a map that may be relevant to safety or accessibility (e.g. Fire Extinguishers). Refer to the Annotation Guide for more information.

Hierarchy

  • default<AnnotationCollection["features"][number]>
    • Annotation

Implements

Properties

id

Accessors

coordinate description externalId floor geoJSON geoJSONBoundingBox group images links locationProfiles name type

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

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

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

geoJSONBoundingBox

  • get geoJSONBoundingBox(): {}

  • Gets the bounding box of the geoJSON geometry.

    Returns {}

    The bounding box of the geoJSON geometry

group

  • get group(): string

  • Gets the group of the annotation.

    Returns string

    The annotation group.

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.

type

  • get type(): string

  • Gets the type of the annotation.

    Returns string

    The annotation type.

Methods

toJSON

  • toJSON(): {
        coordinate: {
            floor: undefined
            | string;
            latitude: number;
            longitude: number;
            verticalOffset: number;
        };
        group: string;
        id: string;
        type: string;
    }

  • Converts the annotation information to a JSON object.

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

    An object representing the annotation.

Staticis

  • is(instance: object): instance is Annotation

  • Checks if the provided instance is of type Annotation.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is Annotation

    True if the instance is an Annotation, false otherwise.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR