Configuration

discovery-dashboard

This is the main Web Component.

Attributes

Payload

Insert directly your dashboard definition as a WarpScript inside the HTML tag:

<discovery-dashboard url="https://warp.senx.io/api/v0/exec" dashboard-title="Test">
{
  'title' 'Test'
  'description' 'Dashboard test'
  'tiles' [
  {
    'title' 'test'
    'options' { 'autoRefresh' 1 }
    'x' 0 'y' 0 'w' 12 'h' 2
    'type' 'area' 'macro' <%
        1 4 <% DROP 
          NEWGTS 'g' STORE
          1 10 <% 
            'ts' STORE $g $ts RAND + STU * NOW + NaN NaN NaN RAND ADDVALUE DROP 
          %> FOR
          $g 
        %> FOR 
      %>
    }
  ]
}
</discovery-dashboard>

Macro as tiles definition

Allow to use a macro as a tile definition and can be polymorphic through auto-refreshes.

<discovery-dashboard url="https://warp.senx.io/api/v0/exec" dashboard-title="Test">
{
  'endpoint' 'https://sandbox.senx.io/api/v0/exec'
  'title' 'My Polymorphic Dashboard'
  'description' 'Change over a random tile count display each 10 seconds'
  'tiles' <% [
      RAND 10 * ROUND 'value' STORE
      0 $value <%
          'i' STORE
          {
              'type' 'display'
              'w' 1 'h' 1 'x' $i 'y' 0
              'data' $i
          }
      %> FOR
  ] %>
  'options' { 'autoRefresh' 10  }
}
</discovery-dashboard>

Tile definition

• If the dashboard type is 'dashboard', x, y, h and w are expressed in cells. x and y begin at 0, the top left corner, w and h begin at 1.
• If the dashboard type is 'scada', x, y, h and w are expressed in pixels. x and y begin at 0, the top left corner. z represents the z-index.

Data are displayed either with data or with macro. Auto-refresh for tiles only applies for macro.

Macro as tile definition

Allow to use a macro as a tile definition and can be polymorphic through auto-refreshes.

<discovery-dashboard url="https://warp.senx.io/api/v0/exec" dashboard-title="Test">
{
  'endpoint' 'https://sandbox.senx.io/api/v0/exec'
  'title' 'My Polymorphic Dashboard'
  'description' 'Change over a random tile count display each 10 seconds'
  'tiles' <% [
      RAND 10 * ROUND 'value' STORE
      0 $value <%
          'i' STORE
          {
              'type' 'display'
              'w' 1 'h' 1 'x' $i 'y' 0
              'data' $i
          }
      %> FOR
  ] %>
  'options' { 'autoRefresh' 10  }
}
</discovery-dashboard>

Execution result (DataModel)

You could either return a single value ( GTS, number or string depending on the chart type), or a complex data structure:

Common CSS vars

Params / Options

Options inherit from higher level. You can use options as an attribute in <discovery-dashboard />, as a field in the dashboard definition, as a field in a tile definition and as a field in execution result.

Specific charts configuration, CSS styles and samples

• Common charts parameters
• Date and timezone on axis
• Charts
  • line, spline, step, step-after, step-before
  • area, spline-area, step-area
  • scatter, bubble
  • annotation
  • bar
  • calendar
  • heatmap
  • gauge, linear-gauge, compass
  • pie, donuts, roses
  • maps
• Displays
  • display
  • image
  • tabular
  • svg
• Inputs
  • input:text, input:secret
  • input:list, input:autocomplete, input:multi, input:multi-cb
  • input:slider
  • input:date, input:date-range
  • button

Next step: Events Mechanism