Optional
amenityThe amenity of the location.
Optional
descriptionThe description of the location.
The external ID of the location.
Optional
extraExtra properties of the location.
Optional
galleryThe gallery of the location.
Readonly
idThe identity of the map metadata.
Optional
instancesSpecific instances of this location with different properties. Typically, there will be at least one node or polygon defined, plus one or more other properties that are different from the parent. The remaining properties will be the same as the parent.
For example, suppose there is a location like this:
{
"id": "location-id-1",
"name": "Location 1",
"nodes": ["node-1", "node-2"],
"polygons": ["polygon-1", "polygon-2"],
"externalId": "externalId-1",
"description": "Description 1",
}
(Note that for clarity, this example puts strings in for nodes and polygons, but in practice they would be objects.)
Then suppose it had an instances
array that contained an object that looked like this:
{
"id": "instance-id-1",
"name": "Location 1 - A",
"nodes": ["node-1"],
"polygons": ["polygon-1"],
"externalId": "externalId-1-A",
"description": "Description 1",
}
This says "Location 1" is the parent location, and "Location 1 - A" is an instance of it. The instance has a different name, and a different external ID, and it only applies to node node-1
and polygon polygon-1
.
The ID will always be different, but other properties (like the description) are the same as the parent.
Example use cases:
Note: Instances are actual EnterpriseLocations. This means they have all the properties of a normal EnterpriseLocation, including an instances
property, that will always be undefined. They also do NOT have a parent property, or any other explicit reference to the parent location. These instances are
only referenced from their parent location, and will not show up in other places in the map data. However, they should otherwise behave like normal EnterpriseLocations, being targetable for things like navigation and focus.
Optional
logoA URL to the logo of the location.
The name of the location.
Optional
operationThe operation hours of the location.
Optional
phoneThe phone number of the location.
Optional
pictureA URL to the picture of the location.
Optional
shortThe short name of the location.
Optional
showWhether to show the floating label when an image is present.
Optional
showWhether to show the logo.
Optional
siblingThe sibling groups of the location.
Optional
socialThe social media links of the location.
The sort order of the location.
Optional
statesThe LocationStates of the location.
Optional
tagsThe tags of the location.
The type of the location.
Static
isChecks if the provided instance is of type EnterpriseLocation.
The instance to check.
True if the instance is a EnterpriseLocation, false otherwise.
An EnterpriseLocation contains metadata about a location, such as its name, description, logo, phone number, social medial links, hours of operation and more. They can be accessed using the () method as shown below.
Refer to the EnterpriseLocation Guide for more information and interactive examples.