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

Index

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

get mapCenter(): Coordinate
The approximate center coordinate (Coordinate) of the map.

Returns Coordinate
The center coordinate of the map.

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

changeLanguage

changeLanguage(localeCode): 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);
}
```

getById

getById<T>(type, id): T extends "node"
    ? undefined | Node
    : T extends "space"
        ? undefined | Space
        : T extends "door"
            ? undefined | Door
            : T extends "floor"
                ? undefined | Floor
                : T extends "floor-stack"
                    ? undefined | FloorStack
                    : T extends "connection"
                        ? undefined | Connection
                        : T extends "object"
                            ? undefined | MapObject
                            : T extends "point-of-interest"
                                ? undefined | PointOfInterest
                                : T extends "annotation"
                                    ? undefined | Annotation
                                    : T extends "enterprise-location"
                                        ? (...) | (...)
                                        : (...) extends (...)
                                            ? (...)
                                            : (...)
Retrieves a specific map feature by its type and ID.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the element to retrieve (e.g., 'space', 'object').
- id: string
  The ID of the element.
Returns T extends "node"
    ? undefined | Node
    : T extends "space"
        ? undefined | Space
        : T extends "door"
            ? undefined | Door
            : T extends "floor"
                ? undefined | Floor
                : T extends "floor-stack"
                    ? undefined | FloorStack
                    : T extends "connection"
                        ? undefined | Connection
                        : T extends "object"
                            ? undefined | MapObject
                            : T extends "point-of-interest"
                                ? undefined | PointOfInterest
                                : T extends "annotation"
                                    ? undefined | Annotation
                                    : T extends "enterprise-location"
                                        ? (...) | (...)
                                        : (...) extends (...)
                                            ? (...)
                                            : (...)
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 | 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): Node[]
Parameters
- type: "node"
Returns Node[]
The nodes (Node) on the map.
Example
```
const nodes = mapData.getByType('node');
```
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): undefined | EnterpriseVenue
Parameters
- type: "enterprise-venue"
Returns undefined | EnterpriseVenue
The enterprise venue (EnterpriseVenue) on the map.
Example
```
const enterpriseVenue = mapData.getByType('enterprise-venue');
```

getDirections

getDirections(from, to, options?): undefined | Directions
Retrieves directions (Directions) from one navigable point (TNavigationTarget) to another on the map.
Parameters
- from: TNavigationTarget | TNavigationTarget[]
  The starting point for navigation.
- to: TNavigationTarget | TNavigationTarget[]
  The destination point.
- Optionaloptions: TGetDirectionsOptions
  Optional parameters for getting directions.
Returns undefined | Directions
Directions from the start to the destination point.
Example
```
const directions = await map.getDirections(space1, space2);
```

getDirectionsMultiDestination

getDirectionsMultiDestination(from, to, options?): undefined | Directions[]
Retrieves directions (Directions) from one navigable point (TNavigationTarget) to multiple destination points on the map.
Parameters
- from: TNavigationTarget
  The starting point for navigation.
- to: (TNavigationTarget | TNavigationTarget[])[]
  The destination points.
- Optionaloptions: TGetDirectionsOptions
  Optional parameters for getting directions.
Returns undefined | Directions[]
Directions from the start to the destination points.
Example
```
const directions = await map.getDirections(space1, [space2, space3]);
```

getDistance

getDistance(from, to): number
Retrieves the distance between two navigable points (TNavigationTarget) on the map.
Parameters
- from:
      | Coordinate
      | Space
      | MapObject
      | Door
      | Annotation
      | PointOfInterest
      | Node
      | EnterpriseLocation
  The starting point.
- to:
      | Coordinate
      | Space
      | MapObject
      | Door
      | Annotation
      | PointOfInterest
      | Node
      | EnterpriseLocation
  The destination point.
Returns number
The distance between the start and destination points in meters.

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);
```
Inherited from PubSub.off

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);
```
Inherited from PubSub.on

toJSONBundle

toJSONBundle(__namedParameters?): Promise<THydrateMapDataBundle>
Parameters
- __namedParameters: {
  downloadLanguagePacks?: boolean;
  } = {}
  - OptionaldownloadLanguagePacks?: boolean
Returns Promise<THydrateMapDataBundle>

Class MapData

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

Analytics

Search

Example

Accessors

mapCenter

Returns Coordinate

mapName

Returns string

organizationId

Returns string

outdoorViewToken

Returns undefined | string

Methods

changeLanguage

Parameters

Returns Promise<void>

Throws

Example

getById

Type Parameters

Parameters

Example

Parameters

Returns undefined | object

getByType

Parameters

Returns object[]

Example

Parameters

Returns Space[]

Example

Parameters

Returns Door[]

Example

Parameters

Returns Floor[]

Example

Parameters

Returns FloorStack[]

Example

Parameters

Returns Connection[]

Example

Parameters

Returns MapObject[]

Example

Parameters

Returns PointOfInterest[]

Example

Parameters

Returns Annotation[]

Example

Parameters

Returns Node[]

Example

Parameters

Returns EnterpriseLocation[]

Example

Parameters

Returns EnterpriseCategory[]

Example

Parameters

Returns undefined | EnterpriseVenue

Example

getDirections

Parameters

Returns undefined | Directions

Example

getDirectionsMultiDestination

Parameters

Returns undefined | Directions[]

Example

getDistance

`Optional`downloadLanguagePacks?: boolean