Class MapData

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

Hierarchy (View Summary, Expand)

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

Properties

Analytics getDirections getDirectionsMultiDestination Query Search

Accessors

mapCenter mapName naturalBearing organizationId outdoorViewToken

Methods

changeLanguage getByExternalId getById getByType getDistance getEnv getGeoJSON off on toJSONBundle

Properties

Analytics

Analytics: Analytics

getDirections

getDirections: (
    from: TNavigationTarget | TNavigationTarget[],
    to: TNavigationTarget | TNavigationTarget[],
    options?: TGetDirectionsOptions,
) => undefined | Directions

Retrieves directions (Directions) from one navigable point (TNavigationTarget) to another on the map.

Type declaration

Example

const directions = await map.getDirections(space1, space2);

getDirectionsMultiDestination

getDirectionsMultiDestination: (
    from: TNavigationTarget,
    to: (TNavigationTarget | TNavigationTarget[])[],
    options?: TGetDirectionsOptions,
) => undefined | Directions[]

Retrieves directions (Directions) from one navigable point (TNavigationTarget) to multiple destination points on the map.

Type declaration

Example

const directions = await map.getDirections(space1, [space2, space3]);

Query

Query: Query

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.

naturalBearing

  • get naturalBearing(): number

  • Retrieves the natural bearing of the map, which is the angle, in degrees, the map is considered to be "naturally oriented" towards. Typically the angle perpendicular to the street the map is facing, or the main entrance. Other print maps inside the map may have this direction be up. 90 degrees means East is "up"

    Returns number

    The natural bearing 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

changeLanguage

  • changeLanguage(localeCode: string): Promise<void>

  • Changes the language of the map data.

    Parameters

    • localeCode: string

      The ISO 639-1 language code to change to (e.g., 'en' for English, 'fr' for French). Check (EnterpriseVenue.languages) for available languages

    Returns Promise<void>

    A promise that resolves when the language change is complete.

    Throws

    An error if the language change fails.

    Example

    try {
      await mapData.changeLanguage('fr');
      console.log('Language changed to French');
    } catch (error) {
      console.error('Failed to change language:', error);
    }

getByExternalId

  • getByExternalId<
        T extends
            | "object"
            | "area"
            | "space"
            | "door"
            | "floor"
            | "floor-stack"
            | "connection"
            | "point-of-interest"
            | "node"
            | "location-profile"
            | "location-category"
            | "enterprise-location"
            | "enterprise-category"
            | "enterprise-venue",
    >(
        type: T,
        externalId: string,
    ): TMapDataObjectTypes[T][]

  • Retrieves an array of map features by their type and shared external ID.

    Type Parameters

    • T extends
          | "object"
          | "area"
          | "space"
          | "door"
          | "floor"
          | "floor-stack"
          | "connection"
          | "point-of-interest"
          | "node"
          | "location-profile"
          | "location-category"
          | "enterprise-location"
          | "enterprise-category"
          | "enterprise-venue"

    Parameters

    • type: T

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

    • externalId: string

      The external ID of the element.

    Returns TMapDataObjectTypes[T][]

    An array of features with the given type and external ID if they exist.

    Example

    const spaces = mapData.getByExternalId('space', 'space-external-id');

getById

  • getById<T extends keyof TMapDataObjectTypes>(
        type: T,
        id: string,
    ): undefined | TMapDataObjectTypes[T]

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

    Type Parameters

    Parameters

    • type: T

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

    • id: string

      The ID of the element.

    Returns undefined | TMapDataObjectTypes[T]

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

    Example

    const space = mapData.getById('space', 'space-id');

getByType

  • getByType(type: string): 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"): Space[]

  • Parameters

    • type: "space"

    Returns Space[]

    The spaces (Space) on the map.

    Example

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

  • Parameters

    • type: "door"

    Returns Door[]

    The doors (Door) on the map.

    Example

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

  • Parameters

    • type: "floor"

    Returns Floor[]

    The floors (Floor) on the map.

    Example

    const floors = mapData.getByType('floor');
  • getByType(type: "floor-stack"): FloorStack[]

  • Parameters

    • type: "floor-stack"

    Returns FloorStack[]

    The stacks of floors (FloorStack) within the map.

    Example

    const floorStacks = mapData.getByType('floor-stack');
  • getByType(type: "facade"): Facade[]

  • Parameters

    • type: "facade"

    Returns Facade[]

    The facades (Facade) within the map.

    Example

    const facades = mapData.getByType('facade');
  • getByType(type: "connection"): Connection[]

  • Parameters

    • type: "connection"

    Returns Connection[]

    The connections (Connection) on the map.

    Example

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

  • Parameters

    • type: "object"

    Returns MapObject[]

    The objects (MapObject) on the map.

    Example

    const objects = mapData.getByType('object');
  • getByType(type: "point-of-interest"): 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"): Annotation[]

  • Parameters

    • type: "annotation"

    Returns Annotation[]

    The annotations (Annotation) on the map.

    Example

    const annotations = mapData.getByType('annotation');
  • getByType(type: "area"): Area[]

  • Parameters

    • type: "area"

    Returns Area[]

    The areas (Area) on the map.

    Example

    const areas = mapData.getByType('area');
  • getByType(type: "node"): Node[]

  • Parameters

    • type: "node"

    Returns Node[]

    The nodes (Node) on the map.

    Example

    const nodes = mapData.getByType('node');
  • getByType(type: "location-profile"): LocationProfile[]

  • Parameters

    • type: "location-profile"

    Returns LocationProfile[]

    The location profiles (LocationProfile) on the map.

    Example

    const locationProfiles = mapData.getByType('location-profile');
  • getByType(type: "location-category"): LocationCategory[]

  • Parameters

    • type: "location-category"

    Returns LocationCategory[]

    The location categories (LocationCategory) on the map.

    Example

    const locationCategories = mapData.getByType('location-category');
  • getByType(type: "enterprise-location"): EnterpriseLocation[]

  • Parameters

    • type: "enterprise-location"

    Returns EnterpriseLocation[]

    The enterprise locations (EnterpriseLocation) on the map.

    Example

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

  • Parameters

    • type: "enterprise-category"

    Returns EnterpriseCategory[]

    The enterprise categories (EnterpriseCategory) on the map.

    Example

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

  • Parameters

    • type: "enterprise-venue"

    Returns undefined | EnterpriseVenue

    The enterprise venue (EnterpriseVenue) on the map.

    Example

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

getDistance

getEnv

  • getEnv(): {
        analyticsBaseUri: string;
        baseAuthUri: string;
        baseUri: string;
        tileServerUri: string;
    }

  • Get the current environment.

    Returns {
        analyticsBaseUri: string;
        baseAuthUri: string;
        baseUri: string;
        tileServerUri: string;
    }

    Example

    const env = mapData.getEnv();
    console.log(env.baseUri); // Get the API URL for the current environment

getGeoJSON

  • getGeoJSON<T extends IGeoJSONData>(mapDataObject: T): T["geoJSON"]

  • Get the GeoJSON for a map data object on the map.

    Type Parameters

    • T extends IGeoJSONData

    Parameters

    • mapDataObject: T

    Returns T["geoJSON"]

off

  • off<EVENT_NAME extends "language-change">(
        eventName: EVENT_NAME,
        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,
    ): 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.

    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 extends "language-change">(
        eventName: EVENT_NAME,
        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,
    ): 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.

    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);

toJSONBundle

  • toJSONBundle(
        __namedParameters?: { downloadLanguagePacks?: boolean },
    ): Promise<THydrateMapDataBundle>

  • Parameters

    • Optional__namedParameters: { downloadLanguagePacks?: boolean }

    Returns Promise<THydrateMapDataBundle>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR