Widgets

AlarmTable

AlarmTableWidget

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

AlarmTableWidgetSettings

type	object
properties
defaultFilter	Which alarm filter to use by default (i.e. root.alarms.filters.all)
	type	string
defaultView	Which alarm view to use by default (i.e. root.alarms.views.default).
	type	string
includeFilters	Alarm table toolbar filters.
	type	array
	items	type	string
excludeFilters	List of filters to exclude from alarm table toolbar filters.
	type	array
	items	type	string
includeViews	Alarm table toolbar views.
	type	array
	items	type	string
excludeViews	List of views to exclude from alarm table toolbar views.
	type	array
	items	type	string
resizeMode	Define column resize mode: nextColumn, widget (default).
	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.
	type	integer
	minimum	0
	default	250
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box)
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box)
	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.
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar.
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar.
	type	boolean
	default	False
enableAutomaticRefresh	Whether to update automatically update table when loaded.
	type	boolean
	default	True
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not.
	type	boolean
	default	False
disableToolbarTableAutoRefresh	Whether to allow user to toggle table auto refresh table or not.
	type	boolean
	default	False
disableToolbarJournal	Whether or not to show journal show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show archive option in toolbar.
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar.
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar.
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar.
	type	boolean
	default	False
iconExportPanel	Override icon to export table content (default save).
	type	string
additionalProperties	False

Alarm history table

AlarmHistoryTableWidget

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

AlarmHistoryTableWidgetSettings

type	object
properties
defaultFilter	Which alarm filter to use by default (i.e. root.alarms.filters.all).
	type	string
defaultView	Which alarm view to use by default (i.e. root.alarms.views.default).
	type	string
includeFilters	Alarm table toolbar filters.
	type	array
	items	type	string
excludeFilters	List of filters to exclude from alarm table toolbar filters.
	type	array
	items	type	string
includeViews	Alarm table toolbar views.
	type	array
	items	type	string
excludeViews	List of views to exclude from alarm table toolbar views.
	type	array
	items	type	string
pageSize	Alarm history table page size (must be present in page sizes).
	type	integer
	minimum	0
	default	50
pageSizes	Alarm history table page sizes.
	type	array
	default	50
		100
		200
	items	type	integer
resizeMode	Define column resize mode: nextColumn, widget (default).
	type	string
	enum	nextColumn, widget
	default	widget
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.
	type	boolean
	default	False
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.
	type	integer
	minimum	0
	default	250
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not.
	type	boolean
	default	False
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box).
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box)
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar.
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar.
	type	boolean
	default	False
disableToolbarJournal	Whether or not to show journal show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarExport	Whether or not to show export option in toolbar.
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show archive option in toolbar.
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar.
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar.
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar.
	type	boolean
	default	False
iconExportPanel	Override icon to export table content (default save).
	type	string
additionalProperties	False

Alarm severity

AlarmSeverityWidget

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

AlarmSeverityWidgetSettings

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

Analytics aggregate

AnalyticsAggregateWidget

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

AnalyticsAggregateWidgetSettings

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

Basic input output value

BasicInputOutputValueWidget

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

BasicInputOutputValueWidgetSettings

type	object
properties
label	Widget label shown at the top of the widget.
	type	string
showLabel	Whether to show label at the top of the widget or not.
	type	boolean
	default	True
tooltip	Widget tooltip when hovering the widget.
	type	string
showTooltip	Whether to show tooltip when hovering the widget or not.
	type	boolean
	default	True
icon	Icon shown in the middle of the widget (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
showIcon	Whether to show icon in the middle of the widget or not.
	type	boolean
	default	True
showValue	Whether to show value at the bottom of the widget or not.
	type	boolean
	default	True
onClick	Widget onClick listener evaluating expression.
	type	string
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
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
variableText	sprintf expression evaluated with text type content.
	type	string
unknownValue	Default value used for numeric and boolean value which content is unknown.
maxValue	Maximum value for numeric value (both display and action).
minValue	Minimum value for numeric value (both display and action).
onValue	Activated content matching for text type.
offValue	Deactivated content matching for text type.
onValueText	Activated displayed value when matching activated content for text type.
	type	string
offValueText	Deactivated displayed value when matching deactivated content for text type.
	type	string
unknownValueText	Displayed text when value is unknown.
	type	string
unknownIcon	Displayed icon when value is unknown (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
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
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
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
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
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
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
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
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
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
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
valueStep	Increase/decrease step value for numeric type.
	type	integer
textInputLabel	Label for text type value.
	type	string
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
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
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
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
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
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
additionalProperties	False

Border layout

BorderLayoutWidget

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

BorderLayoutWidgetSettings

type	object
properties
northComponent	North component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		ChartWidget
		CollectionTable
		FormWidget
		FormWidget
		Gauge
		Icon
		Journal
		Limit
		Maps
		Markdown
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
southComponent	South component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		ChartWidget
		CollectionTable
		FormWidget
		FormWidget
		Gauge
		Icon
		Journal
		Limit
		Maps
		Markdown
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
centerComponent	Center component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		ChartWidget
		CollectionTable
		FormWidget
		FormWidget
		Gauge
		Icon
		Journal
		Limit
		Maps
		Markdown
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
eastComponent	East component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		ChartWidget
		CollectionTable
		FormWidget
		FormWidget
		Gauge
		Icon
		Journal
		Limit
		Maps
		Markdown
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
westComponent	West component of the layout.
	oneOf	AlarmHistoryTable
		AlarmSeverity
		AlarmTable
		AnalyticsAggregateWidget
		AnalyticsAggregateWidget
		BasicInputOutputValue
		BorderLayout
		BoxLayout
		ChartWidget
		ChartWidget
		CollectionTable
		FormWidget
		FormWidget
		Gauge
		Icon
		Journal
		Limit
		Maps
		Markdown
		MenuAction
		Navigation
		ObjectBrowser
		PdfViewer
		PtzController
		RangeWidget
		RangeWidget
		Refresh
		ReportsList
		ReportsViewer
		Schematic
		Select
		Text
		Toolbar
		ValueSubscriptionWidget
		ValueSubscriptionWidget
		Value
		VideoPlayer
		WebView
layout	Define the width and height of the different components.
	BorderLayoutArrangement
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
additionalProperties	False

Box layout

BoxLayoutWidget

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

BoxLayoutWidgetSettings

type	object
properties
components	List of components to display in this box
	type	array
	items	BoxLayoutComponent
orientation	Orientation of the box
	type	string
	enum	Horizontal, Vertical
	default	Vertical
additionalProperties	False

Chart

ChartWidget

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

ChartWidgetSettings

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

Collection table

CollectionTable

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

CollectionTableSettings

type	object
properties
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
defaultFilter	Which schema filter to use by default (i.e. filter-id).
	type	string
includeSchemas	Schema table toolbar filters.
	type	array
	items	type	string
excludeSchemas	List of schemas to exclude from table toolbar filters.
	type	array
	items	type	string
includeViews	List of views to include from table toolbar views.
	type	array
	items	type	string
excludeViews	List of views to exclude from table toolbar views.
	type	array
	items	type	string
includeFilters	List of filters to include from table toolbar views.
	type	array
	items	type	string
excludeFilters	List of filters to exclude from table toolbar views.
	type	array
	items	type	string
includeForms	List of forms to include in form toolbar view.
	type	array
	items	type	string
excludeForms	List of forms to exclude in form toolbar view.
	type	array
	items	type	string
multiple	If set to true, data can be gathered from multiple collections and are merged together
	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.
	type	boolean
	default	False
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.
	type	integer
	minimum	0
	default	250
disableDisplayTypes	List of display types to disable for table toolbar.
	type	array
	default
	items	type	string
		enum	table, form
defaultDisplayType	Default display type to apply upon collection table being loaded.
	type	string
	enum	table, form
	default	table
defaultForm	Default form to apply upon form table being loaded.
	type	string
disableFormPicker	Disable form picker in form view.
	type	boolean
	default	False
disableFormCreate	Disable form creation for collection table.
	type	boolean
	default	False
disableFormEdit	Disable form edition for collection table.
	type	boolean
	default	False
disableFormHistory	Disable form history for collection table.
	type	boolean
	default	False
pageSize	Collection table page size (must be present in page sizes).
	type	integer
	minimum	0
	default	50
pageSizes	Collection table page sizes.
	type	array
	default	50
		100
		200
	items	type	integer
resizeMode	Define column resize mode: nextColumn, widget (default).
	type	string
	enum	nextColumn, widget
	default	widget
disableToolbarTableRefresh	Whether to allow user to manually refresh table or not.
	type	boolean
	default	False
disableSchemaUpdate	Whether to allow user to update filter or not (will show/hide the combo box).
	type	boolean
	default	False
disableViewUpdate	Whether to allow user to update view or not (will show/hide the combo box).
	type	boolean
	default	False
disableFilterUpdate	Whether to allow user to update filter or not (will show/hide the combo box).
	type	boolean
	default	False
disableToolbar	Whether or not to show toolbar.
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar.
	type	boolean
	default	False
disableSidePanel	Whether or not to show side panel option in toolbar.
	type	boolean
	default	False
disableToolbarExport	Whether or not to show export option in toolbar.
	type	boolean
	default	False
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarFilterShowHide	Whether or not to show archive option in toolbar.
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar.
	type	boolean
	default	False
disableToolbarSearch	Whether or not to show search option in toolbar.
	type	boolean
	default	False
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar.
	type	boolean
	default	False
disableToolbarClearFilter	Whether or not to show clear filter in toolbar.
	type	boolean
	default	False
iconExportPanel	Override icon to export table content (default save).
	type	string
iconTableView	Override icon to show table view (default table_rows).
	type	string
iconFormView	Override icon to show form view (default feed).
	type	string
iconCreateEntry	Override icon to create collection entry (default post_add).
	type	string
iconCancelCreateEntry	Override icon to cancel collection entry creation (default clear).
	type	string
iconEditEntry	Override icon to edit collection entry (default edit).
	type	string
iconRefreshTable	Override icon to refresh collection table (default refresh).
	type	string
iconSidePanel	Override icon to show side panel (default import_contacts).
	type	string
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
submitSettings	Form submit widget settings
	SubmitWidgetSettings
additionalProperties	False

Form

FormWidget

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

FormWidgetSettings

type	object
properties
form	Form reference
	type	string
options	Form widget options
	default	useDefault	True
	FormOptions
toolbar	Toolbar settings.
	Toolbar
additionalProperties	False

Gauge

GaugeWidget

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

Tachometer

Tachometer
type	object
properties
type	type	string
	enum	Tachometer
	default	Tachometer
reference	Value to display using the gauge.
	type	string
min	Minimum value displayed by the gauge.
	type	integer
	default	0
max	Maximum value displayed by the gauge.
	type	integer
	default	100
text	Sprintf.js text formatting.
	type	string
	default	%d%%
label	Gauge label display either at top or bottom of the widget.
	oneOf	type	string
		type	boolean
labelPosition	Gauge label position.
	type	string
	enum	TOP, BOTTOM
	default	TOP
labelPercent	Gauge label text height percentage.
	type	integer
	maximum	100
	minimum	0
	default	15
backgroundColor	Widget background color.
	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.
	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.
	type	integer
	default	5
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
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
animateNeedle	Enable (true) or Disable (false) the animation for the needle
	type	boolean
	default	False
additionalProperties	False

Rounded

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

Icon

IconWidget

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

IconWidgetSettings

type	object
properties
icon	Icon name.
	type	string
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
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
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
limitWidgetSettings	Limit widget settings
	dashboard.view.json-schema#/definitions/LimitWidgetSettings
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.
	type	integer
	minimum	0
	default	100
defaultLimitFrom	Default limit from value. Get x first values or x last values
	type	string
	enum	First, Last
	default	Last
disableLimitFrom	Disable limit from selector
	type	boolean
	default	False
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
journalWidgetSettings	Journal widget settings
	oneOf	Timeline
		Table
additionalProperties	False

JournalTimelineSettings

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

JournalTimelineSettings

Table
type	object
properties
type	type	string
	enum	Table
	default	Table
viewAs	type	string
disableToolbar	Whether or not to show toolbar.
	type	boolean
	default	False
disableToolbarMenu	Whether or not to show menu toolbar.
	type	boolean
	default	True
disableSidePanel	Whether or not to show side panel option in toolbar.
	type	boolean
	default	True
disableToolbarExport	Whether or not to show export option in toolbar.
	type	boolean
	default	True
disableToolbarColumnShowHide	Whether or not to show column show/hide option in toolbar.
	type	boolean
	default	True
disableToolbarFilterShowHide	Whether or not to show archive option in toolbar.
	type	boolean
	default	False
disableToolbarSummaryShowHide	Whether or not to show summary show/hide option in toolbar.
	type	boolean
	default	True
disableToolbarSearch	Whether or not to show search option in toolbar.
	type	boolean
	default	True
disableToolbarColumnChooser	Whether or not to show column chooser in toolbar.
	type	boolean
	default	True
disableToolbarClearFilter	Whether or not to show clear filter in toolbar.
	type	boolean
	default	True
resizeMode	Define column resize mode: nextColumn, widget (default).
	type	string
	enum	nextColumn, widget
	default	widget
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
mapsWidgetSettings	Maps widget settings
	dashboard.view.json-schema#/definitions/MapsWidgetSettings
additionalProperties	False

MapsWidgetSettings

type	object
properties
layerOptions	The different layers used in this widget.
	type	array
	items	MapsLayerOptions
mapStyle	Styling for the MapBox maps (for example ‘mapbox://styles/mapbox/dark-v11’ to display the mapbox dark theme).
	MapStyleOptions
centerPosition	Starting position at the start of the map (for example [7.451123, 46.947456] to center on Bern).
	type	array
	items	type	number
zoomLevel	Zoom level at which the map starts (when it will be loaded), zoom levels goes from 0-25.
	type	integer
	maximum	25
	minimum	0
maxZoom	The maximum zoom level, in Mapbox zoom levels goes from 0-25. 25 means you are really zoomed in.
	type	integer
	maximum	25
	minimum	0
	default	25
minZoom	The minimum zoom level, zoom levels goes from 0-25. 0 means you are really zoomed out.
	type	integer
	maximum	25
	minimum	0
	default	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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
markdownWidgetSettings	Markdown widget value settings
	dashboard.view.json-schema#/definitions/MarkdownWidgetSettings
additionalProperties	False

MarkdownWidgetSettings

type	object
properties
markdown	Markdown text to interpret.
	type	string
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
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
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
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
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
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.
	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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
navigationWidgetSettings	Navigation widget settings
	dashboard.view.json-schema#/definitions/NavigationWidgetSettings
additionalProperties	False

NavigationWidgetSettings

type	object
properties
url	URL to which the navigation widget points to.
	type	string
label	Label for the navigation widget.
	type	string
icon	Icon for the navigation widget (https://material-ui.com/components/material-icons/) with naming in snake_case.
	type	string
showLabel	Whether to show the navigation widget label or not
	type	boolean
	default	True
showIcon	Whether to show the navigation widget icon or not
	type	boolean
	default	True
minFontSize	Minimum font size
	type	integer
maxFontSize	Maximum font size
	type	integer
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
target	Navigation widget target
	type	string
	enum	ROUTER, REFRESH, LOGOUT, EXTERNAL, EXTERNAL_NEW
	default	ROUTER
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
pdfViewerWidgetSettings	Pdf viewer widget settings
	dashboard.view.json-schema#/definitions/PdfViewerWidgetSettings
additionalProperties	False

PdfViewerWidgetSettings

type	object
properties
content	Pdf content
	type	string
display	Display all pdf pages or one by one
	type	string
	enum	all, one
	default	one
zoom	Initial zoom value of the pdf, between 0 and 1
	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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
rangeWidgetSettings	Range widget settings
	dashboard.view.json-schema#/definitions/RangeWidgetSettings
additionalProperties	False

RangeWidgetSettings

type	object
properties
type	Range type
	type	string
	enum	Custom, AggregatePeriod
	default	Custom
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	text	5 min.
		duration	value	5
			unit	MINUTES
	Range
ranges	Ranges list for selector.
	type	array
	default	text	5 min.
		duration	value	5
			unit	MINUTES
		text	30 min.
		duration	value	30
			unit	MINUTES
		text	1 hour
		duration	value	1
			unit	HOURS
		text	4 hours
		duration	value	4
			unit	HOURS
		text	1 day
		duration	value	1
			unit	DAYS
	items	Range
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
refreshWidgetSettings	Refresh widget settings
	dashboard.view.json-schema#/definitions/RefreshWidgetSettings
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
disableSingleRefresh	Whether to allow user to manually refresh or not.
	type	boolean
	default	False
disableAutoRefresh	Whether to allow user to toggle auto refresh or not.
	type	boolean
	default	False
defaultAutoRefresh	Default state of auto refresh.
	type	boolean
	default	False
disableAutoRefreshRate	Whether to allow user to change the auto refresh rate or not.
	type	boolean
	default	False
defaultAutoRefreshRate	Default rate value as seconds for auto refresh.
	type	integer
	default	1
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
reportsListWidgetSettings	ReportsList widget settings
	dashboard.view.json-schema#/definitions/ReportsListWidgetSettings
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
reportsViewerWidgetSettings	Report viewer widget settings
	dashboard.view.json-schema#/definitions/ReportsViewerWidgetSettings
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
schematicWidgetSettings	Schematic widget settings
	dashboard.view.json-schema#/definitions/SchematicWidgetSettings
additionalProperties	False

SchematicWidgetSettings

type	object
properties
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
defaultDiagram	Which diagram is shown by default (page).
	type	string
zoom	Which zoom method to use. cursor (default): zoom on cursor position, center: zoom always on the center of the view.
	type	string
	enum	cursor, center
	default	cursor
disableToolbar	Whether to disable toolbar or not.
	type	boolean
	default	False
disablePaperBackground	Whether to disable paper background or not.
	type	boolean
	default	False
autoFit	Whether fit schematic upon load or not.
	type	boolean
	default	False
disableScroll	Whether to disable scroll in schematic or not.
	type	boolean
	default	False
disablePan	Whether to disable schematic panning or not.
	type	boolean
	default	False
disableLabelAsHtmlDetection	Whether to disable HTML label detection or not.
	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.
	type	boolean
	default	False
variables	Variables to send to schematic.
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
selectWidgetSettings	Select widget settings
	oneOf	CustomSelect
		CustomSelect
		AnalyticsMeasure
		AnalyticsField
		FormSelect
		FormSelect
		ReportsTemplate
		AnalyticsAggregateSelect
		AnalyticsAggregateSelect
additionalProperties	False

CustomSelect

CustomSelect
type	object
properties
type	type	string
	enum	Custom
	default	Custom
defaultOptions	Select default option.
	type	array
	items	type	string
options	Select available options.
	type	array
	items	type	string
icon	Select icon.
	type	string
multiple	Allow multiple selections.
	type	boolean
	default	True
limitTags	Number max of tags displayed.
	type	integer
	default	2
additionalProperties	False

AnalyticsMeasureSelect

AnalyticsMeasure
type	object
properties
type	type	string
	enum	AnalyticsMeasure
	default	AnalyticsMeasure
defaultOptions	Select default option.
	type	array
	items	type	string
includeOptions	List of options to include from base options.
	type	array
	items	type	string
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon.
	type	string
	default	device_hub
multiple	Allow multiple selections.
	type	boolean
	default	True
limitTags	Number max of tags displayed.
	type	integer
	default	2
additionalProperties	False

AnalyticsFieldSelect

AnalyticsField
type	object
properties
type	type	string
	enum	AnalyticsField
	default	AnalyticsField
defaultOptions	Select default option.
	type	array
	items	type	string
includeOptions	List of options to include from base options.
	type	array
	items	type	string
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon.
	type	string
	default	timeline
multiple	Allow multiple selections.
	type	boolean
	default	True
limitTags	Number max of tags displayed.
	type	integer
	default	2
additionalProperties	False

FormSelect

FormSelect
type	object
properties
type	type	string
	enum	Form
	default	Form
defaultOption	Select default option.
	type	string
includeOptions	List of options to include from base options.
	type	array
	items	type	string
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon.
	type	string
	default	code
additionalProperties	False

ReportTemplateSelect

ReportsTemplate
type	object
properties
type	type	string
	enum	ReportsTemplate
	default	ReportsTemplate
defaultOptions	Select default option.
	type	array
	items	type	string
includeOptions	List of options to include from base options.
	type	array
	items	type	string
excludeOptions	List of options to exclude from base options.
	type	array
	items	type	string
icon	Select icon.
	type	string
	default	picture_as_pdf
multiple	Allow multiple selections.
	type	boolean
	default	True
limitTags	Number max of tags displayed.
	type	integer
	default	2
additionalProperties	False

AnalyticsAggregateSelect

AnalyticsAggregateSelect
type	object
properties
type	type	string
	enum	AnalyticsAggregate
	default	AnalyticsAggregate
defaultOption	Select default option.
	type	string
	enum	count, integral, last, mean, median, min, max
	default	mean
icon	Select icon.
	type	string
	default	functions
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
textWidgetSettings	Text widget settings
	dashboard.view.json-schema#/definitions/TextWidgetSettings
additionalProperties	False

TextWidgetSettings

type	object
properties
text	Text.
	type	string
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
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
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
toolbarWidgetSettings	Chart widget settings
	oneOf	CustomToolbar
		CustomToolbar
		ChartToolbar
		ChartToolbar
		FormToolbar
		FormToolbar
additionalProperties	False

CustomToolbar

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

ChartToolbar

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

FormToolbar

FormToolbar
type	object
properties
type	type	string
	enum	Form
	default	Form
position	Toolbar position.
	type	string
	enum	Top, Bottom
	default	Top
submitSettings	Submit widget settings.
	default	disableSubmit	False
		disableApply	False
		disableSaveFeedback	False
		disableCancel	False
		disableClose	False
	SubmitWidgetSettings
formSelectSettings	Submit widget settings.
	default	type	Form
		icon	code
	FormSelect
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
valueWidgetSettings	Icon widget value settings
	dashboard.view.json-schema#/definitions/ValueWidgetSettings
additionalProperties	False

ValueWidgetSettings

type	object
properties
text	Format of the value.
	type	string
reference	Value to display.
	type	string
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
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
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
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
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
labelPosition	Value label position.
	type	string
	enum	TOP, BOTTOM, LEFT, RIGHT, NONE
	default	TOP
labelPercent	Value label text height percentage.
	type	integer
	maximum	100
	minimum	0
	default	20
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
videoWidgetSettings	Video player settings.
	dashboard.view.json-schema#/definitions/VideoPlayerWidgetSettings
additionalProperties	False

VideoPlayerWidgetSettings

type	object
properties
videoId	Video ID used to display video feed.
	type	string
disabledVideoControllerLabel	Disabled video label shown to user. If not set, will use default i18n value.
	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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
ptzControllerWidgetSettings	PTZ controller widget settings
	dashboard.view.json-schema#/definitions/PtzControllerWidgetSettings
additionalProperties	False

PtzControllerWidgetSettings

type	object
properties
distanceByClick	The movement perform by the PTZ on each click.
	type	number
	default	0.02
zoomMinValue	The minimal acceptable value for the zoom.
	type	number
	default	0.0
zoomMaxValue	The maximal acceptable value for the zoom.
	type	number
	default	100.0
panMinValue	The pan minimal acceptable value.
	type	number
	default	-100.0
panMaxValue	The pan maximal acceptable value.
	type	number
	default	100.0
tiltMinValue	The tilt minimal acceptable value.
	type	number
	default	0.0
tiltMaxValue	The tilt maximal acceptable value.
	type	number
	default	100.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
title	The widget title
	type	string
options	Widget options.
	WidgetOptions
valueSubscriptions	The data value subscriptions for given widget.
	ValueSubscriptions
widgetSubscriptions	List of widget’s Ids to subscribe to.
	type	array
	items	type	string
menuReferences	The menu applied to the given widget.
	type	array
	items	type	string
maxMenuHeight	Limit menu height in pixel with overflowing menu displayed with scrollbars
	type	integer
	minimum	0
webViewWidgetSettings	Web View widget settings
	dashboard.view.json-schema#/definitions/WebViewWidgetSettings
additionalProperties	False

WebViewWidgetSettings

type	object
properties
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