Readonly __typeOptional amenityOptional colorOptional descriptionOptional detailsOptional externalOptional filterOptional galleryOptional logoOptional operationOptional phoneOptional pictureOptional shortOptional showOptional showOptional siblingOptional socialOptional sortOptional tagsStatic Readonly __typeCategories related to this location.
Specific 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, we have put 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.
Nodes this Location is attached to.
Parent of this Location, if any. Used in cases where one Location is inside another, more "important" Location.
Polygons this Location is attached to.
Get Directions to a node, polygon, or location
Optional options: TDirectionToOptionsOptional options: TDirectionToOptionsCalculate distance between 2 nodes, polygons or locations
Optional options: TDirectionToOptionsStatic fetchStatic hydrateStatic isStatic updateOptional hydrateData: any
A MappedinLocation is something like a store or washroom on a MappedinMap. It has an ID and will be linked to zero or more MappedinNodes and MappedinPolygons.
A Location's Nodes and Polygons can be on multiple Maps, or in multiple non-adjacent places on the same Map. For example, all washroom at a given Venue could belong to one Location, or a department store could live on multiple floors. A Washroom Location might a have a few Polygons spread throughout the Venue for each one that exists, but a single store might just have one presence, and therefore one Polygon. Some Locations just have a single point and only have Nodes.
A Location can have more properties (typically things like 'name', 'externalId', 'type', 'categories', 'description', 'logo', etc).
The Mappedin 'things' object is where you would specify what properties you want to download for Locations. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.
See below for an example a 'things' object with available Location properties specified: