Mappedin JS - v6.14.0
    Preparing search index...

    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 (View Summary)

    Implements

    Index

    Properties

    id: string

    The identity of the map data.

    Accessors

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

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

    • get floor(): Floor

      Gets the Floor object associated with the annotation.

      Returns Floor

      The floor object.

      Will throw an error if the floor is not found.

    • get geoJSON(): { geometry: Point; properties: null; type: "Feature" }

      Gets the underlying GeoJSON Feature representation of this Annotation.

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

    • get group(): string

      Gets the group of the annotation.

      Returns string

      The annotation group.

    • get name(): string

      Gets the name of the annotation.

      Returns string

      The annotation's name.

    • get type(): string

      Gets the type of the annotation.

      Returns string

      The annotation type.

    Methods

    • Converts the annotation information to a JSON object.

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

      An object representing the 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.