Interface

Location

Location

Properties:
Name Type Attributes Description
id string
type string
geometry Geometry

See GeoJSON Geometry

properties Object

Properties

additionalDetails Array.<AdditionalDetail> <nullable>

Additional details for a location.

aliases Array.<string>
anchor Point

See GeoJSON Point

building string
categories Object.<string, string>
description string <nullable>
displayRule DisplayRule <nullable>
externalId string <nullable>
fields Object.<string, Field>

Custom properties.

floor string
floorName string
imageURL string
locationType string
locationSettings LocationSettings <nullable>

The location settings.

mapElement string
name string
type string
venue string

Methods

# getFieldForKey(key) → {Field}

Get data for custom property with key, disregarding casing of key.

Parameters:
Name Type Description
key string

for custom property.

Properties

Field

# getLiveDataForDomain(domainType) → {LiveUpdate}

Get live update for a domain type on a location.

Parameters:
Name Type Description
domainType string

The live data domain type to get.

LiveUpdate