Dashboard

A dashboard is defined by a tile list.

There is 3 types of dashboards:

  • dashboard (by default)
  • flex
  • scada
{
  'title' 'Test'
  'description' 'Dashboard test'
  'url' 'https://warp.senx.io/api/v0/exec'
  'tiles' []
  'type' 'dashboard'    // 'scada' or 'dashboard' or 'flex';
  'vars' {}
  'options' {}
  'cols' 12             // for 'type' = 'dashboard' or 'flex'
  'cellHeight' 220      // for 'type' = 'dashboard' or 'flex' in px
}

Learn more about dashboard parameters

Dashboard type

This kind of dashboard will place tiles according to an x/y grid position (starting at 0) and cell/col span. By default, the grid is 12 columns wide and each cell has a height of 220px.

grid system

{
  'title' 'Test'
  'description' 'Dashboard test'
  'url' 'https://warp.senx.io/api/v0/exec'
  'tiles' [
    {
      'title' 'hello'
      'type' 'display'
      'x' 3 // in the fourth column 
      'y' 5 // in the sixth row
      'w' 4 // 4 columns width 
      'h' 1 // 1 row height
      'data' 'world'
    }
  ]
}

Scada type

Tiles will be positioned into an absolute canvas with x and y in px starting from the upper-left corner and the z index. Width and height are also in px.

{
  'title' 'Test'
  'description' 'Dashboard test'
  'url' 'https://warp.senx.io/api/v0/exec'
  'tiles' [
    {
      'title' 'hello'
      'type' 'display'
      'x' 300  'y' 500 'z' 5
      'w' 400  'h' 252
      'data' 'world'
    }
  ]
}

Flow type

This kind of dashboard do not rely on a grid for the x/y positioning. Tiles will be placed as they are ordered. You have to set width and height according to the standard grid.

{
  'title' 'Test'
  'description' 'Dashboard test'
  'url' 'https://warp.senx.io/api/v0/exec'
  'tiles' [
    {
      'title' 'hello'
      'type' 'display'
      'w' 4 // 4 columns width 
      'h' 1 // 1 row height
      'data' 'world'
    }
  ]
}

Next steps

Found an issue on this page or something missing?

Tell us onSlack iconThe Lounge, the Warp 10 Community Slack.