Class MapData

Represents the data for a map, providing access to map elements like spaces, floors, and points of interest.

Accessors

mapCenter mapName organizationId outdoorViewToken

Methods

getById getByType

Accessors

mapCenter

mapName

  • get mapName(): string

  • The name of the map.

    Returns string

    The name of the map.

organizationId

  • get organizationId(): string

  • The organization ID of the map.

    Returns string

    The organization ID of the map.

outdoorViewToken

  • get outdoorViewToken(): undefined | string

  • The token is used to fetch outdoor tiles.

    Returns undefined | string

    The outdoor view token.

Methods

getById

  • getById(type, id): undefined | Space

  • Retrieves a specific map feature by its type and ID.

    Parameters

    • type: "space"

      The type of the element to retrieve (e.g., 'space', 'object').

    • id: string

      The ID of the element.

    Returns undefined | Space

    The feature with the given type and ID, or undefined if it does not exist.

    Example

    const space = mapData.getById('space', 'space-id');
  • getById(type, id): undefined | Door

  • Parameters

    • type: "door"
    • id: string

    Returns undefined | Door

  • getById(type, id): undefined | Floor

  • Parameters

    • type: "floor"
    • id: string

    Returns undefined | Floor

  • getById(type, id): undefined | Connection

  • Parameters

    • type: "connection"
    • id: string

    Returns undefined | Connection

  • getById(type, id): undefined | MapObject

  • Parameters

    • type: "object"
    • id: string

    Returns undefined | MapObject

  • getById(type, id): undefined | PointOfInterest

  • Parameters

    • type: "point-of-interest"
    • id: string

    Returns undefined | PointOfInterest

  • getById(type, id): undefined | Annotation

  • Parameters

    • type: "annotation"
    • id: string

    Returns undefined | Annotation

  • getById(type, id): undefined | object

  • Parameters

    • type: string
    • id: string

    Returns undefined | object

getByType

  • getByType(type): object[]

  • Retrieves all map elements of a specific type.

    Parameters

    • type: string

      The type of elements to retrieve (e.g., 'space', 'object').

    Returns object[]

    An array of elements of the given type.

    Example

    const spaces = mapData.getByType('space');
  • getByType(type): Space[]

  • Parameters

    • type: "space"

    Returns Space[]

    The spaces (Space) on the map.

    Example

    const spaces = mapData.getByType('space');
  • getByType(type): Door[]

  • Parameters

    • type: "door"

    Returns Door[]

    The doors (Door) on the map.

    Example

    const doors = mapData.getByType('door');
  • getByType(type): Floor[]

  • Parameters

    • type: "floor"

    Returns Floor[]

    The floors (Floor) on the map.

    Example

    const floors = mapData.getByType('floor');
  • getByType(type): Connection[]

  • Parameters

    • type: "connection"

    Returns Connection[]

    The connections (Connection) on the map.

    Example

    const connections = mapData.getByType('connection');
  • getByType(type): MapObject[]

  • Parameters

    • type: "object"

    Returns MapObject[]

    The objects (MapObject) on the map.

    Example

    const objects = mapData.getByType('object');
  • getByType(type): PointOfInterest[]

  • Parameters

    • type: "point-of-interest"

    Returns PointOfInterest[]

    The points of interest (PointOfInterest) on the map.

    Example

    const pointsOfInterest = mapData.getByType('point-of-interest');
  • getByType(type): Annotation[]

  • Parameters

    • type: "annotation"

    Returns Annotation[]

    The annotations (Annotation) on the map.

    Example

    const annotations = mapData.getByType('annotation');

Settings

Member Visibility

On This Page

mapCentermapNameorganizationIdoutdoorViewTokengetByIdgetByType