Noodly Pasta Maker

    @jibestream-dev/jmap-device-kit

    1.0.2 • Public • Published

    DeviceKit

    Jibestream plugin for using Devices

    Documentation

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Classes

    Device
    DeviceCollectionjmap.core.BaseCollection

    Class representing a collection of Devices.

    DeviceKit

    Kit for working with Jibestream Devices

    Typedefs

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Device

    Kind: global class

    new Device()

    Class representing a Device.

    device.heading : Number

    Kind: instance property of Device

    device.name : String

    Kind: instance property of Device

    device.waypointId : Number

    Kind: instance property of Device

    device.mapId : Number

    Kind: instance property of Device

    device._getLocation(model)

    Create a Device.

    Kind: instance method of Device

    Param Type Description
    model object The model object passed back from the /full payload

    DeviceCollection ⇐ jmap.core.BaseCollection

    Class representing a collection of Devices.

    Kind: global class
    Extends: jmap.core.BaseCollection

    new DeviceCollection()

    Create a collection of Devices.

    deviceCollection.isDevice(item) ⇒ Boolean

    Returns a boolean for weather or not argument is constructed as an Device object

    Kind: instance method of DeviceCollection
    Returns: Boolean - Boolean based on evaluation result

    Param Type Description
    item Object Item to evaluate

    deviceCollection.getByName(name) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    name String A device name

    deviceCollection.getByWaypoint(waypoint) ⇒ Array

    Get a specific set of devices belonging to a waypoint

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    waypoint jmap.core.Waypoint Any waypoint to query with

    deviceCollection.getByMap(map) ⇒ Array

    Get a specific set of devices belonging to a map

    Kind: instance method of DeviceCollection
    Returns: Array - an array of devices

    Param Type Description
    map jmap.core.Map Any map to query with

    DeviceKit

    Kit for working with Jibestream Devices

    Kind: global class

    new DeviceKit(core, control)

    Create a DeviceKit.

    Param Type Description
    core JCore instanciated JCore
    control JController instanciated JController

    deviceKit.getDevices(callback) ⇒ DeviceKit

    Make request to JACS to populate the DeviceCollection of the ActiveVenue

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback function callback fired when devices are ready, passes error, deviceCollection as arguments

    deviceKit.wayfindToDevice(callback, device, number) ⇒ Array

    Draws a path to the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind from
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.wayfindFromDevice(waypoint, device, number) ⇒ Array

    Draws a path from the selected device

    Kind: instance method of DeviceKit
    Returns: Array - List of path points, seperted by floor

    Param Type Description
    waypoint jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    number accessLevel level of accessibility of the path

    deviceKit.focusToDevice(callback, device, animation) ⇒ DeviceKit

    Focuses the view center to the position of the device, changes the mapView if needed

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    callback jmap.core.Waypoint waypoint to wayfind to
    device Device device model
    animation jmap.Animation animation definition

    deviceKit.focusToDeviceWithHeading(device) ⇒ DeviceKit

    Rotates the map to match the device heading

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.getWaypointFromDevice(device) ⇒ jmap.core.Waypoint

    Returns the waypoint matching the device waypointId if the waypoint exists in a loaded map

    Kind: instance method of DeviceKit
    Returns: jmap.core.Waypoint - waypoint

    Param Type Description
    device Device device model

    deviceKit.addComponentOverDevice(device, component) ⇒ DeviceKit

    Adds an html component ontop of your devoce, commonly used for 'You are here' indicators

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    component DOMElement any html element wrapped in a div

    deviceKit.removeComponentFromDevice(device) ⇒ DeviceKit

    Removes any html component added ontop of your device.

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showDevice(device, config) ⇒ DeviceKit

    Display the device on its respecive map

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideDevice(device) ⇒ DeviceKit

    Hide the divice

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model

    deviceKit.showAllDevices(config) ⇒ DeviceKit

    Display all the devices on thier respecive maps

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    config DeviceViewConfig configuration used to generate the appearance of the device. only read the first time a device is shown

    deviceKit.hideAllDevices() ⇒ DeviceKit

    Hides all divices

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    deviceKit.pingDevice(device, onComplete) ⇒ DeviceKit

    Plays a pulse animation for the decive once, fires an onComplete callback when done

    Kind: instance method of DeviceKit
    Returns: DeviceKit - DeviceKit

    Param Type Description
    device Device device model
    onComplete function callback fired once animation is complete

    DeviceViewConfig : Object

    The configuration object for the creation and update of an asset

    Kind: global typedef
    Properties

    Name Type Default Description
    width number 20 The width of the icon
    height number 20 The height of the icon
    url string The URL of the image to be used as the asset's icon
    scaleWithMap boolean true Whether the asset's icon should scale with the map
    iconColor string If no url is provided for the icon, the colour of the default icon
    confidenceMax number The maximum radius of the confidence circle (in pixels)
    confidencePercent number The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle
    confidenceColor string The color of the confidence circle in hexadecimal format
    confidenceAlpha number The transparency of the confidence circle (between 0 and 1)
    pulseColor string The color of the pulse circle
    pulseStartAlpha number The starting opacity of the pulse circle (between 0 and 1)
    pulseEndAlpha number The ending opacity of the pulse circle (between 0 and 1)
    pulseDuration number The length of time of the pulse animation (in seconds)
    pulseDelay number The delay between pulse animation (in seconds)
    pulseVisible boolean Whether the pulse should be visible

    Install

    npm i @jibestream-dev/jmap-device-kit

    DownloadsWeekly Downloads

    81

    Version

    1.0.2

    License

    ISC

    Last publish

    Collaborators

    • k_schaefer
    • hadimirza
    • chris.christie
    • ryanbercovitch
    • inpixon.dmf
    • eduardobaquero
    • suresh.polavarapu
    • louieyuen
    • sonamsodani
    • frankinpix
    • brianchim-inpixon
    • dvertlib
    • map-team
    • jibestream
    • khanazad
    • frduff
    • gsaunders-ixp
    • kayschaef.inpixon
    • arontennant
    • tejlehal
    • siripurapu-rajitha
    • sampedda
    • lyuen