dashboard.web

Web dashboard

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The id of the module using this dashboard

type

string

  • title

The title of the dashboard

type

string

  • description

  • tags

The tags of the dashboard. It can be used to search a dashboard and to classify the dashboard.

type

array

items

type

string

  • searchBarDashboardDisplayBehavior

Define the display behavior of the search bar. If EMPTY_SEARCH is selected, the search bar will show the dashboard when no search text is provided or when search content matches its content. If SEARCH_REQUIRED is chosen, the search bar will only be displayed when there is a matching search text. If HIDDEN is selected, the dashboard will never be displayed in the search bar area.

type

string

enum

EMPTY_SEARCH, SEARCH_REQUIRED, HIDDEN

default

EMPTY_SEARCH

  • markdownDescription

additionalProperties

False