Create a dashboard

A dashboard is the final asset to describe when creating a configuration for the contents of your workbook. The reason for this is that the dashboard must contain the descriptions of all the charts and widgets you want to add to it.

The structure of the dashboard description is the following:

1. Describe the first tab. Any dashboard must contain at least a single tab.

2. Describe the items in a tab:

   1. The element id. It must be unique within the workbook.

   2. The element properties:

      1. kind - the type of element to put into the tab container

      2. tabs - the element's credentials.

         For example, a charts_container element needs title, id and chart_name as credentials.

      3. hide_title - a boolean responsible for hiding or displaying the element's title in the dashboard.

   3. The element placement. Described with integer numbers for the following coordinate values:

      Tip

      The placement grid consists of 36 columns, each height unit equals 18 pixels.

      X and Y parameters start from 0.

      • x - the position on the horizontal axis.

      • y - the position on the vertical axis.

      • w - the width of the element.

      • h - the height of the element.

- name: main_dash
dashboard:
   tabs:
   - title: Default
      id: default
      items:
      - id: tiid_chart_0
      element:
         kind: charts_container
         tabs:
         - id: wtid_ch_area_sales_per_week_per_cat
            chart_name: ch_area_sales_per_week_per_cat
         hide_title: true
      placement:
         x: 0
         y: 2
         w: 9
         h: 9
   ignored_connections: []