Class LocationProfile

Optionaldescription

OptionalexternalId

Optionalextra

const mapData = await getMapData({
  ...
  mvfVersion: '3.0.0',
});

const locationProfile = mapData.getById('location-profile', id);
if (typeof locationProfile?.extra?.myProperty === 'string') {
	// Do something
}
Copy

Optionalicon

id

images

links

Optionallogo

name

Optionalphone

social

Optionalwebsite

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.

toJSON

• toJSON(): { __type: string; id: string; name: string }

  Returns { __type: string; id: string; name: string }

Staticis

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