Class LocationProfile

A class that implements IFocusable can be focused on by the camera.

Hierarchy

default
- LocationProfile

Implements

LocationData
IFocusable
INavigatable

Index

Constructors

Properties

description? externalId? id images links logo? name phone? social website?

Accessors

annotations areas categories connections doors mapObjects openingHours points spaces

Methods

Constructors

constructor

new LocationProfile(
data: MapDataInternal,
options: { mvfData: Location },
): LocationProfile
Parameters
- data: MapDataInternal
- options: { mvfData: Location }
Returns LocationProfile
Overrides BaseMetaData.constructor

Properties

`Optional`description

description?: string

`Optional`externalId

externalId?: string

id

id: string

The identity of the map metadata.

images

images: ImageData[]

The location's pictures

links

links: Hyperlink[]

Web links for the location

`Optional`logo

logo?: string

The location's logo

Format

uri

name

name: string

`Optional`phone

phone?: string

social

social: LocationSocial[]

The location's social media links.

`Optional`website

website?: Hyperlink

The location's website

Accessors

annotations

get annotations(): Annotation[]
Gets the Annotations associated with the location.

Returns Annotation[]
The annotations array.

areas

get areas(): Area[]
Gets the Areas associated with the location.

Returns Area[]
The areas array.

categories

get categories(): LocationCategory[]
Gets the LocationCategorys associated with the location.

Returns LocationCategory[]
The location categories array.

connections

get connections(): Connection[]
Gets the Connections associated with the location.

Returns Connection[]
The connections array.

doors

get doors(): Door[]
Gets the Doors associated with the location.

Returns Door[]
The doors array.

mapObjects

get mapObjects(): MapObject[]
Gets the MapObjects associated with the location.

Returns MapObject[]
The map objects array.

openingHours

get openingHours(): OpeningHours
Gets the OpeningHours associated with the location.

Returns OpeningHours
The opening hours.

points

get points(): PointOfInterest[]
Gets the PointOfInterests associated with the location.

Returns PointOfInterest[]
The points of interest array.

spaces

get spaces(): Space[]
Gets the Spaces associated with the location.

Returns Space[]
The spaces array.

Methods

toJSON

toJSON(): { id: string; name: string }
Returns { id: string; name: string }

`Static`is

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