new DeviceKit(core, control)
DeviceKit.js, line 6
Create a DeviceKit.
| Name | Type | Description |
|---|---|---|
core |
JCore | instanciated JCore |
control |
JController | instanciated JController |
Methods
-
addComponentOverDevice(device, component){DeviceKit}
DeviceKit.js, line 143 -
Adds an html component ontop of your devoce, commonly used for 'You are here' indicators
Name Type Description deviceDevice device model componentDOMElement any html element wrapped in a div Returns:
Type Description DeviceKit DeviceKit -
focusToDevice(callback, device, animation){DeviceKit}
DeviceKit.js, line 114 -
Focuses the view center to the position of the device, changes the mapView if needed
Name Type Description callbackjmap.core.Waypoint waypoint to wayfind to deviceDevice device model animationjmap.Animation animation definition Returns:
Type Description DeviceKit DeviceKit -
focusToDeviceWithHeading(device){DeviceKit}
DeviceKit.js, line 123 -
Rotates the map to match the device heading
Name Type Description deviceDevice device model Returns:
Type Description DeviceKit DeviceKit -
getDevices(callback){DeviceKit}
DeviceKit.js, line 75 -
Make request to JACS to populate the DeviceCollection of the ActiveVenue
Name Type Description callbackfunction callback fired when devices are ready, passes error, deviceCollection as arguments Returns:
Type Description DeviceKit DeviceKit -
getWaypointFromDevice(device){jmap.core.Waypoint}
DeviceKit.js, line 132 -
Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map
Name Type Description deviceDevice device model Returns:
Type Description jmap.core.Waypoint waypoint -
hideAllDevices(){DeviceKit}
DeviceKit.js, line 208 -
Hides all divices
Returns:
Type Description DeviceKit DeviceKit -
hideDevice(device){DeviceKit}
DeviceKit.js, line 185 -
Hide the divice
Name Type Description deviceDevice device model Returns:
Type Description DeviceKit DeviceKit -
pingDevice(device, onComplete){DeviceKit}
DeviceKit.js, line 219 -
Plays a pulse animation for the decive once, fires an onComplete callback when done
Name Type Description deviceDevice device model onCompletefunction callback fired once animation is complete Returns:
Type Description DeviceKit DeviceKit -
removeComponentFromDevice(device){DeviceKit}
DeviceKit.js, line 156 -
Removes any html component added ontop of your device.
Name Type Description deviceDevice device model Returns:
Type Description DeviceKit DeviceKit -
showAllDevices(config){DeviceKit}
DeviceKit.js, line 197 -
Display all the devices on thier respecive maps
Name Type Description configDeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown Returns:
Type Description DeviceKit DeviceKit -
showDevice(device, config){DeviceKit}
DeviceKit.js, line 170 -
Display the device on its respecive map
Name Type Description deviceDevice device model configDeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown Returns:
Type Description DeviceKit DeviceKit -
wayfindFromDevice(waypoint, device, number){Array}
DeviceKit.js, line 103 -
Draws a path from the selected device
Name Type Description waypointjmap.core.Waypoint waypoint to wayfind to deviceDevice device model numberaccessLevel level of accessibility of the path Returns:
Type Description Array List of path points, seperted by floor -
wayfindToDevice(callback, device, number){Array}
DeviceKit.js, line 92 -
Draws a path to the selected device
Name Type Description callbackjmap.core.Waypoint waypoint to wayfind from deviceDevice device model numberaccessLevel level of accessibility of the path Returns:
Type Description Array List of path points, seperted by floor