Wayfinder Amenities 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.
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:
|
ofType(typeId) |
function |
Returns an instance of WayfinderAmenitiesDatabase containing only amenities that match the typeId provided |
|
uniqueTypes() |
function |
Returns an array of the unique amenity type Ids used |
|
onFloor(floorId) |
function |
Returns an instance of Wayfinder Amenities Database containing just the amenities on the floorId passed |
|
setSelected(isSelected) |
function |
Based on isSelected, selects/deselects all of the amenities in this object. If this type of amenity is not normally visible, this may cause it to appear. |
|
setActive(isActive) |
function |
Based on isActive, activates/de-activates all of the amenities in this object. If this type of amenity is not normally visible, this may cause it to appear. |
Each record in the WayfinderAmenitiesDat4 the following functions and properties:
|
floor |
property (r) |
The floorId this amenity should appear on. |
|
id |
property (r) |
The unique ID for this amenity instance |
|
location_description |
property (r) |
A textual description describing the location of this amenity. Note: This might be null if not set. |
|
node |
property (r) |
A unique nodeId describing the precise location this amenity appears at. |
|
overlay |
property (r) |
Provides direct access to the instance of the actual overlay. See Wayfinder Overlay |
|
panToView(animate) |
function |
Causes the map to pan so that this amenity is in the center. If animate is true then the map will smoothly animate into the new position. |
|
setActive(isActive) |
function |
Controls the active state of the amenity. Use the isActive property to activate/deactivate the amenity. |
|
setSelected(isSelected) |
function |
Controls the selected state of the amenity. Use the isSelected property to activate/deactivate the amenity. |
|
type |
property (r) |
The amenity type Id for this amenity. This can be looked up in the Wayfinder Amenity Types Database |