Properties

This page describes the HTML Canvas class properties.

HTML Canvas class properties

Property	Type	Description
dashboardDateRange	Object	Dashboard time frame.
dashboardObject	Object	Dashboard information.
deviceObject [DEPRECATED]	Object	Device object of the currently selected device in a dynamic dashboard.
selectedDevice [DEPRECATED]	string	ID of the currently selected device in a dynamic dashboard.
selectedDevices	string array	Array of the selected device IDs in a dynamic dashboard.
selectedDeviceObjects	Object array	Device objects array for the selected devices in a dynamic dashboard.
selectedFilters	Array array object	Array containing as many arrays as filters configured in the dashboard. Each nested array contains the filter objects for that particular filter.
token	string	Account default token.
realTime	bool	Whether real time is enabled in the dashboard.

dashboardDateRange

{
    "start":1637006467592,
    "end":1637095008866
}

dashboardObject

{
    "id": "6624cb56820a574b5730a16",
    "name": "some-dashboard",
    "timeframe": {
        "endDate": "now",
        "startDate": "now-24h"
    },
    "organization": {}
}

selectedDevices

[
    "65fb47fad809281764f8a350",
    ... ,
    "65fb47fad809281764f8a358"
]

selectedDeviceObjects

[
   {
      "url":"https://industrial.ubidots.com/api/v2.0/devices/65fb47fad809281764f8a350",
      "id":"65fb47fad809281764f8a350",
      "label":"2cf7f1c042300137",
      "name":"El Poblado",
      "description":"",
      "lastActivity":1714518206109,
      "createdAt":"2024-03-20T20:32:58.793812Z"
   },
   {
      "url":"https://industrial.ubidots.com/api/v2.0/devices/65fb47cec4098b1afda06660",
      "id":"65fb47cec4098b1afda06660",
      "label":"2cf7f1c042300213",
      "name":"Envigado",
      "description":"",
      "lastActivity":1712755770263,
      "createdAt":"2024-03-20T20:32:14.215320Z"
   },
   {
      "url":"https://industrial.ubidots.com/api/v2.0/devices/65a6fd8a9c33d2000c0ba386",
      "id":"65a6fd8a9c33d2000c0ba386",
      "label":"902a3c5ff139b0d5e390c1682472c7fa",
      "name":"West Menlo Park",
      "description":"Current weather conditions in West Menlo Park (US)",
      "lastActivity":1709043377617,
      "createdAt":"2024-01-16T22:04:58.909444Z"
   }
]

selectedFilters

[
   [
      {
         "type":"value",
         "value":"60",
         "variables":"~temperature",
         "lookup":"lte",
         "negate":false
      },
      {
         "type":"value",
         "value":"30",
         "variables":"~temperature",
         "lookup":"gte",
         "negate":false
      }
   ],
   [
      {
         "type":"value",
         "value":"60",
         "variables":"~humidity",
         "lookup":"lte",
         "negate":false
      },
      {
         "type":"value",
         "value":"30",
         "variables":"~humidity",
         "lookup":"gte",
         "negate":false
      }
   ]
]