Class MapObject

A class representing generic map object data within the map.

It could represent various objects on the map, such as desks, chairs, etc.

MapObject appearance can be customized by changing the color or adding a texture to its top or sides. Refer to the Textures & Colors Guide for more information and interactive examples.

Hierarchy

  • default
    • MapObject

Properties

id: string

The identity of the map data.

images: ImageData[]

Gets the array of images associated with this data type.

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

links: Hyperlink[]

Gets the links associated with this data type.

The links associated with this data type

Accessors

  • get description(): string
  • Gets the description of the MapObject.

    Returns string

    The description of the object.

  • get externalId(): string
  • Gets the external ID of the MapObject.

    Returns string

    The external ID of the object.

  • get floor(): Floor
  • Gets the Floor associated with the MapObject.

    Returns Floor

    The floor object.

    Will throw an error if the floor is not found.

  • get name(): string
  • Gets the name of the MapObject.

    Returns string

    The name of the object.

  • get type(): string
  • Gets the type of the MapObject.

    Returns string

    The kind of the object.

Methods

  • Serializes the MapObject data to JSON.

    Returns {
        center: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        };
        floor: string;
        id: string;
        name: string;
        type: string;
    }

    An object representing the MapObject.

  • Checks if the provided instance is of type MapObject.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is MapObject

    True if the instance is a MapObject, false otherwise.