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

Properties

id images links

Accessors

coordinate externalId floor group type

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

images

images: ImageData[]

Gets the array of images associated with this data type.

Returns

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

links

links: Hyperlink[]

Gets the links associated with this data type.

Returns

The links associated with this data type

Accessors

coordinate

externalId

  • get externalId(): string

  • Gets the external ID of the annotation.

    Returns string

    The external ID of the annotation.

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.

group

  • get group(): string

  • Gets the group of the annotation.

    Returns string

    The annotation group.

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;
        };
        group: string;
        id: string;
        type: string;
    }

  • Converts the annotation information to a JSON object.

    Returns {
        coordinate: {
            floor: undefined | string;
            latitude: number;
            longitude: 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