Class MapData

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

Hierarchy (view full)

  • PubSub<{
        language-change: {
            code: string;
            name: string;
        };
    }>
    • MapData

Properties

Analytics Search

Accessors

mapCenter mapName organizationId outdoorViewToken

Methods

getById getByType off on

Properties

Analytics

Analytics: Analytics

Search

Search: Search

Search API for MapData

Example

// Enable search
const mapData = await getMapData({ search: { enabled: true } });
// or
await mapData.Search.enable();

// Perform a search query
const results = await mapData.Search.query('Coffee Shop');
console.log(results.locations);

// Get search suggestions
const suggestions = await mapData.Search.suggest('Coff');
console.log(suggestions);

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 | FloorStack

  • Parameters

    • type: "floor-stack"
    • id: string

    Returns undefined | FloorStack

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

  • Parameters

    • type: "enterprise-location"
    • id: string

    Returns undefined | EnterpriseLocation

  • getById(type, id): undefined | EnterpriseCategory

  • Parameters

    • type: "enterprise-category"
    • id: string

    Returns undefined | EnterpriseCategory

  • 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): FloorStack[]

  • Parameters

    • type: "floor-stack"

    Returns FloorStack[]

    The stacks of floors (FloorStack) within the map.

    Example

    const floorStacks = mapData.getByType('floor-stack');
  • 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');
  • getByType(type): EnterpriseLocation[]

  • Parameters

    • type: "enterprise-location"

    Returns EnterpriseLocation[]

    The enterprise locations (EnterpriseLocation) on the map.

    Example

    const enterpriseLocations = mapData.getByType('enterprise-location');
  • getByType(type): EnterpriseCategory[]

  • Parameters

    • type: "enterprise-category"

    Returns EnterpriseCategory[]

    The enterprise categories (EnterpriseCategory) on the map.

    Example

    const enterpriseCategories = mapData.getByType('enterprise-category');
  • getByType(type): EnterpriseVenue

  • Parameters

    • type: "enterprise-venue"

    Returns EnterpriseVenue

    The enterprise venue (EnterpriseVenue) on the map.

    Example

    const enterpriseVenue = mapData.getByType('enterprise-venue');

off

  • off<EVENT_NAME>(eventName, fn): void

  • Unsubscribe a function previously subscribed with on

    Type Parameters

    • EVENT_NAME extends "language-change"

    Parameters

    • eventName: EVENT_NAME

      An event name to which the provided function was previously subscribed.

    • fn: ((payload: {
              language-change: {
                  code: string;
                  name: string;
              };
          }[EVENT_NAME] extends {
              data: null;
          }
          ? any[any]["data"]
          : {
              language-change: {
                  code: string;
                  name: string;
              };
          }[EVENT_NAME]) => void)

      A function that was previously passed to on. The function must have the same reference as the function that was subscribed.

        • (payload): void

        • Parameters

          • payload: {
                    language-change: {
                        code: string;
                        name: string;
                    };
                }[EVENT_NAME] extends {
                    data: null;
                }
                ? any[any]["data"]
                : {
                    language-change: {
                        code: string;
                        name: string;
                    };
                }[EVENT_NAME]

          Returns void

    Returns void

    Example

    // Unsubscribe from the 'click' event
    const handler = (event) => {
    	console.log('Map was clicked', event);
    };
    map.off('click', handler);

on

  • on<EVENT_NAME>(eventName, fn): void

  • Subscribe a function to an event.

    Type Parameters

    • EVENT_NAME extends "language-change"

    Parameters

    • eventName: EVENT_NAME

      An event name which, when fired, will call the provided function.

    • fn: ((payload: {
              language-change: {
                  code: string;
                  name: string;
              };
          }[EVENT_NAME] extends {
              data: null;
          }
          ? any[any]["data"]
          : {
              language-change: {
                  code: string;
                  name: string;
              };
          }[EVENT_NAME]) => void)

      A callback that gets called when the corresponding event is fired. The callback will get passed an argument with a type that's one of event payloads.

        • (payload): void

        • Parameters

          • payload: {
                    language-change: {
                        code: string;
                        name: string;
                    };
                }[EVENT_NAME] extends {
                    data: null;
                }
                ? any[any]["data"]
                : {
                    language-change: {
                        code: string;
                        name: string;
                    };
                }[EVENT_NAME]

          Returns void

    Returns void

    Example

    // Subscribe to the 'click' event
    const handler = (event) => {
     const { coordinate } = event;
     const { latitude, longitude } = coordinate;
    	console.log(`Map was clicked at ${latitude}, ${longitude}`);
    };
    map.on('click', handler);

Settings

Member Visibility

On This Page

AnalyticsSearchmapCentermapNameorganizationIdoutdoorViewTokengetByIdgetByTypeoffon