Wayfinder Amenity Types Database Class
Amenities are floating icons representing points of interest within a map, that alone are probably not rooms or destinations. An example might be an ATM, Telephone or Toilets. Rather than repeating the details for these, they are grouped into specific types.
This class inherits and therefore includes all the methods and functions defined the standard
wayfinder database base class. As well as these, it also adds the following:
|
areAlwaysShown(alwaysShown) |
function |
Returns an instance of WayfinderAmenityTypesDatabase alwaysShown: 1: Amenity icon types that are always displayed 0: Amenity icon types that are either hidden or only shown when needed |
|
allUrls(floorId) |
function |
Returns an array of urls of all of the icons for the amenity types. If (optionally) a floorId is passed then only the types needed for that floor are returned. |
Each record in the WayfinderAmenityTypesDatabase contains the following properties:
|
always_show |
The visibility of icons on the map: |
|
description |
A textual description of this type of amenity |
|
disable_search |
if set to 1, then this amenity type should not be shown/searchable within the UI |
|
id |
Unique ID for this amenity type |
|
name |
Name of this amenity type |
|
url |
A url representing the icon used for this amenity type |