Dashboard configuration

Dashboard configuration

Sidebar config

A screenshot of the "Sidebar config" sheet

This table defines the order and sections in which parameters will appear in the dashboard sidebar. The order of parameters and their sections will match the resulting order in the sidebar.

Image showing how the "Sidebar config" table results in the organisation of sidebar parameters

To complete the table, add one new line per parameter you want to include in the sidebar, with the following information in the corresponding column for each:

• Parameter Reference (Reference): a reference to the parameter to be shown in the sidebar. Go to Parameter references below for further information.

• Section (Text): name of the section of the sidebar in which to include this parameter. Parameters in the same section should share this value. The order of sections in this table will determine the order of sections in the dashboard.

• Group (Text): name of the group in which to include this parameter. Groups are a more granular level than sections. Parameters in the same group should share this value.

• Selector (Reference, optional): a reference to a previously included “Selector” parameter. Used when certain parameters should only appear in the sidebar depending on the status of a selector. If left empty, the parameter defined in this row will always be shown.

• Selector Status (Text, optional): a possible value of the selector referenced in the “Selector” column. The parameter on this row will only show when the selector status is the value written in this column. If the parameter should show under multiple possible values of the selector, you can include them all by separating the values with “;”.

Parameter references

The sidebar is built in this table by referencing to previously defined parameters that will be shown in the sidebar. The options are:

Static Parameter

A reference to a "Static Parameter". A slider will be shown, using the specifications from the Static Parameters section.

Static Parameter slider in the dashboard sidebar

Selector Parameter

A reference to a "Selector Parameter". A dropdown box will be shown, using the specifications from the Selector Parameters section.

Selector Parameter dropdown in the dashboard sidebar

Time Dependent Parameter

A reference to a "Time Dependent Parameter". A table will be shown, with the values specified in the Time Dependent Parameters section as defaults, followed by sliders to adjust its values and a plot of the current parameter definition.

Time Dependent Parameter table in the dashboard sidebar

Vesting (special reference)

If, instead of a reference to a user-defined parameter, a row specifies vesting in the "Parameter Reference" column, a special section is shown in the sidebar in which the dashboard user can adjust parameters from the Base and Vesting sections: the initial token price, the initial token supply, and a table with the allocations and vesting schedule:

Vesting section in the dashboard sidebar

KPIs Snapshot config

A screenshot of the "KPIs Snapshot config" sheet

This table contains the definition for a KPIs panel that can be configured to appear in the dashboard. This special panel displays a slider where the user can select a specific month in the simulation and get the values of the specified metrics at that point in the simulation time. The widgets also show the variation from the previous month.

Image showing how the "KPIs Snapshot config" table results in the KPIs Snapshot panel that can be shown on the dashboard

To complete the table, add one new line per metric you want to include in the panel, with the following information in the corresponding column for each:

• KPI name (Text): the name that will appear in the widget as the name of the KPI.

• Variable Reference (Reference): reference to one of the metrics defined in the metrics section, to one of the user-defined variables defined in the variables section, or to any of the predefined variables.

• Units (Optional): units to show along with the numerical value of the KPI

The panel will display up to 5 KPIs per row, adding additional rows as required. The order of the KPIs from top to bottom in the spreadsheet will result in the same order from left to right.

Dashboard config

A screenshot of the "Dashboard config" sheet

This table contains the definition for the dashboard results panel. Here you should define the location in which the result graphs will be plotted in the dashboard.

Image showing how the "Dashboard config" table results in the organisation of dashboard graphs

To complete the table, add one new line per graph you want to include in the dashboard, with the following information in the corresponding column for each:

• Name (text): the name that will appear as the title of the graph.

• Graph Reference (Reference): reference to one of the graphs defined in the Graphs section, including any of the the predefined special graphs or any of the two special sections:

  • snapshots, which will display here the panel defined in the KPIs Snapshot config section

  • flows, which will display an automatically generated flow diagram of the token economy that you have defined

• Section (Text): name of the section of the results panel in which to include this graph. Graphs in the same section should share this value. The order of sections in this table will determine the order of sections in the dashboard.

• Vertical Position (Integer): position of the graph within the section.

• Horizontal Position ("Right", "Left", or "Center"): horizontal position of the graph. A “Left” and a “Right” graph can share the same “Vertical Position”, but a “Center” graph cannot coincide with any other. In any case, the combination of “Vertical Position” and “Horizontal Position” must always be unique.

• Events (list of References, optional): a possible event to display on top of the graph. You can list more than one event by separating the multiple references with ";"