First Dashboard

A dashboard is defined by a WarpScript returning its definition.

Dashboard definition

A dashboard is defined by a tile list, an optional title and an optional description:

{
  'title' 'Test'
  'description' 'Discovery Dashboard'
  'tiles' []
}

Learn more about dashboards

You can display a dashboard

  • in HTML
  • in WarpStudio
  • in VSCode

HTML

<discovery-dashboard url="https://sandbox.senx.io/api/v0/exec" >
{
  'title' 'Test'
  'description' 'Discovery Dashboard'
  'tiles' []
}
</discovery-dashboard>
{ 'title' 'Test' 'description' 'Discovery Dashboard' 'tiles' [] }

WarpStudio

WarpStudio natively supports Discovery dashboards and its snippets: Sample dashboad

WarpStudio

VSCode

Our VSCode plugin natively supports Discovery dashboards and its snippets.

VSCode warpScript plugin

Adding tiles

A tile is defined by a type, on optional title, coordinates and a content (either a macro or data):

macro/data computation order

Data attribute

The data attribute is computed when the dashboard is computed.

{
  'title' 'Test'
  'tiles' [
    {
        'type' 'display'
        'x' 0 'y' 0 'w' 1 'h' 1
        'data' 42
    }
  ]
}
{ 'title' 'Test' 'tiles' [ { 'type' 'display' 'x' 0 'y' 0 'w' 1 'h' 1 'data' 42 } ] }

Macro attribute

The macro attribute is computed after the tile was loaded:

{
  'title' 'Test'
  'tiles' [
    {
        'type' 'display'
        'x' 0 'y' 0 'w' 1 'h' 1
        'macro' <% 42 %>
    }
  ]
}
{ 'title' 'Test' 'tiles' [ { 'type' 'display' 'x' 0 'y' 0 'w' 1 'h' 1 'macro' <% 42 %> } ] }

Next steps

Found an issue on this page or something missing?

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