Class PointOfInterest

A class representing point of interest data within the map.

Points of interest are used to represent specific points on the map with additional information(e.g. ATMs, Water Fountains).

Hierarchy

default
- PointOfInterest

Index

Properties

`Readonly`id

id: string

identity of the map object

Accessors

coordinate

get coordinate(): Coordinate
Gets the Coordinate of the POI.

Returns Coordinate
The POI's coordinate.

description

get description(): string
Gets the description of the POI.

Returns string
The description of the POI.

externalId

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

Returns string
The external ID of the POI.

floor

get floor(): Floor
Gets the Floor object associated with the POI.

Returns Floor
The floor object.

Throws
Will throw an error if the floor is not found.

images

get images(): Image[]
Gets the images associated with the POI.

Returns Image[]
The images associated with the POI.

name

get name(): string
Gets the name of the POI.

Returns string
The name of the POI.

Methods

toJSON

toJSON(): {
    coordinate: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    };
    floor: string;
    id: string;
    name: string;
}
Serializes the POI data to JSON.

Returns {
    coordinate: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    };
    floor: string;
    id: string;
    name: string;
}
An object representing the POI.
- coordinate: {
      floor: undefined | string;
      latitude: number;
      longitude: number;
  }
  - floor: undefined | string
  - latitude: number
  - longitude: number
- floor: string
- id: string
- name: string

`Static`is

is(instance): instance is PointOfInterest
Checks if the provided instance is of type PointOfInterest.
Parameters
- instance: object
  The instance to check.
Returns instance is PointOfInterest
True if the instance is a PointOfInterest, false otherwise.

Class PointOfInterest

Hierarchy

Index

Properties

Accessors

Methods

Properties

`Readonly`id

links

Returns

Accessors

coordinate

Returns Coordinate

description

Returns string

externalId

Returns string

floor

Returns Floor

Throws

images

Returns Image[]

name

Returns string

Methods

toJSON

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

coordinate: {
    floor: undefined | string;
    latitude: number;
    longitude: number;
}

floor: undefined | string

latitude: number

longitude: number

floor: string

id: string

name: string

`Static`is

Parameters

Returns instance is PointOfInterest

Settings

On This Page

Class PointOfInterest

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonlyid

links

Returns

Accessors

coordinate

Returns Coordinate

description

Returns string

externalId

Returns string

floor

Returns Floor

Throws

images

Returns Image[]

name

Returns string

Methods

toJSON

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

coordinate: { floor: undefined | string; latitude: number; longitude: number; }

floor: undefined | string

latitude: number

longitude: number

floor: string

id: string

name: string

Staticis

Parameters

Returns instance is PointOfInterest

Settings

On This Page

`Readonly`id

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

coordinate: {
floor: undefined | string;
latitude: number;
longitude: number;
}

`Static`is