Wayfinder Database Class
This class allows you access to all of the data available about the project. This includes destinations, amenities, maps, nodes and more.
This class allows you access to all of the data available about the project. This includes destinations, amenities, maps, nodes and more.
All of the objects containing multiple records are all use the same base class.
With properties, (r) means read only, (r/w) means read/write.
|
amenities |
property (r) |
Provides access to the WayfinderAmenitiesDatabase object which provides details about all of the amenities on every floor/map. |
|
amenityTypes |
property (r) |
Provides access to the WayfinderAmenityTypeDatabase object which provides details about the types of amenity available and in use. |
|
apiKey |
property (r) |
A string containing the current active API key (if in use) |
|
buildings |
property (r) |
Provides access to the WayfinderBuildingDatabase object which provides access to the buildings/campus for this project. |
|
defaultFloorId |
property (r) |
The default (startup) map/floorId to show. See WayfinderFloorDatabase. |
|
destinationCategories |
property (r) |
Provides access to the WayfinderDestinationCategoryDatabase |
|
destinations |
property (r) |
Provides access to the WayfinderDestinationDatabase |
|
floors |
property (r) |
Provides access to the WayfinderFloorDatabase which contains all of the maps/floors used within the project. |
|
isMapApp |
property (r) |
Is true if this is loaded from the MapApp website |
|
isPreviewMode |
property (r) |
Is true if the map is rendering in preview mode |
|
mapPublishDate |
property (r) |
Date and time the map data was published. In the format of yyyy-mm-dd hh:nn:ss |
|
mapVersion |
property (r) |
Sequential CMS map data publish number |
|
meshLinks |
property (r) |
Provides access to the WayfinderMeshLinksDatabase object that contains a special mapping where specific mesh clicks should be used to move the view to a different map/floor |
|
nodes |
property (r) |
Provides access to the WayfinderNodesDatabase object which provides details about all the points used on the map for navigation or amenity icons |
|
projectInformation |
property (r) |
Provides access to the Project Information object |
|
transitNodes |
property (r) |
Provides access to the WayfinderTransitNodesDatabase object which contains all of the inter-map joins. |
|
travelTypes |
property (r) |
Provides access to the WayfinderTravelTypesDatabase object which provides details about the different ways you can travel around the map. Between nodes, each join can be assigned a specific type. |