Widgets

AlarmTable

AlarmTableWidget

AlarmTable
type	object
properties
type	type	string
	enum	AlarmTable
	default	AlarmTable
alarmWidgetSettings	Alarm widget settings
	dashboard.view.json-schema#/definitions/AlarmTableWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

AlarmTableWidgetSettings

type	object
properties
defaultFilter	Which alarm filter to use by default (i.e. root.alarms.filters.all)
	type	string
defaultHierarchy	Define the default hierarchy of the alarms. Two choices are available: none: every alarm is displayed as it’s own in the table grouped: only alarms that are either a group or that are not associated to any group are displayed in the table. Expanding a group alarm will show another table containing every alarm of the group. Default value is [“grouped”]
	type	string
	enum	none, grouped
	default	grouped
defaultView	Which alarm view to use by default (i.e. root.alarms.views.default).
	type	string
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box) Default value is [false]
	type	boolean
	default	False
disableResizeRowDetailHeight	Whether to allow user to increase/decrease manually the height of a row detail bloc. The height will be bound by the minimum/maximum parameters. Default value is [false]
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearUserUpdatedColumns	Whether or not to show clear user updated column in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarExport	Whether or not to show export option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show filter option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarJournal	Whether or not to show journal show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarTableAutoRefresh	Whether to allow user to toggle table auto refresh table or not. Default value is [false]
	type	boolean
	default	False
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not. Default value is [false]
	type	boolean
	default	False
disableUrlHistory	Whether to update url when table state (filter, view and search) change or not, allowing to expand the browser history by pushing a new entry. Default value is [false]
	type	boolean
	default	False
disableUserUpdatedColumnsMemoization	Whether or not to keep track of user updated column sizes. Default value is [false]
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box) Default value is [false]
	type	boolean
	default	False
disabledHierarchies	List of hierarchies to disable for this table
	type	array
	items	type	string
		enum	none, grouped
displayAlarmGroupsWhenShowingEveryAlarm	Defines if the table should show the alarm groups even when all the alarms of the group are already shown as well in the table. This has an impact only when the table hierarchy is set to none. Default value is [false]
	type	boolean
	default	False
enableAutomaticRefresh	Whether to update automatically update table when loaded. Default value is [true]
	type	boolean
	default	True
excludeFilters	The filter to exclude from this alarm table. Theses filters can be filtered by using the properties includeFilters and excludeFilters. If you set both, it will first remove all filters not present in the include list and then remove, from that list, the filters presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct filter children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
excludeViews	The views to exclude from this alarm table. Theses filters can be filtered by using the properties includeViews and excludeViews. If you set both, it will first remove all views not present in the include list and then remove, from that list, the views presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct views children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
iconAutoRefresh	Override icon to active / deactivate automatic refresh alarm table.
	IconOverrideState
iconClearFilter	Override icon to show show clear filter (default filter_alt_off).
	type	string
iconClearUserUpdatedColumns	Override icon to show show clear user updated column (default view_comfy_outlined).
	type	string
iconColumnChooser	Override icon to choose visible columns (default save).
	type	string
iconExportPanel	Override icon to export table content (default save).
	type	string
iconRefreshTable	Override icon to refresh alarm table (default refresh).
	type	string
iconShowColumn	Override icon to show column.
	IconOverrideState
iconShowFilter	Override icon to show column filters.
	IconOverrideState
iconShowSummary	Override icon to show column summary.
	IconOverrideState
iconSidePanel	Override icon to show side panel (default import_contacts).
	type	string
includeFilters	The filter to include from this alarm table. Theses filters can be filtered by using the properties includeFilters and excludeFilters. If you set both, it will first remove all filters not present in the include list and then remove, from that list, the filters presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct filter children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
includeViews	The views to include from this alarm table. Theses filters can be filtered by using the properties includeViews and excludeViews. If you set both, it will first remove all views not present in the include list and then remove, from that list, the views presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct views children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
resizeMode	Define column resize mode: nextColumn, widget (default). Default value is [“widget”]
	type	string
	enum	nextColumn, widget
	default	widget
rowDetailHeight	Define a row detail bloc height in px. The row detail bloc is the component that appears when you expand a row. This behaviour must be enable for the current table view. By default, the height is 250. If an height of 0 is given, the detail component will grow automatically depending on the content height. Default value is [250]
	type	integer
	minimum	0
	default	250
rowDetailMaxHeight	Maximum height in px for a row detail bloc. Default value is [500]
	type	integer
	minimum	0
	default	500
rowDetailMinHeight	Minimum height in px for a row detail bloc. Default value is [150]
	type	integer
	minimum	0
	default	150
shareFiltersBetweenTables	Defines if the filters applied to the main table are also applied to the sub tables. While using hierarchy grouped, expanding a row displays another table. If this setting is set as true, this other table won’t allow to define filters for each column, as it will automatically replicate the filters of the main table. Otherwise, the other table will work separately than the main table, allowing to define their own column filters. This has an impact only when the table hierarchy is set to grouped. Default value is [false]
	type	boolean
	default	False
showColumn	Whether or not to show column names. Default value is [true]
	type	boolean
	default	True
showFilter	Whether or not to show column filters. Default value is [false]
	type	boolean
	default	False
showSummary	Whether or not to show column summaries. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

Alarm history table

AlarmHistoryTableWidget

AlarmHistoryTable
type	object
properties
type	type	string
	enum	AlarmHistoryTable
	default	AlarmHistoryTable
alarmHistoryWidgetSettings	Alarm history widget settings
	dashboard.view.json-schema#/definitions/AlarmHistoryTableWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

AlarmHistoryTableWidgetSettings

type	object
properties
defaultFilter	Which alarm filter to use by default (i.e. root.alarms.filters.all).
	type	string
defaultHierarchy	Define the default hierarchy of the alarms. Two choices are available: none: every alarm is displayed as it’s own in the table grouped: alarms are grouped by lifecycle. Each alarm represent the last state of the alarm life cycle. Expanding the row shows every alarm that composed this lifecycle. Default value is [“none”]
	type	string
	enum	none, grouped
	default	none
defaultView	Which alarm view to use by default (i.e. root.alarms.views.default).
	type	string
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box). Default value is [false]
	type	boolean
	default	False
disablePagination	Whether or not to show the pagination component on the bottom. If pageSizes contains only one element, the pagination component is also hidden. Default value is [false]
	type	boolean
	default	False
disableResizeRowDetailHeight	Whether to allow user to increase/decrease manually the height of a row detail bloc. The height will be bound by the minimum/maximum parameters. Default value is [false]
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearUserUpdatedColumns	Whether or not to show clear user updated column in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarExport	Whether or not to show export option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show filter option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarJournal	Whether or not to show journal show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not. Default value is [false]
	type	boolean
	default	False
disableUrlHistory	Whether to update url when table state (filter, view and search) change or not, allowing to expand the browser history by pushing a new entry. Default value is [false]
	type	boolean
	default	False
disableUserUpdatedColumnsMemoization	Whether or not to keep track of user updated column sizes. Default value is [false]
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box) Default value is [false]
	type	boolean
	default	False
disabledHierarchies	List of hierarchies to disable for this table
	type	array
	items	type	string
		enum	none, grouped
excludeFilters	The filter to exclude from this alarm table. Theses filters can be filtered by using the properties includeFilters and excludeFilters. If you set both, it will first remove all filters not present in the include list and then remove, from that list, the filters presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct filter children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
excludeViews	The views to exclude from this alarm table. Theses filters can be filtered by using the properties includeViews and excludeViews. If you set both, it will first remove all views not present in the include list and then remove, from that list, the views presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct views children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
filtersAppliedToTheFullHistory	This has an impact only when the table hierarchy is set to grouped. Defines if the filters applied to the table only concerns the last version of the alarm or the full history of the alarm. If set to false, the filter is only applied to the last alarm. Otherwise, the filters are applied on the full history. For example, a filter on the alarms tags stating that the alarm must contain a tag named “Fire”. If this setting is set to false, an alarm will only match the filter if the last state of the alarm currently has the tag Fire. If this setting is set to true, an alarm will match the filter if at any point in time the alarm had the tag Fire, even if it was removed later. Either way, the alarm displayed in the table will always represent the last state of the alarm. Default value is [true]
	type	boolean
	default	True
iconClearFilter	Override icon to show show clear filter (default filter_alt_off).
	type	string
iconClearUserUpdatedColumns	Override icon to show show clear user updated column (default view_comfy_outlined).
	type	string
iconColumnChooser	Override icon to choose visible columns (default save).
	type	string
iconExportPanel	Override icon to export table content (default save).
	type	string
iconRefreshTable	Override icon to refresh alarm table (default refresh).
	type	string
iconShowColumn	Override icon to show column.
	IconOverrideState
iconShowFilter	Override icon to show column filters.
	IconOverrideState
iconShowSummary	Override icon to show column summary.
	IconOverrideState
iconSidePanel	Override icon to show side panel (default import_contacts).
	type	string
includeFilters	The filter to include from this alarm table. Theses filters can be filtered by using the properties includeFilters and excludeFilters. If you set both, it will first remove all filters not present in the include list and then remove, from that list, the filters presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct filter children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
includeViews	The views to include from this alarm table. Theses filters can be filtered by using the properties includeViews and excludeViews. If you set both, it will first remove all views not present in the include list and then remove, from that list, the views presents in the exclude list. The wildcard “*” can be used to replace any subpath. * “root.alarms.*” will match any direct views children of “alarms” but excludes “root.alarms” itself. Learn more about Wildcard usage ↗️
	type	array
	items	type	string
pageSize	Alarm history table page size (must be present in page sizes). Default value is [50]
	type	integer
	minimum	0
	default	50
pageSizes	Alarm history table page sizes. If pageSizes contains only one element, the pagination component is hidden Default value is [[50,100,200]]
	type	array
	default	50
		100
		200
	items	type	integer
resizeMode	Define column resize mode: nextColumn, widget (default). Default value is [“widget”]
	type	string
	enum	nextColumn, widget
	default	widget
rowDetailHeight	Define a row detail bloc height in px. The row detail bloc is the component that appears when you expand a row. This behaviour must be enable for the current table view. By default, the height is 250. If an height of 0 is given, the detail component will grow automatically depending on the content height. Default value is [250]
	type	integer
	minimum	0
	default	250
rowDetailMaxHeight	Maximum height in px for a row detail bloc. Default value is [500]
	type	integer
	minimum	0
	default	500
rowDetailMinHeight	Minimum height in px for a row detail bloc. Default value is [150]
	type	integer
	minimum	0
	default	150
shareFiltersBetweenTables	Defines if the filters applied to the main table are also applied to the sub tables. While using hierarchy grouped, expanding a row displays another table. If this setting is set as true, this other table won’t allow to define filters for each column, as it will automatically replicate the filters of the main table. Otherwise, the other table will work separately than the main table, allowing to define their own column filters. This has an impact only when the table hierarchy is set to grouped. Default value is [false]
	type	boolean
	default	False
showColumn	Whether or not to show column names. Default value is [true]
	type	boolean
	default	True
showFilter	Whether or not to show column filters. Default value is [false]
	type	boolean
	default	False
showSummary	Whether or not to show column summaries. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

Alarm severity

AlarmSeverityWidget

AlarmSeverity
type	object
properties
type	type	string
	enum	AlarmSeverity
	default	AlarmSeverity
alarmSeverityWidgetSettings	Alarm severity widget settings
	dashboard.view.json-schema#/definitions/AlarmSeverityWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

AlarmSeverityWidgetSettings

type	object
properties
count	Value mapped to type ALARM_COUNT content.
	type	string
countMaxFontSize	Maximum count font size
	type	integer
countMinFontSize	Minimum count font size
	type	integer
label	Alarm severity widget label.
	oneOf	type	string
		type	boolean
labelMaxFontSize	Maximum label font size
	type	integer
labelMinFontSize	Minimum label font size
	type	integer
labelPercent	How much of the widget height percentage the label should take. Default value is [20]
	type	integer
	maximum	100
	minimum	0
	default	20
labelPosition	Whether to put the label at the top or the bottom of the widget. Default value is [“TOP”]
	type	string
	enum	TOP, BOTTOM
	default	TOP
onClick	Operation executed upon alarm widget click.
	type	string
severity	Value mapped to type MAX_SEVERITY content.
	type	string
additionalProperties	False

Analytics aggregate

AnalyticsAggregateWidget

AnalyticsAggregateWidget
type	object
properties
type	type	string
	enum	AnalyticsAggregate
	default	AnalyticsAggregate
analyticsAggregateSettings	Range widget settings
	dashboard.view.json-schema#/definitions/AnalyticsAggregateWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

AnalyticsAggregateWidgetSettings

type	object
properties
functionSettings	Selector to define aggregate function
	AnalyticsAggregateSelect
periodSettings	Range to define window of data
	dashboard.view.json-schema#/definitions/RangeWidgetSettings
additionalProperties	False

Basic input output value

BasicInputOutputValueWidget

BasicInputOutputValue
type	object
properties
type	type	string
	enum	BasicInputOutputValue
	default	BasicInputOutputValue
basicWidgetSettings	Basic I/O value settings
	dashboard.view.json-schema#/definitions/BasicInputOutputValueWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

BasicInputOutputValueWidgetSettings

type	object
properties
addIcon	Icon when hovering numeric type widget to increase by step value (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
backgroundColor	Background color of the widget.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
foregroundColor	Foreground color of the widget.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
icon	Widget icon (https://material-ui.com/components/material-icons/) with naming in snake_case. Use layout to place it or to hide it.
	type	string
label	Widget label. Use layout to place it or to hide it.
	type	string
layout	Parts displayed by the widget, in the order they are displayed. A part left out of the list is not displayed. Default value is [[“label”,”icon”,”value”]]
	type	array
	default	label
		icon
		value
	items	type	string
		enum	label, icon, value
layoutDirection	Direction the parts are displayed in, either stacked from top to bottom (column) or side by side from left to right (row). Default value is [“column”]
	type	string
	enum	column, row
	default	column
maxValue	Maximum value for numeric value (both display and action).
minValue	Minimum value for numeric value (both display and action).
offBackgroundColor	Background color of the widget when value is “off” for text type, false boolean and “min” for numeric type.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
offForegroundColor	Foreground color of the widget when value is “off” for text type, false boolean and “min” for numeric type.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
offIcon	Icon when value is “off” for text type, false boolean and “min” for numeric type (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
offValue	Deactivated content matching for text type.
offValueText	Deactivated displayed value when matching deactivated content for text type.
	type	string
onBackgroundColor	Background color of the widget when value is “on” for text type, true boolean and “min” for numeric type.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
onClick	Widget onClick listener evaluating expression.
	type	string
onForegroundColor	Foreground color of the widget when value is “on” for text type, true boolean and “min” for numeric type.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
onIcon	Icon when value is “on” for text type, true boolean and “max” for numeric type (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
onValue	Activated content matching for text type.
onValueText	Activated displayed value when matching activated content for text type.
	type	string
removeIcon	Icon when hovering numeric type widget to decrease by step value (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
showTooltip	Whether to show tooltip when hovering the widget or not. Default value is [true]
	type	boolean
	default	True
textAcceptBackground	Background color when hovering text type widget to update value.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
textAcceptForeground	Foreground color when hovering text type widget to update value.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
textAcceptIcon	Icon when hovering text type widget to apply text content (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
textCancelBackground	Background color when hovering text type widget to update value.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
textCancelForeground	Foreground color when hovering text type widget to update value.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
textCancelIcon	Icon when hovering text type widget to cancel text content update (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
textCancelValue	Value to set using text type widget upon user pressing cancel button. When no value is given, it will use the current value.
	type	string
textInputLabel	Label for text type value.
	type	string
tooltip	Widget tooltip when hovering the widget.
	type	string
unknownBackgroundColor	Background color of the widget when value is unknown.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
unknownForegroundColor	Foreground color of the widget when value is unknown.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
unknownIcon	Displayed icon when value is unknown (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
unknownValue	Default value used for numeric and boolean value which content is unknown.
unknownValueText	Displayed text when value is unknown.
	type	string
valueStep	Increase/decrease step value for numeric type.
	type	integer
variableText	sprintf expression evaluated with text type content.
	type	string
additionalProperties	False

Border layout

BorderLayoutWidget

BorderLayout
type	object
properties
type	type	string
	enum	BorderLayout
	default	BorderLayout
borderLayoutWidgetSettings	Border Layout value settings
	dashboard.view.json-schema#/definitions/BorderLayoutWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

BorderLayoutWidgetSettings

type	object
properties
backgroundColor	Widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
centerComponent	Center component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
eastComponent	East component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
layout	Define the width and height of the different components.
	BorderLayoutArrangement
northComponent	North component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
southComponent	South component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
westComponent	West component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
additionalProperties	False

Box layout

BoxLayoutWidget

BoxLayout
type	object
properties
type	type	string
	enum	BoxLayout
	default	BoxLayout
boxLayoutWidgetSettings	Box layout settings
	dashboard.view.json-schema#/definitions/BoxLayoutWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

BoxLayoutWidgetSettings

type	object
properties
components	List of components to display in this box
	type	array
	items	BoxLayoutComponent
orientation	Orientation of the box Default value is [“Vertical”]
	type	string
	enum	Horizontal, Vertical
	default	Vertical
additionalProperties	False

Chart

ChartWidget

ChartWidget
type	object
properties
type	type	string
	enum	Chart
	default	Chart
chartWidgetSettings	Chart widget settings
	dashboard.view.json-schema#/definitions/ChartWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

ChartWidgetSettings

type	object
properties
chartTitle	Title of the chart.
	type	string
colors	Array of colors uses for chart lines. Default value is [[]]
	type	array
	default
	items
disposition	Disposition of the chart data. Lines stacked on top of each other (default) or lines separated into multiple y axis. Default value is [“Stacked”]
	type	string
	enum	Stacked, Separated
	default	Stacked
editable	Allow to edit the chart or not. Default value is [false]
	type	boolean
	default	False
interpolation	Interpolation function for graphs. Default value is [“linear”]
	type	string
	enum	linear, spline, hv, vh, hvh, vhv
	default	linear
lineWidth	Line width. Default value is [3]
	type	integer
	default	3
query	Query.
	type	string
references	Array of references that can be drawn on the chart. Default value is [[]]
	type	array
	default
	items	ChartReference
showDots	Display the data as dots. Can be used with showLines as true to show both lines and dots. Default value is [true]
	type	boolean
	default	True
showLegends	Display legends for each entry. Default value is [true]
	type	boolean
	default	True
showLines	Display the data as lines. Can be used with showDots as true to show both lines and dots. Default value is [true]
	type	boolean
	default	True
showRangeSlider	Display range slider below chart. Default value is [true]
	type	boolean
	default	True
toolbar	Toolbar settings.
	Toolbar
type	Type of chart. Default value is [“Line”]
	type	string
	enum	Line, Area, Bar
	default	Line
xAxisRange	Range of the x axis.
	RangeConfigurationEntity
yAxisRange	Range of the y axis.
	RangeConfigurationEntity
yAxisTitle	Title of the Y axis of the chart.
	type	string
additionalProperties	False

Collection table

CollectionTable

CollectionTable
type	object
properties
type	type	string
	enum	CollectionTable
	default	CollectionTable
collectionTableWidgetSettings	Collection table widget settings
	dashboard.view.json-schema#/definitions/CollectionTableSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

CollectionTableSettings

type	object
properties
defaultDisplayType	Default display type to apply upon collection table being loaded. Default value is [“table”]
	type	string
	enum	table, form
	default	table
defaultFilter	Which schema filter to use by default (i.e. filter-id).
	type	string
defaultForm	Default form to apply upon form table being loaded.
	type	string
defaultSchemas	Which schemas to use by default (i.e. root.collections.location). If multiple is false, only one schema can be specified
	type	array
	items	type	string
defaultView	Which schema view to use by default (i.e. view-id).
	type	string
disableActiveUsersCount	Whether or not to show active users count in toolbar. Default value is [false]
	type	boolean
	default	False
disableDisplayTypes	List of display types to disable for table toolbar. Default value is [[]]
	type	array
	default
	items	type	string
		enum	table, form
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box). Default value is [false]
	type	boolean
	default	False
disableFormCreate	Disable form creation for collection table. Default value is [false]
	type	boolean
	default	False
disableFormEdit	Disable form edition for collection table. Default value is [false]
	type	boolean
	default	False
disableFormHistory	Disable form history for collection table. Default value is [false]
	type	boolean
	default	False
disableFormPicker	Disable form picker in form view. Default value is [false]
	type	boolean
	default	False
disablePagination	Whether or not to show the pagination component on the bottom. If pageSizes contains only one element, the pagination component is also hidden. Default value is [false]
	type	boolean
	default	False
disableSchemaUpdate	Whether to allow user to update filter or not (will show/hide the combo box). Default value is [false]
	type	boolean
	default	False
disableSidePanel	Whether or not to show side panel option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearUserUpdatedColumns	Whether or not to show clear user updated column in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarExport	Whether or not to show export option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show filter option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not. Default value is [false]
	type	boolean
	default	False
disableUrlHistory	Whether to update url when table state (filter, view, search and current entry) change or not, allowing to expand the browser history by pushing a new entry. Default value is [false]
	type	boolean
	default	False
disableUserUpdatedColumnsMemoization	Whether or not to keep track of user updated column sizes. Default value is [false]
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box). Default value is [false]
	type	boolean
	default	False
excludeFilters	List of filters to exclude from table toolbar views.
	type	array
	items	type	string
excludeForms	List of forms to exclude in form toolbar view.
	type	array
	items	type	string
excludeSchemas	List of schemas to exclude from table toolbar filters.
	type	array
	items	type	string
excludeViews	List of views to exclude from table toolbar views.
	type	array
	items	type	string
iconActiveUsersCount	Override icon to show active users count (default face).
	type	string
iconActiveUsersLastUpdate	Override icon to show active users last update (default update).
	type	string
iconCancelCreateEntry	Override icon to cancel collection entry creation (default clear).
	type	string
iconClearFilter	Override icon to show show clear filter (default filter_alt_off).
	type	string
iconClearUserUpdatedColumns	Override icon to show show clear user updated column (default view_comfy_outlined).
	type	string
iconColumnChooser	Override icon to choose visible columns (default save).
	type	string
iconCreateEntry	Override icon to create collection entry (default post_add).
	type	string
iconEditEntry	Override icon to edit collection entry (default edit).
	type	string
iconExportPanel	Override icon to export table content (default save).
	type	string
iconFormView	Override icon to show form view (default feed).
	type	string
iconRefreshTable	Override icon to refresh collection table (default refresh).
	type	string
iconShowColumn	Override icon to show column.
	IconOverrideState
iconShowFilter	Override icon to show column filters.
	IconOverrideState
iconShowSummary	Override icon to show column summary.
	IconOverrideState
iconSidePanel	Override icon to show side panel (default import_contacts).
	type	string
iconTableView	Override icon to show table view (default table_rows).
	type	string
includeFilters	List of filters to include from table toolbar views.
	type	array
	items	type	string
includeForms	List of forms to include in form toolbar view.
	type	array
	items	type	string
includeSchemas	Schema table toolbar filters.
	type	array
	items	type	string
includeViews	List of views to include from table toolbar views.
	type	array
	items	type	string
multiple	If set to true, data can be gathered from multiple collections and are merged together Default value is [false]
	type	boolean
	default	False
onCancelDisplay	What display to set upon entry cancel (defaults: table).
	type	string
	enum	table, form
onCancelModality	What modality to set upon entry cancel (defaults: view).
	type	string
	enum	create, update, view, history
onCloseDisplay	What display to set upon entry close (defaults: table).
	type	string
	enum	table, form
onCloseModality	What modality to set upon entry close (defaults: view).
	type	string
	enum	create, update, view, history
pageSize	Collection table page size (must be present in page sizes). Default value is [50]
	type	integer
	minimum	0
	default	50
pageSizes	Collection table page sizes. If pageSizes contains only one element, the pagination component is hidden Default value is [[50,100,200]]
	type	array
	default	50
		100
		200
	items	type	integer
resizeMode	Define column resize mode: nextColumn, widget (default). Default value is [“widget”]
	type	string
	enum	nextColumn, widget
	default	widget
rowDetailHeight	Define a row detail bloc height in px. The row detail bloc is the component that appears when you expand a row. This behaviour must be enable for the current table view. By default, the height is 250. If an height of 0 is given, the detail component will grow automatically depending on the content height. Default value is [250]
	type	integer
	minimum	0
	default	250
showColumn	Whether or not to show column names. Default value is [true]
	type	boolean
	default	True
showFilter	Whether or not to show column filters. Default value is [false]
	type	boolean
	default	False
showSummary	Whether or not to show column summaries. Default value is [false]
	type	boolean
	default	False
submitSettings	Form submit widget settings
	SubmitWidgetSettings
additionalProperties	False

Discovery

DiscoveryWidget

Discovery
type	object
properties
type	type	string
	enum	Discovery
	default	Discovery
discoveryWidgetSettings	Discovery widget settings
	dashboard.view.json-schema#/definitions/DiscoveryWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

DiscoveryWidgetSettings

type	object
properties
autoLoadIntervalMs	If autoLoadOnDeviceExpansion is set to true, define an interval (in ms) between each request. Default value is [300]
	type	integer
	minimum	0
	default	300
autoLoadOnDeviceExpansion	If true, when expending a root device, a request will be made automatically for each of the device sub-devices. Each request is done one after another and if one fails the process will continue with the others. Default value is [false]
	type	boolean
	default	False
autoLoadStopOnError	If true and autoLoadOnDeviceExpansion is set to true as well, if one of the request produce an error, the whole process is stopped and no more request are done. Default value is [false]
	type	boolean
	default	False
defaultSize	Default size (in percent) for the device list section of this widget. The other section (properties table) will take all the space left. Value must be set between 0% and 100% and can’t be less than the minimum size. Default is set as 20 Default value is [20]
	type	integer
	default	20
deviceListWindowOptions	Configuration of the external window generated when opening in a new window the device list section of the widget. Options allow to define the initial size and position of the window. Both of this aspect can still be interacted with, like a normal window, once the window is opened. Size is composed of a width and height property (both expressed as pixels) and position can be defined by combining the left, top, right and bottom (all expressed as pixels) properties. Default value is [{“position”:{“left”:200,”top”:200},”size”:{“height”:500,”width”:500}}]
	default	position	left	200
			top	200
		size	height	500
			width	500
	WidgetWindowOptions
disableAddButton	Disable the possibility to lookup for a non registered device with the use of the add icon next to the device selector. Not disabled by default Default value is [false]
	type	boolean
	default	False
disableChangeOrientation	Disable the possibility to change the orientation of the widget (Vertical or Horizontal). Not disabled by default Default value is [false]
	type	boolean
	default	False
disableChangeSize	Disable the possibility to change the size of each part of the widget (Devices list and properties part). Not disabled by default Default value is [false]
	type	boolean
	default	False
disableGlobalOpenInNewWindow	Disable the possibility to open either part of the widget (device list or properties) inside a separate window. Not disabled by default Default value is [false]
	type	boolean
	default	False
disableSubsectionOpenInNewWindow	Disable the possibility to open either part of the properties section (properties table and watch list) inside a separate window. Not disabled by default Default value is [false]
	type	boolean
	default	False
disableUrlHistory	Whether to update url when widget state (path and search) change or not, allowing to expand the browser history by pushing a new entry. Default value is [false]
	type	boolean
	default	False
iconAddDevice	Override icon to add a new device (default add_circle_outline).
	type	string
iconCopyDeviceAsJson	Override icon to copy device as JSON text into clipboard (default file_copy).
	type	string
iconRefreshDevice	Override icon to refresh a device (default refresh).
	type	string
iconWatchAutoRefresh	Override icon to active / deactivate automatic refresh for the watch properties auto load.
	IconOverrideState
iconWatchUpdateNotification	Override icon to notify when the watch properties are updated (default save).
	type	string
minimumSize	Minimum size (in percent) each of the section of this widget (Devices list and properties sections) must take. Value must be set between 0% and 50%. Default is set as 20 Default value is [20]
	type	integer
	default	20
orientation	Default orientation of the widget (VERTICAL or HORIZONTAL). Default is set as HORIZONTAL Default value is [“HORIZONTAL”]
	type	string
	enum	VERTICAL, HORIZONTAL
	default	HORIZONTAL
propertiesSectionTableWindowOptions	Configuration of the external window generated when opening in a new window the properties table from properties section of the widget. Options allow to define the initial size and position of the window. Both of this aspect can still be interacted with, like a normal window, once the window is opened. Size is composed of a width and height property (both expressed as pixels) and position can be defined by combining the left, top, right and bottom (all expressed as pixels) properties. Default value is [{“position”:{“left”:200,”top”:200},”size”:{“height”:500,”width”:500}}]
	default	position	left	200
			top	200
		size	height	500
			width	500
	WidgetWindowOptions
propertiesSectionWatchWindowOptions	Configuration of the external window generated when opening in a new window the watch list from properties section of the widget. Options allow to define the initial size and position of the window. Both of this aspect can still be interacted with, like a normal window, once the window is opened. Size is composed of a width and height property (both expressed as pixels) and position can be defined by combining the left, top, right and bottom (all expressed as pixels) properties. Default value is [{“position”:{“left”:200,”top”:200},”size”:{“height”:500,”width”:500}}]
	default	position	left	200
			top	200
		size	height	500
			width	500
	WidgetWindowOptions
propertiesSectionWindowOptions	Configuration of the external window generated when opening in a new window the properties section of the widget. Options allow to define the initial size and position of the window. Both of this aspect can still be interacted with, like a normal window, once the window is opened. Size is composed of a width and height property (both expressed as pixels) and position can be defined by combining the left, top, right and bottom (all expressed as pixels) properties. Default value is [{“position”:{“left”:200,”top”:200},”size”:{“height”:500,”width”:500}}]
	default	position	left	200
			top	200
		size	height	500
			width	500
	WidgetWindowOptions
propertyForDisplay	If set, the value of the property referenced by this field (if present) is used to display the device in the list. For example, if the property ‘name’ exist and contains ‘example’, the device will be listed as ‘example’.
	type	string
type	Protocol to interact with to retrieve and communicate with the devices (default is BACNET). Default value is [“BACNET”]
	type	string
	enum	BACNET
	default	BACNET
watchListLoadIntervalMs	Define an interval (in ms) between each update of the properties present in the watch list. Default value is [5000]
	type	integer
	minimum	0
	default	5000
additionalProperties	False

Form

FormWidget

FormWidget
type	object
properties
type	type	string
	enum	Form
	default	Form
formWidgetSettings	Form widget settings
	dashboard.view.json-schema#/definitions/FormWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

FormWidgetSettings

type	object
properties
form	Form reference
	type	string
options	Form widget options Default value is [{“useDefault”:true}]
	default	useDefault	True
	FormOptions
toolbar	Toolbar settings.
	Toolbar
additionalProperties	False

Gauge

GaugeWidget

Gauge
type	object
properties
type	type	string
	enum	Gauge
	default	Gauge
gaugeWidgetSettings	Gauge widget settings
	oneOf	Tachometer
		Rounded
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

Tachometer

Tachometer
type	object
properties
type	type	string
	enum	Tachometer
	default	Tachometer
animateNeedle	Enable (true) or Disable (false) the animation for the needle Default value is [false]
	type	boolean
	default	False
backgroundColor	Widget background color. Default value is [“#424242”]
	default	#424242
colors	Colors that compose the gauge. Define two colors to create an automatic gradient or define one color for each bloc of the gauge. Default value is [[“#00FF00”,”#FF0000”]]
	type	array
	default	#00FF00
		#FF0000
	items
interval	Size of each bloc of the gauge used to determined how many blocs (divising max-min by interval). Division must return a positive natural number. Default value is [5]
	type	integer
	default	5
label	Gauge label display either at top or bottom of the widget.
	oneOf	type	string
		type	boolean
labelPercent	Gauge label text height percentage. Default value is [15]
	type	integer
	maximum	100
	minimum	0
	default	15
labelPosition	Gauge label position. Default value is [“TOP”]
	type	string
	enum	TOP, BOTTOM
	default	TOP
max	Maximum value displayed by the gauge. Default value is [100]
	type	integer
	default	100
min	Minimum value displayed by the gauge. Default value is [0]
	type	integer
	default	0
needleBaseColor	Color of the needle base gauge.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
needleColor	Color of the needle gauge.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
reference	Value to display using the gauge.
	type	string
text	Sprintf.js text formatting. Default value is [“%d%%”]
	type	string
	default	%d%%
valueSize	Value size. It supports CSS dimension properties (pixels, em, vh, …).
	type	string
additionalProperties	False

Rounded

Rounded
type	object
properties
type	type	string
	enum	Rounded
	default	Rounded
backgroundColor	Widget background color. Default value is [“#424242”]
	default	#424242
backgroundPadding	Defines the padding around the widget. Default value is [5]
	type	integer
	default	5
counterClockwise	Whether to display gauge clockwise or counter clockwise. Default value is [false]
	type	boolean
	default	False
emptyColor	Gauge arc empty background color. Default value is [“#d6d6d6”]
	default	#d6d6d6
fillColor	Gauge arc fill background color. Default value is [“#3e98c7”]
	default	#3e98c7
fillRotation	Starting point for the gauge (0 == top, 0.25 == left, 0.5 == bottom, 0.75 == right). Default value is [0.5]
	type	number
	maximum	1
	minimum	0
	default	0.5
icon	Material UI icon to use for the gauge.
	type	string
iconColor	Icon foreground color. Default value is [“#3e98c7”]
	default	#3e98c7
label	Gauge label display either at top or bottom of the widget.
	oneOf	type	string
		type	boolean
labelPercent	Gauge label text height percentage. Default value is [15]
	type	integer
	maximum	100
	minimum	0
	default	15
labelPosition	Gauge label position. Default value is [“TOP”]
	type	string
	enum	TOP, BOTTOM
	default	TOP
max	Maximum value displayed by the gauge. Default value is [100]
	type	integer
	default	100
min	Minimum value displayed by the gauge. Default value is [0]
	type	integer
	default	0
reference	Value to display using the gauge.
	type	string
strokeLinecap	Stroke linecap (arc start/end shape). Default value is [“butt”]
	type	string
	enum	butt, round
	default	butt
strokeWidth	Defines the width of the gauge widget. Default value is [8]
	type	integer
	default	8
text	Sprintf.js text formatting. Default value is [“%d%%”]
	type	string
	default	%d%%
textColor	Text foreground color. Default value is [“#3e98c7”]
	default	#3e98c7
valueSize	Value size. It supports CSS dimension properties (pixels, em, vh, …).
	type	string
additionalProperties	False

Icon

IconWidget

Icon
type	object
properties
type	type	string
	enum	Icon
	default	Icon
iconWidgetSettings	Icon widget value settings
	dashboard.view.json-schema#/definitions/IconWidgetSettings
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

IconWidgetSettings

type	object
properties
backgroundColor	Widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
fontColor	Icon font color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
icon	Icon name.
	type	string
additionalProperties	False

Limit

LimitWidget

Limit
type	object
properties
type	type	string
	enum	Limit
	default	Limit
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
limitWidgetSettings	Limit widget settings
	dashboard.view.json-schema#/definitions/LimitWidgetSettings
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

LimitWidgetSettings

type	object
properties
backgroundColor	Background color
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
defaultLimit	Default limit value. Default value is [100]
	type	integer
	minimum	0
	default	100
defaultLimitFrom	Default limit from value. Get x first values or x last values Default value is [“Last”]
	type	string
	enum	First, Last
	default	Last
disableLimitFrom	Disable limit from selector Default value is [false]
	type	boolean
	default	False
additionalProperties	False

Json

JsonWidget

Json
type	object
properties
type	type	string
	enum	Json
	default	Json
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
jsonWidgetSettings	JSON widget settings
	dashboard.view.json-schema#/definitions/JsonWidgetSettings
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

JsonWidgetSettings

type	object
properties
content	JSON value to display. Any JSON type is accepted (object, array or scalar). Defaults to an empty object. The value can be set at runtime through the widget setJson action.
options	JSON viewer options.
	dashboard.view.json-schema#/definitions/JsonWidgetOptionsSettings
style	Viewer appearance, as a map of CSS variable name to value, applied on top of the current theme. Values declared at the root of the object apply to both light and dark themes, while values declared under the optional light and dark keys only apply to the matching theme mode and take precedence over the root ones. Supported CSS variables are: Global: --w-rjv-font-family, --w-rjv-color, --w-rjv-background-color. Keys: --w-rjv-key-string, --w-rjv-key-number, --w-rjv-quotes-color, --w-rjv-quotes-string-color. Punctuation and structure: --w-rjv-curlybraces-color, --w-rjv-colon-color, --w-rjv-brackets-color, --w-rjv-line-color, --w-rjv-arrow-color, --w-rjv-ellipsis-color, --w-rjv-info-color, --w-rjv-edit-color, --w-rjv-update-color, --w-rjv-copied-color, --w-rjv-copied-success-color. Value types: --w-rjv-type-string-color, --w-rjv-type-int-color, --w-rjv-type-float-color, --w-rjv-type-bigint-color, --w-rjv-type-boolean-color, --w-rjv-type-date-color, --w-rjv-type-url-color, --w-rjv-type-null-color, --w-rjv-type-nan-color, --w-rjv-type-undefined-color. For example: { "--w-rjv-font-family": "monospace", "light": {"--w-rjv-type-string-color": "#1b5e20"}, "dark": {"--w-rjv-type-string-color": "#81c784"} }
additionalProperties	False

JsonWidgetOptionsSettings

type	object
properties
collapsed	When set to true, all nodes will be collapsed by default. Defaults to false.
	type	boolean
displayDataTypes	When set to true, data type labels prefix values. Defaults to false.
	type	boolean
displayObjectSize	When set to true, objects and arrays are labeled with size. Defaults to false.
	type	boolean
enableClipboard	The user can copy objects and arrays to clipboard by clicking on the clipboard icon. Defaults to true.
	type	boolean
highlightUpdates	Whether to highlight updates. Defaults to true.
	type	boolean
indentWidth	Set the indent-width for nested objects. Defaults to 15.
	type	integer
keyName	Define the root node name of the object. Defaults to empty.
	type	string
objectSortKeys	Whether sort keys alphabetically or not. Defaults to false.
	type	boolean
shortenTextAfterLength	Shorten long JSON strings, set to 0 to disable this feature. Defaults to 30.
	type	integer
additionalProperties	False

Journal

JournalWidget

Journal
type	object
properties
type	type	string
	enum	Journal
	default	Journal
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
journalWidgetSettings	Journal widget settings
	oneOf	Timeline
		Table
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

JournalTimelineSettings

Timeline
type	object
properties
type	type	string
	enum	Timeline
	default	Timeline
viewAs	type	string
additionalProperties	False

JournalTableSettings

Table
type	object
properties
type	type	string
	enum	Table
	default	Table
disableSidePanel	Whether or not to show side panel option in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbar	Whether or not to show toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarExport	Whether or not to show export option in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarFilterShowHide	Whether or not to show archive option in toolbar. Default value is [false]
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarSearch	Whether or not to show search option in toolbar. Default value is [true]
	type	boolean
	default	True
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar. Default value is [true]
	type	boolean
	default	True
resizeMode	Define column resize mode: nextColumn, widget (default). Default value is [“widget”]
	type	string
	enum	nextColumn, widget
	default	widget
viewAs	type	string
additionalProperties	False

Maps

MapsWidget

Maps
type	object
properties
type	type	string
	enum	Maps
	default	Maps
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
mapsWidgetSettings	Maps widget settings
	dashboard.view.json-schema#/definitions/MapsWidgetSettings
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

MapsWidgetSettings

type	object
properties
bearing	The camera’s bearing is the visual rotation of the map, measured in degrees counter-clockwise from north, with a range between 0° and 360°. A bearing of 0° orients the map so that north is “up”, 90° orients the map so that east is “up”, and so on. Default value is [0.0]
	type	number
	maximum	360
	minimum	0
	default	0.0
centerPosition	Starting position at the start of the map (for example [7.451123, 46.947456] to center on Bern).
	type	array
	items	type	number
disablePan	Whether to disable or not map panning (move around).
	type	boolean
disableRotate	Whether to disable or not map rotation (pitch and bearing).
	type	boolean
disableUrlHistory	Whether to update url when map state (center, zoom, pitch, bearing and selected floor) change or not, allowing to expand the browser history by pushing a new entry. When disabled, the widget also stops reading these parameters, so a link carrying them opens the map on its configured state. The format is as follows n7,042359;a46,582561;z10,05;b71,2;p48,5 with different parts being. Parts are separated by ;. Decimal value are separated with ,. All parts are optional (you can, for example, set the following: z10,05 which will only set zoom and other parts as default). n: longitude a: latitude z: zoom p: pitch b: bearing Default value is [false]
	type	boolean
	default	False
disableZoom	Whether to disable or not map zoom.
	type	boolean
displayLayersMenu	Whether to display the layers menu (toggling layer visibility and selecting layer filters) on the map. Defaults to true. Default value is [true]
	type	boolean
	default	True
iconPriority	Icon priority order. Should a point match multiple icons, decide which icon to show with icon priority. Default value is [[]]
	type	array
	default
	items	type	string
icons	Icon list which can be loaded by the map widget. All icons used by announced layers must be defined. Default value is [[]]
	type	array
	default
	items	MapImageIcon
layerOptions	The different layers used in this widget.
	type	array
	items	MapsLayerOptions
library	Set which library renders map widget. Available library are: MapBox (default), which uses online tiles with external API key necessary. MapLibre, which support Protomaps self-hosted maps.
	type	string
	enum	Mapbox, MapLibre
mapStyle	Styling for the MapBox maps (for example ‘mapbox://styles/mapbox/dark-v11’ to display the mapbox dark theme).
	MapsStyleOptions
maxBounds	The zone displayed by the map widget. Bounding box with two coordinates points with first element being the southwest most point and the second element being the northeast most point. For example, to add map bounds in Fribourg city, we add the following maxBounds: [[7.097176690737683, 46.77751158309039], [7.1740675580062145, 46.82261507130144]].
	type	array
	items	type	array
		items	type	number
maxPitch	The maximum pitch in degree. See pitch for more information. Default value is [85.0]
	type	number
	maximum	85
	minimum	0
	default	85.0
maxZoom	The maximum zoom level, in Mapbox zoom levels goes from 0-25. 25 means you are really zoomed in. Default value is [25.0]
	type	number
	maximum	25
	minimum	0
	default	25.0
minPitch	The minimum pitch in degree. See pitch for more information. Default value is [0.0]
	type	number
	maximum	85
	minimum	0
	default	0.0
minZoom	The minimum zoom level, zoom levels goes from 0-25. 0 means you are really zoomed out. Default value is [0.0]
	type	number
	maximum	25
	minimum	0
	default	0.0
pitch	The desired pitch in degrees. The pitch is the angle towards the horizon measured in degrees with a range between 0 and 60 degrees. For example, pitch: 0 provides the appearance of looking straight down at the map, while pitch: 60 tilts the user’s perspective towards the horizon. Increasing the pitch value is often used to display 3D objects. Default value is [0.0]
	type	number
	maximum	85
	minimum	0
	default	0.0
protomapSource	Specifies the Protomaps source used when rendering the map widget with MapLibre. The source can be either: An absolute path to a Protomaps archive served by the osp-web resource, or A full HTTPS URL to a remote Protomaps endpoint. Note: The server must support HTTP range requests, as required by the Protomaps protocol.
	type	string
sharedParameters	Shared parameters that can be reused across WMS and WMTS sources by setting their type to Shared. Default value is [[]]
	type	array
	default
	items	WMTSTemplateParameter
wmsSources	The sources of WMS layers you want to add to a map. Default value is [[]]
	type	array
	default
	items	WMSMapSource
wmtsSources	The sources of WMTS layers you want to add to a map. Depending of the WMTS Default value is [[]]
	type	array
	default
	items	WMTSMapSource
zoomLevel	Zoom level at which the map starts (when it will be loaded), zoom levels goes from 0-25.
	type	number
	maximum	25
	minimum	0
additionalProperties	False

Markdown

MarkdownWidget

Markdown
type	object
properties
type	type	string
	enum	Markdown
	default	Markdown
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
markdownWidgetSettings	Markdown widget value settings
	dashboard.view.json-schema#/definitions/MarkdownWidgetSettings
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

MarkdownWidgetSettings

type	object
properties
alignItems	Define how to align items.
	type	string
	enum	CENTER, LEFT, RIGHT
alignText	Define how to align text.
	type	string
	enum	center, justify, start, end
backgroundColor	Widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
fontColor	Text font color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
markdown	Markdown text to interpret.
	type	string
additionalProperties	False

Media player widget

MediaPlayerWidget

Media
type	object
properties
type	type	string
	enum	Media
	default	Media
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
mediaPlayerWidgetSettings	Media widget settings
	dashboard.view.json-schema#/definitions/MediaWidgetSettings
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

MediaPlayerWidgetSettings

type	object
properties
streamSelectorId	The different streams used in this widget.
	type	string
additionalProperties	False

Menu action

MenuActionWidget

MenuAction
type	object
properties
type	type	string
	enum	MenuAction
	default	MenuAction
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuActionWidgetSettings	Menu Actions widget settings
	dashboard.view.json-schema#/definitions/MenuActionWidgetSettings
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

MenuActionWidgetSettings

type	object
properties
backgroundColor	Background color
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
width	Width of the component in percent (0 <= width <= 1) the layout. Default value is [0.2]
	type	number
	maximum	1
	minimum	0
	default	0.2
additionalProperties	False

Navigation

NavigationWidget

Navigation
type	object
properties
type	type	string
	enum	Navigation
	default	Navigation
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
navigationWidgetSettings	Navigation widget settings
	dashboard.view.json-schema#/definitions/NavigationWidgetSettings
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

NavigationWidgetSettings

type	object
properties
backgroundColor	Navigation widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
foregroundColor	Navigation widget foreground color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
icon	Icon for the navigation widget (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
label	Label for the navigation widget.
	type	string
maxFontSize	Maximum font size
	type	integer
minFontSize	Minimum font size
	type	integer
showIcon	Whether to show the navigation widget icon or not Default value is [true]
	type	boolean
	default	True
showLabel	Whether to show the navigation widget label or not Default value is [true]
	type	boolean
	default	True
target	Navigation widget target Default value is [“ROUTER”]
	type	string
	enum	ROUTER, REFRESH, LOGOUT, EXTERNAL, EXTERNAL_NEW
	default	ROUTER
url	URL to which the navigation widget points to.
	type	string
additionalProperties	False

PDF viewer

PdfViewerWidget

PdfViewer
type	object
properties
type	type	string
	enum	PdfViewer
	default	PdfViewer
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
pdfViewerWidgetSettings	Pdf viewer widget settings
	dashboard.view.json-schema#/definitions/PdfViewerWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

PdfViewerWidgetSettings

type	object
properties
content	The PDFViewer widget allows to visualize a pre-existing PDF. The source of the PDF can be feed by multiple means: A Base64 text represent the content of the PDF An external URL, might need the usage of a proxy ↗️ A PDF present in the configuration and defied as a web module resource. Reference the PDF by using the destination path specified in the resources.
	type	string
disableScrollbar	Whether or not to show and enable scrollbars. Default value is [false]
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar. Default value is [false]
	type	boolean
	default	False
display	Display all pdf pages or one by one Default value is [“one”]
	type	string
	enum	all, one
	default	one
windowOptions	Configuration of the external window generated when opening the content of the widget in a new window. Options allow to define the initial size and position of the window. Both of this aspect can still be interacted with, like a normal window, once the window is opened. Size is composed of a width and height property (both expressed as pixels) and position can be defined by combining the left, top, right and bottom (all expressed as pixels) properties. Default value is [{“position”:{“left”:200,”top”:200},”size”:{“height”:500,”width”:500}}]
	default	position	left	200
			top	200
		size	height	500
			width	500
	WidgetWindowOptions
zoom	Initial zoom value of the pdf, between 0 and 1 Default value is [1.0]
	type	number
	maximum	1
	minimum	0
	default	1.0
additionalProperties	False

Range

RangeWidget

RangeWidget
type	object
properties
type	type	string
	enum	Range
	default	Range
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
rangeWidgetSettings	Range widget settings
	dashboard.view.json-schema#/definitions/RangeWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

RangeWidgetSettings

type	object
properties
backgroundColor	Background color
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
defaultRange	Default range value. Must be in ranges. Default value is [{“duration”:{“unit”:”MINUTES”,”value”:5},”text”:”5 min.”}]
	default	duration	unit	MINUTES
			value	5
		text	5 min.
	Range
ranges	Ranges list for selector. Default value is [[{“duration”:{“unit”:”MINUTES”,”value”:5},”text”:”5 min.”},{“duration”:{“unit”:”MINUTES”,”value”:30},”text”:”30 min.”},{“duration”:{“unit”:”HOURS”,”value”:1},”text”:”1 hour”},{“duration”:{“unit”:”HOURS”,”value”:4},”text”:”4 hours”},{“duration”:{“unit”:”DAYS”,”value”:1},”text”:”1 day”}]]
	type	array
	default	duration	unit	MINUTES
			value	5
		text	5 min.
		duration	unit	MINUTES
			value	30
		text	30 min.
		duration	unit	HOURS
			value	1
		text	1 hour
		duration	unit	HOURS
			value	4
		text	4 hours
		duration	unit	DAYS
			value	1
		text	1 day
	items	Range
type	Range type Default value is [“Custom”]
	type	string
	enum	Custom, AggregatePeriod
	default	Custom
additionalProperties	False

Refresh

RefreshWidget

Refresh
type	object
properties
type	type	string
	enum	Refresh
	default	Refresh
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
refreshWidgetSettings	Refresh widget settings
	dashboard.view.json-schema#/definitions/RefreshWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

RefreshWidgetSettings

type	object
properties
backgroundColor	Background color
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
defaultAutoRefresh	Default state of auto refresh. Default value is [false]
	type	boolean
	default	False
defaultAutoRefreshRate	Default rate value as seconds for auto refresh. Default value is [1]
	type	integer
	default	1
disableAutoRefresh	Whether to allow user to toggle auto refresh or not. Default value is [false]
	type	boolean
	default	False
disableAutoRefreshRate	Whether to allow user to change the auto refresh rate or not. Default value is [false]
	type	boolean
	default	False
disableSingleRefresh	Whether to allow user to manually refresh or not. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

Reports list

ReportsListWidget

ReportsList
type	object
properties
type	type	string
	enum	ReportsList
	default	ReportsList
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
reportsListWidgetSettings	ReportsList widget settings
	dashboard.view.json-schema#/definitions/ReportsListWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

ReportsListWidgetSettings

type	object
properties
templateSelect	Filter Report template selector settings
	ReportsTemplate
additionalProperties	False

Reports viewer

ReportsViewerWidget

ReportsViewer
type	object
properties
type	type	string
	enum	ReportsViewer
	default	ReportsViewer
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
reportsViewerWidgetSettings	Report viewer widget settings
	dashboard.view.json-schema#/definitions/ReportsViewerWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

ReportsViewerWidgetSettings

type	object
properties
layout	Define the layout for the list and pdfViewer components
	LayoutArrangement
list	Report list settings.
	ReportsList
pdfViewer	PDF viewer settings.
	PdfViewer
additionalProperties	False

Schematic

SchematicWidget

Schematic
type	object
properties
type	type	string
	enum	Schematic
	default	Schematic
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
schematicWidgetSettings	Schematic widget settings
	dashboard.view.json-schema#/definitions/SchematicWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

SchematicWidgetSettings

type	object
properties
autoFit	Whether fit schematic upon load or not. Default value is [false]
	type	boolean
	default	False
defaultDiagram	Which diagram is shown by default (page).
	type	string
disableLabelAsHtmlDetection	Whether to disable HTML label detection or not. Default value is [false]
	type	boolean
	default	False
disablePan	Whether to disable schematic panning or not. Default value is [false]
	type	boolean
	default	False
disablePaperBackground	Whether to disable paper background or not. Default value is [false]
	type	boolean
	default	False
disableScroll	Whether to disable scroll in schematic or not. Default value is [false]
	type	boolean
	default	False
disableToolbar	Whether to disable toolbar or not. Default value is [false]
	type	boolean
	default	False
disableUrlHistory	Whether to update url when schematic state (page) change or not, allowing to expand the browser history by pushing a new entry. Default value is [false]
	type	boolean
	default	False
schema	Schema resource path loaded by schematic widget.
	oneOf	type	string
		type	object
		properties
		dark	oneOf	type	string
		light	oneOf	type	string
		additionalProperties	False
stylesheet	Stylesheet resource path loaded by schematic widget.
	oneOf	type	string
		type	object
		properties
		dark	oneOf	type	string
		light	oneOf	type	string
		additionalProperties	False
variables	Variables to send to schematic.
zoom	Which zoom method to use. cursor (default): zoom on cursor position, center: zoom always on the center of the view. Default value is [“cursor”]
	type	string
	enum	cursor, center
	default	cursor
additionalProperties	False

Select

SelectWidget

Select
type	object
properties
type	type	string
	enum	Select
	default	Select
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
selectWidgetSettings	Select widget settings
	oneOf	CustomSelect
		AnalyticsMeasure
		AnalyticsField
		FormSelect
		ReportsTemplate
		AnalyticsAggregateSelect
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

CustomSelect

CustomSelect
type	object
properties
type	type	string
	enum	Custom
	default	Custom
defaultOptions	Select default option.
	type	array
	items	type	string
disabled	Disable select
	type	boolean
icon	Select icon.
	type	string
limitTags	Number max of tags displayed. Default value is [2]
	type	integer
	default	2
multiple	Allow multiple selections. Default value is [true]
	type	boolean
	default	True
options	Select available options.
	type	array
	items	type	string
additionalProperties	False

AnalyticsMeasureSelect

AnalyticsMeasure
type	object
properties
type	type	string
	enum	AnalyticsMeasure
	default	AnalyticsMeasure
defaultOptions	Select default option.
	type	array
	items	type	string
disabled	Disable select
	type	boolean
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon. Default value is [“device_hub”]
	type	string
	default	device_hub
includeOptions	List of options to include from base options.
	type	array
	items	type	string
limitTags	Number max of tags displayed. Default value is [2]
	type	integer
	default	2
multiple	Allow multiple selections. Default value is [true]
	type	boolean
	default	True
additionalProperties	False

AnalyticsFieldSelect

AnalyticsField
type	object
properties
type	type	string
	enum	AnalyticsField
	default	AnalyticsField
defaultOptions	Select default option.
	type	array
	items	type	string
disabled	Disable select
	type	boolean
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon. Default value is [“timeline”]
	type	string
	default	timeline
includeOptions	List of options to include from base options.
	type	array
	items	type	string
limitTags	Number max of tags displayed. Default value is [2]
	type	integer
	default	2
multiple	Allow multiple selections. Default value is [true]
	type	boolean
	default	True
additionalProperties	False

FormSelect

FormSelect
type	object
properties
type	type	string
	enum	Form
	default	Form
defaultOption	Select default option.
	type	string
disabled	Disable select
	type	boolean
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon. Default value is [“code”]
	type	string
	default	code
includeOptions	List of options to include from base options.
	type	array
	items	type	string
additionalProperties	False

ReportTemplateSelect

ReportsTemplate
type	object
properties
type	type	string
	enum	ReportsTemplate
	default	ReportsTemplate
defaultOptions	Select default option.
	type	array
	items	type	string
disabled	Disable select
	type	boolean
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon. Default value is [“picture_as_pdf”]
	type	string
	default	picture_as_pdf
includeOptions	List of options to include from base options.
	type	array
	items	type	string
limitTags	Number max of tags displayed. Default value is [2]
	type	integer
	default	2
multiple	Allow multiple selections. Default value is [true]
	type	boolean
	default	True
additionalProperties	False

AnalyticsAggregateSelect

AnalyticsAggregateSelect
type	object
properties
type	type	string
	enum	AnalyticsAggregate
	default	AnalyticsAggregate
defaultOption	Select default option. Default value is [“mean”]
	type	string
	enum	count, integral, last, mean, median, min, max
	default	mean
disabled	Disable select
	type	boolean
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
		enum	count, integral, last, mean, median, min, max
icon	Select icon. Default value is [“functions”]
	type	string
	default	functions
includeOptions	List of options to include from base options.
	type	array
	items	type	string
		enum	count, integral, last, mean, median, min, max
additionalProperties	False

Text

TextWidget

Text
type	object
properties
type	type	string
	enum	Text
	default	Text
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
textWidgetSettings	Text widget settings
	dashboard.view.json-schema#/definitions/TextWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

TextWidgetSettings

type	object
properties
backgroundColor	Widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
fontColor	Text font color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
text	Text.
	type	string
additionalProperties	False

Toolbar

ToolbarWidget

Toolbar
type	object
properties
type	type	string
	enum	Toolbar
	default	Toolbar
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
toolbarWidgetSettings	Chart widget settings
	oneOf	CustomToolbar
		ChartToolbar
		FormToolbar
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

CustomToolbar

CustomToolbar
type	object
properties
type	type	string
	enum	Custom
	default	Custom
centerComponent	Center component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
layout	Define the width of the different components.
	ToolbarLayoutArrangement
leftComponent	Left component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
position	Toolbar position. Default value is [“Top”]
	type	string
	enum	Top, Bottom
	default	Top
rightComponent	Right component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		CollectionTable
		Discovery
		FormWidget
		Gauge
		Icon
		Json
		Journal
		Limit
		Maps
		Markdown
		Media
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
additionalProperties	False

ChartToolbar

ChartToolbar
type	object
properties
type	type	string
	enum	Chart
	default	Chart
aggregateSettings	Aggregate widget settings.
	dashboard.view.json-schema#/definitions/AnalyticsAggregateWidgetSettings
displayAggregate	Display Aggregate widget. Default value is [true]
	type	boolean
	default	True
displayField	Display Field select widget. Default value is [true]
	type	boolean
	default	True
displayMeasure	Display Measure select widget. Default value is [true]
	type	boolean
	default	True
displayRange	Display Range widget. Default value is [true]
	type	boolean
	default	True
displayRefresh	Display Refresh widget. Default value is [true]
	type	boolean
	default	True
fieldSettings	Field Select widget settings. Default value is [{“type”:”AnalyticsField”,”icon”:”timeline”,”limitTags”:2,”multiple”:true}]
	default	type	AnalyticsField
		icon	timeline
		limitTags	2
		multiple	True
	AnalyticsField
measureSettings	Measure Select widget settings. Default value is [{“type”:”AnalyticsMeasure”,”icon”:”device_hub”,”limitTags”:2,”multiple”:true}]
	default	type	AnalyticsMeasure
		icon	device_hub
		limitTags	2
		multiple	True
	AnalyticsMeasure
position	Toolbar position. Default value is [“Top”]
	type	string
	enum	Top, Bottom
	default	Top
rangeSettings	Range widget settings. Default value is [{“defaultRange”:{“duration”:{“unit”:”MINUTES”,”value”:5},”text”:”5 min.”},”ranges”:[{“duration”:{“unit”:”MINUTES”,”value”:5},”text”:”5 min.”},{“duration”:{“unit”:”MINUTES”,”value”:30},”text”:”30 min.”},{“duration”:{“unit”:”HOURS”,”value”:1},”text”:”1 hour”},{“duration”:{“unit”:”HOURS”,”value”:4},”text”:”4 hours”},{“duration”:{“unit”:”DAYS”,”value”:1},”text”:”1 day”}],”type”:”Custom”}]
	default	defaultRange	duration	unit	MINUTES
				value	5
			text	5 min.
		ranges	duration	unit	MINUTES
				value	5
			text	5 min.
			duration	unit	MINUTES
				value	30
			text	30 min.
			duration	unit	HOURS
				value	1
			text	1 hour
			duration	unit	HOURS
				value	4
			text	4 hours
			duration	unit	DAYS
				value	1
			text	1 day
		type	Custom
	dashboard.view.json-schema#/definitions/RangeWidgetSettings
refreshSettings	Refresh widget settings. Default value is [{“defaultAutoRefresh”:false,”defaultAutoRefreshRate”:1,”disableAutoRefresh”:false,”disableAutoRefreshRate”:false,”disableSingleRefresh”:false}]
	default	defaultAutoRefresh	False
		defaultAutoRefreshRate	1
		disableAutoRefresh	False
		disableAutoRefreshRate	False
		disableSingleRefresh	False
	dashboard.view.json-schema#/definitions/RefreshWidgetSettings
additionalProperties	False

FormToolbar

FormToolbar
type	object
properties
type	type	string
	enum	Form
	default	Form
formSelectSettings	Submit widget settings. Default value is [{“type”:”Form”,”icon”:”code”}]
	default	type	Form
		icon	code
	FormSelect
position	Toolbar position. Default value is [“Top”]
	type	string
	enum	Top, Bottom
	default	Top
submitSettings	Submit widget settings. Default value is [{“disableAlertPreventingClosingIfFormNotSaved”:true,”disableApply”:false,”disableCancel”:false,”disableClose”:false,”disableKeyboardsShortcuts”:true,”disableSaveFeedback”:false,”disableSubmit”:false}]
	default	disableAlertPreventingClosingIfFormNotSaved	True
		disableApply	False
		disableCancel	False
		disableClose	False
		disableKeyboardsShortcuts	True
		disableSaveFeedback	False
		disableSubmit	False
	SubmitWidgetSettings
additionalProperties	False

Value

ValueWidget

Value
type	object
properties
type	type	string
	enum	Value
	default	Value
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
valueWidgetSettings	Icon widget value settings
	dashboard.view.json-schema#/definitions/ValueWidgetSettings
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

ValueWidgetSettings

type	object
properties
backgroundColor	Widget background color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
fontColor	Text font color.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
label	Value label display either at top, bottom, left or right of the widget. Use false to disable it. Use true (or empty string) to fall back to value name.
	oneOf	type	string
		type	boolean
labelBackgroundColor	Label widget background color. If empty will use backgroundColor.
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
labelFontColor	Label widget text color. If empty will use fontColor
	oneOf	type	string
		pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		type	object
		properties
		reference	type	string
		fallback	type	string
			pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
		additionalProperties	False
		type	object
		properties
		dark	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		light	oneOf	type	string
				pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				type	object
				properties
				reference	type	string
				fallback	type	string
					pattern	^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$
				additionalProperties	False
		additionalProperties	False
labelPercent	Value label text height percentage. Default value is [20]
	type	integer
	maximum	100
	minimum	0
	default	20
labelPosition	Value label position. Default value is [“TOP”]
	type	string
	enum	TOP, BOTTOM, LEFT, RIGHT, NONE
	default	TOP
reference	Value to display.
	type	string
text	Format of the value.
	type	string
additionalProperties	False

Value subscription

ValueSubscriptionWidget

ValueSubscriptionWidget
type	object
properties
type	type	string
	enum	ValueSubscription
	default	ValueSubscription
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

Video player

VideoPlayerWidget

VideoPlayer
type	object
properties
type	type	string
	enum	VideoPlayer
	default	VideoPlayer
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
videoWidgetSettings	Video player settings.
	dashboard.view.json-schema#/definitions/VideoPlayerWidgetSettings
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

VideoPlayerWidgetSettings

type	object
properties
disabledVideoControllerLabel	Disabled video label shown to user. If not set, will use default i18n value.
	type	string
videoId	Video ID used to display video feed.
	type	string
additionalProperties	False

Video PTZ controller

PtzControllerWidget

PtzController
type	object
properties
type	type	string
	enum	PtzController
	default	PtzController
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
ptzControllerWidgetSettings	PTZ controller widget settings
	dashboard.view.json-schema#/definitions/PtzControllerWidgetSettings
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

PtzControllerWidgetSettings

type	object
properties
distanceByClick	The movement perform by the PTZ on each click. Default value is [0.02]
	type	number
	default	0.02
panMaxValue	The pan maximal acceptable value. Default value is [100.0]
	type	number
	default	100.0
panMinValue	The pan minimal acceptable value. Default value is [-100.0]
	type	number
	default	-100.0
tiltMaxValue	The tilt maximal acceptable value. Default value is [100.0]
	type	number
	default	100.0
tiltMinValue	The tilt minimal acceptable value. Default value is [0.0]
	type	number
	default	0.0
zoomMaxValue	The maximal acceptable value for the zoom. Default value is [100.0]
	type	number
	default	100.0
zoomMinValue	The minimal acceptable value for the zoom. Default value is [0.0]
	type	number
	default	0.0
additionalProperties	False

Web view

WebViewWidget

WebView
type	object
properties
type	type	string
	enum	WebView
	default	WebView
id	The widget identifier, used to organize grid and internal widget communication.
	type	string
	minLength	1
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
options	Widget options.
	WidgetOptions
title	The widget title
	type	string
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
webViewWidgetSettings	Web View widget settings
	dashboard.view.json-schema#/definitions/WebViewWidgetSettings
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
additionalProperties	False

WebViewWidgetSettings

type	object
properties
filterUrlRegexRules	An array of string patterns interpreted as regular expressions. Each pattern is tested against the iframe’s current URL whenever its DOM updates. If any pattern matches the iframe’s current URL, the iframe automatically redirects back to the initial src provided. You would typically supply filterUrlRegexRules if you want to prevent navigation to certain domains or URL patterns and automatically keep your iframe locked to the initial src. If a filtered URL is detected, the iframe is redirected back to src. For example, when using Grafana, the iframe should not access paths containing /osp/grafana/? so by adding this regex : ^.*/osp/grafana/?.* By default, filterUrlRegexRules is omitted or empty, no filter checks are performed, and the iframe can navigate freely.
	type	array
	items	type	string
source	Source of the iframe, must be a valid URL.
	oneOf	type	string
		type	object
		properties
		dark	oneOf	type	string
		light	oneOf	type	string
		additionalProperties	False
title	Title of the frame.
	type	string
additionalProperties	False