dashboard.view¶
Dashboard view¶
type |
object |
||
properties |
|||
|
The id of the template to use for this file |
||
type |
string |
||
|
The variables and their values to be replaced from the template |
||
type |
object |
||
additionalProperties |
|||
|
The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files. |
||
type |
array |
||
items |
type |
string |
|
|
If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation. |
||
type |
boolean |
||
|
type |
string |
|
|
|||
|
type |
array |
|
items |
type |
string |
|
|
Widgets configuration |
||
type |
array |
||
default |
|||
items |
oneOf |
||
AnalyticsAggregateWidget |
|||
ChartWidget |
|||
FormWidget |
|||
RangeWidget |
|||
ValueSubscriptionWidget |
|||
|
Layouts for different sizes |
||
|
Breakpoints for different sizes |
||
|
Columns per layout for different sizes |
||
|
Row height for dashboard. It allows the widget sizing to be smaller or bigger based on needs. |
||
type |
integer |
||
minimum |
1 |
||
default |
150 |
||
|
|||
additionalProperties |
False |
AlarmHistoryTable¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AlarmHistoryTable |
||
default |
AlarmHistoryTable |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Alarm history widget settings |
||
additionalProperties |
False |
WidgetOptions¶
type |
object |
|
properties |
||
|
Buffer value update from front-end to components. |
|
|
Save user preferences as specified. |
|
type |
string |
|
enum |
NONE, LOCAL_STORAGE |
|
default |
LOCAL_STORAGE |
|
additionalProperties |
False |
BufferOption¶
type |
object |
|
properties |
||
|
Whether the buffer is active or not. |
|
type |
boolean |
|
default |
True |
|
|
Buffer interval in milliseconds. |
|
type |
integer |
|
minimum |
0 |
|
default |
1000 |
|
additionalProperties |
False |
ValueSubscriptions¶
type |
object |
|
properties |
||
|
Value subscription for widget. |
|
type |
array |
|
items |
||
additionalProperties |
False |
ValueSubscription¶
type |
object |
|
properties |
||
|
Subscription value ID. |
|
type |
string |
|
|
Value type for value ID. |
|
type |
string |
|
enum |
BOOLEAN, INTEGER, DECIMAL, TEXT |
|
|
Value subscription for value ID. |
|
type |
string |
|
enum |
READ, WRITE, READ_WRITE |
|
additionalProperties |
False |
AlarmHistoryTableWidgetSettings¶
type |
object |
||
properties |
|||
|
Which alarm filter to use by default (i.e. root.alarms.filters.all). |
||
type |
string |
||
|
Which alarm view to use by default (i.e. root.alarms.views.default). |
||
type |
string |
||
|
Alarm table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
List of filters to exclude from alarm table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
Alarm table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of views to exclude from alarm table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
Alarm history table page size (must be present in page sizes). |
||
type |
integer |
||
minimum |
0 |
||
default |
50 |
||
|
Alarm history table page sizes. |
||
type |
array |
||
default |
50 |
||
100 |
|||
200 |
|||
items |
type |
integer |
|
|
Define column resize mode: nextColumn, widget (default). |
||
type |
string |
||
enum |
nextColumn, widget |
||
default |
widget |
||
|
Whether to allow user to manually refresh table or not. |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update filter or not (will show/hide the combo box). |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update view or not (will show/hide the combo box) |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show menu toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show journal show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show export option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show archive option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show summary show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show search option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column chooser in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show clear filter in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Override icon to export table content (default save). |
||
type |
string |
||
additionalProperties |
False |
AlarmSeverity¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AlarmSeverity |
||
default |
AlarmSeverity |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Alarm severity widget settings |
||
additionalProperties |
False |
AlarmSeverityWidgetSettings¶
type |
object |
||
properties |
|||
|
Value mapped to type ALARM_COUNT content. |
||
type |
string |
||
|
Value mapped to type MAX_SEVERITY content. |
||
type |
string |
||
|
Operation executed upon alarm widget click. |
||
type |
string |
||
|
Minimum label font size |
||
type |
integer |
||
|
Maximum label font size |
||
type |
integer |
||
|
Minimum count font size |
||
type |
integer |
||
|
Maximum count font size |
||
type |
integer |
||
|
Alarm severity widget label. |
||
oneOf |
type |
string |
|
type |
boolean |
||
|
Whether to put the label at the top or the bottom of the widget. |
||
type |
string |
||
enum |
TOP, BOTTOM |
||
default |
TOP |
||
|
How much of the widget height percentage the label should take. |
||
type |
integer |
||
maximum |
100 |
||
minimum |
0 |
||
default |
20 |
||
additionalProperties |
False |
AlarmTable¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AlarmTable |
||
default |
AlarmTable |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Alarm widget settings |
||
additionalProperties |
False |
AlarmTableWidgetSettings¶
type |
object |
||
properties |
|||
|
Which alarm filter to use by default (i.e. root.alarms.filters.all) |
||
type |
string |
||
|
Which alarm view to use by default (i.e. root.alarms.views.default). |
||
type |
string |
||
|
Alarm table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
List of filters to exclude from alarm table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
Alarm table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of views to exclude from alarm table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
Define column resize mode: nextColumn, widget (default). |
||
type |
string |
||
enum |
nextColumn, widget |
||
default |
widget |
||
|
Whether to allow user to update filter or not (will show/hide the combo box) |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update view or not (will show/hide the combo box) |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show menu toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether to update automatically update table when loaded. |
||
type |
boolean |
||
default |
True |
||
|
Whether to allow user to manually refresh table or not. |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to toggle table auto refresh table or not. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show journal show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show archive option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show summary show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show search option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column chooser in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show clear filter in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Override icon to export table content (default save). |
||
type |
string |
||
additionalProperties |
False |
AnalyticsAggregateWidget¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AnalyticsAggregate |
||
default |
AnalyticsAggregate |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Range widget settings |
||
additionalProperties |
False |
AnalyticsAggregateWidgetSettings¶
type |
object |
properties |
|
|
Range to define window of data |
|
Selector to define aggregate function |
additionalProperties |
False |
RangeWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Range type |
|||||
type |
string |
|||||
enum |
Custom, AggregatePeriod |
|||||
default |
Custom |
|||||
|
Background color |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Default range value. Must be in ranges. |
|||||
default |
text |
5 min. |
||||
duration |
value |
5 |
||||
unit |
MINUTES |
|||||
|
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 |
||||||
additionalProperties |
False |
Range¶
type |
object |
|
properties |
||
|
Label. |
|
type |
string |
|
|
Range in the past (ex. 1 hour). |
|
additionalProperties |
False |
DurationConfigurationEntity¶
type |
object |
|
properties |
||
|
The amount of time expressed with the unit |
|
type |
integer |
|
|
The unit of time expressed with the value |
|
type |
string |
|
enum |
NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS |
|
additionalProperties |
False |
AnalyticsAggregateSelect¶
type |
object |
|
properties |
||
|
type |
string |
enum |
AnalyticsAggregate |
|
default |
AnalyticsAggregate |
|
|
Select default option. |
|
type |
string |
|
enum |
count, integral, last, mean, median, min, max |
|
default |
mean |
|
|
Select icon. |
|
type |
string |
|
default |
functions |
|
additionalProperties |
False |
BasicInputOutputValue¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
BasicInputOutputValue |
||
default |
BasicInputOutputValue |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Basic I/O value settings |
||
additionalProperties |
False |
BasicInputOutputValueWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Widget label shown at the top of the widget. |
|||||
type |
string |
|||||
|
Whether to show label at the top of the widget or not. |
|||||
type |
boolean |
|||||
default |
True |
|||||
|
Widget tooltip when hovering the widget. |
|||||
type |
string |
|||||
|
Whether to show tooltip when hovering the widget or not. |
|||||
type |
boolean |
|||||
default |
True |
|||||
|
Icon shown in the middle of the widget (https://material-ui.com/components/material-icons/) with naming in snake_case. |
|||||
type |
string |
|||||
|
Whether to show icon in the middle of the widget or not. |
|||||
type |
boolean |
|||||
default |
True |
|||||
|
Whether to show value at the bottom of the widget or not. |
|||||
type |
boolean |
|||||
default |
True |
|||||
|
Widget onClick listener evaluating expression. |
|||||
type |
string |
|||||
|
Foreground color of the widget. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Background color of the widget. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
sprintf expression evaluated with text type content. |
|||||
type |
string |
|||||
|
Default value used for numeric and boolean value which content is unknown. |
|||||
|
Maximum value for numeric value (both display and action). |
|||||
|
Minimum value for numeric value (both display and action). |
|||||
|
Activated content matching for text type. |
|||||
|
Deactivated content matching for text type. |
|||||
|
Activated displayed value when matching activated content for text type. |
|||||
type |
string |
|||||
|
Deactivated displayed value when matching deactivated content for text type. |
|||||
type |
string |
|||||
|
Displayed text when value is unknown. |
|||||
type |
string |
|||||
|
Displayed icon when value is unknown (https://material-ui.com/components/material-icons/) with naming in snake_case. |
|||||
type |
string |
|||||
|
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 |
|||||
|
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 |
|||||
|
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 |
|||||
|
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 |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Increase/decrease step value for numeric type. |
|||||
type |
integer |
|||||
|
Label for text type value. |
|||||
type |
string |
|||||
|
Icon when hovering text type widget to apply text content (https://material-ui.com/components/material-icons/) with naming in snake_case. |
|||||
type |
string |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
|||||
|
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 |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
BorderLayout¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
BorderLayout |
||
default |
BorderLayout |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Border Layout value settings |
||
additionalProperties |
False |
BorderLayoutWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
North component of the layout. |
|||||
oneOf |
||||||
AnalyticsAggregateWidget |
||||||
ChartWidget |
||||||
FormWidget |
||||||
RangeWidget |
||||||
ValueSubscriptionWidget |
||||||
|
South component of the layout. |
|||||
oneOf |
||||||
AnalyticsAggregateWidget |
||||||
ChartWidget |
||||||
FormWidget |
||||||
RangeWidget |
||||||
ValueSubscriptionWidget |
||||||
|
Center component of the layout. |
|||||
oneOf |
||||||
AnalyticsAggregateWidget |
||||||
ChartWidget |
||||||
FormWidget |
||||||
RangeWidget |
||||||
ValueSubscriptionWidget |
||||||
|
East component of the layout. |
|||||
oneOf |
||||||
AnalyticsAggregateWidget |
||||||
ChartWidget |
||||||
FormWidget |
||||||
RangeWidget |
||||||
ValueSubscriptionWidget |
||||||
|
West component of the layout. |
|||||
oneOf |
||||||
AnalyticsAggregateWidget |
||||||
ChartWidget |
||||||
FormWidget |
||||||
RangeWidget |
||||||
ValueSubscriptionWidget |
||||||
|
Define the width and height of the different components. |
|||||
|
Widget background color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
BoxLayout¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
BoxLayout |
||
default |
BoxLayout |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Box layout settings |
||
additionalProperties |
False |
BoxLayoutWidgetSettings¶
type |
object |
|
properties |
||
|
List of components to display in this box |
|
type |
array |
|
items |
||
|
Orientation of the box |
|
type |
string |
|
enum |
Horizontal, Vertical |
|
default |
Vertical |
|
additionalProperties |
False |
BoxLayoutComponent¶
type |
object |
|
properties |
||
|
Component |
|
oneOf |
||
AnalyticsAggregateWidget |
||
ChartWidget |
||
FormWidget |
||
RangeWidget |
||
ValueSubscriptionWidget |
||
|
Size of the component in percentage: width if orientation is Horizontal and height if orientation is Vertical |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.1 |
|
|
Size factor of the component: grow, shrink or none |
|
type |
string |
|
enum |
grow, shrink, none |
|
default |
none |
|
additionalProperties |
False |
ChartWidget¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Chart |
||
default |
Chart |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Chart widget settings |
||
additionalProperties |
False |
ChartWidgetSettings¶
type |
object |
|
properties |
||
|
Query. |
|
type |
string |
|
|
Type of chart. |
|
type |
string |
|
enum |
Line, Area, Bar |
|
default |
Line |
|
|
Title of the chart. |
|
type |
string |
|
|
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 |
|
|
Title of the Y axis of the chart. |
|
type |
string |
|
|
Range of the x axis. |
|
|
Range of the y axis. |
|
|
Array of colors uses for chart lines. |
|
type |
array |
|
default |
||
items |
||
|
Array of references that can be drawn on the chart. |
|
type |
array |
|
default |
||
items |
||
|
Display the data as lines. Can be used with showDots as true to show both lines and dots. |
|
type |
boolean |
|
default |
True |
|
|
Display the data as dots. Can be used with showLines as true to show both lines and dots. |
|
type |
boolean |
|
default |
True |
|
|
Display legends for each entry. |
|
type |
boolean |
|
default |
True |
|
|
Display range slider below chart. |
|
type |
boolean |
|
default |
True |
|
|
Interpolation function for graphs. |
|
type |
string |
|
enum |
linear, spline, hv, vh, hvh, vhv |
|
default |
linear |
|
|
Line width. |
|
type |
integer |
|
default |
3 |
|
|
Allow to edit the chart or not. |
|
type |
boolean |
|
default |
False |
|
|
Toolbar settings. |
|
additionalProperties |
False |
RangeConfigurationEntity¶
type |
object |
|
properties |
||
|
Start value |
|
type |
number |
|
|
End value |
|
type |
number |
|
additionalProperties |
False |
ChartReference¶
type |
object |
|||||
properties |
||||||
|
Orientation of the line, horizontal or vertical. |
|||||
type |
string |
|||||
enum |
Horizontal, Vertical |
|||||
default |
Horizontal |
|||||
|
Value to place reference, x value if orientation is vertical and y value if horizontal. |
|||||
type |
number |
|||||
|
Color of the reference |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Line width. |
|||||
type |
integer |
|||||
default |
3 |
|||||
|
Line dash style. |
|||||
type |
string |
|||||
enum |
solid, dot, dash, longdash, dashdot, longdashdot |
|||||
default |
dash |
|||||
additionalProperties |
False |
Toolbar¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Toolbar |
||
default |
Toolbar |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Chart widget settings |
||
oneOf |
CustomToolbar |
||
ChartToolbar |
|||
FormToolbar |
|||
additionalProperties |
False |
CustomToolbar¶
type |
object |
|
properties |
||
|
type |
string |
enum |
Custom |
|
default |
Custom |
|
|
Toolbar position. |
|
type |
string |
|
enum |
Top, Bottom |
|
default |
Top |
|
|
Define the width of the different components. |
|
|
Left component of the layout. |
|
oneOf |
||
AnalyticsAggregateWidget |
||
ChartWidget |
||
FormWidget |
||
RangeWidget |
||
ValueSubscriptionWidget |
||
|
Center component of the layout. |
|
oneOf |
||
AnalyticsAggregateWidget |
||
ChartWidget |
||
FormWidget |
||
RangeWidget |
||
ValueSubscriptionWidget |
||
|
Right component of the layout. |
|
oneOf |
||
AnalyticsAggregateWidget |
||
ChartWidget |
||
FormWidget |
||
RangeWidget |
||
ValueSubscriptionWidget |
||
additionalProperties |
False |
ToolbarLayoutArrangement¶
type |
object |
|
properties |
||
|
Width of the left component in percent (0 <= width <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.15 |
|
|
Width of the right component in percent (0 <= width <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.15 |
|
|
Maximum width of the part in the center allowed for dynamics actions in percent (0 <= width <= 1). |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.2 |
|
additionalProperties |
False |
CollectionTable¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
CollectionTable |
||
default |
CollectionTable |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Collection table widget settings |
||
additionalProperties |
False |
CollectionTableSettings¶
type |
object |
||
properties |
|||
|
Which schema to use by default (i.e. root.collections.location). |
||
type |
string |
||
|
Which schema view to use by default (i.e. view-id). |
||
type |
string |
||
|
Which schema filter to use by default (i.e. filter-id). |
||
type |
string |
||
|
Schema table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
List of schemas to exclude from table toolbar filters. |
||
type |
array |
||
items |
type |
string |
|
|
List of views to include from table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of views to exclude from table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of filters to include from table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of filters to exclude from table toolbar views. |
||
type |
array |
||
items |
type |
string |
|
|
List of forms to include in form toolbar view. |
||
type |
array |
||
items |
type |
string |
|
|
List of forms to exclude in form toolbar view. |
||
type |
array |
||
items |
type |
string |
|
|
List of display types to disable for table toolbar. |
||
type |
array |
||
default |
|||
items |
type |
string |
|
enum |
table, form |
||
|
Default display type to apply upon collection table being loaded. |
||
type |
string |
||
enum |
table, form |
||
default |
table |
||
|
Default form to apply upon form table being loaded. |
||
type |
string |
||
|
Disable form picker in form view. |
||
type |
boolean |
||
default |
False |
||
|
Disable form creation for collection table. |
||
type |
boolean |
||
default |
False |
||
|
Disable form edition for collection table. |
||
type |
boolean |
||
default |
False |
||
|
Disable form history for collection table. |
||
type |
boolean |
||
default |
False |
||
|
Collection table page size (must be present in page sizes). |
||
type |
integer |
||
minimum |
0 |
||
default |
50 |
||
|
Collection table page sizes. |
||
type |
array |
||
default |
50 |
||
100 |
|||
200 |
|||
items |
type |
integer |
|
|
Define column resize mode: nextColumn, widget (default). |
||
type |
string |
||
enum |
nextColumn, widget |
||
default |
widget |
||
|
Whether to allow user to manually refresh table or not. |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update filter or not (will show/hide the combo box). |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update view or not (will show/hide the combo box). |
||
type |
boolean |
||
default |
False |
||
|
Whether to allow user to update filter or not (will show/hide the combo box). |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show menu toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show side panel option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show export option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show archive option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show summary show/hide option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show search option in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show column chooser in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Whether or not to show clear filter in toolbar. |
||
type |
boolean |
||
default |
False |
||
|
Override icon to export table content (default save). |
||
type |
string |
||
|
Override icon to show table view (default table_rows). |
||
type |
string |
||
|
Override icon to show form view (default feed). |
||
type |
string |
||
|
Override icon to create collection entry (default post_add). |
||
type |
string |
||
|
Override icon to cancel collection entry creation (default clear). |
||
type |
string |
||
|
Override icon to edit collection entry (default edit). |
||
type |
string |
||
|
Override icon to refresh collection table (default refresh). |
||
type |
string |
||
|
Override icon to show side panel (default import_contacts). |
||
type |
string |
||
|
What display to set upon entry cancel (defaults: table). |
||
type |
string |
||
enum |
table, form |
||
|
What modality to set upon entry cancel (defaults: view). |
||
type |
string |
||
enum |
create, update, view, history |
||
|
What display to set upon entry close (defaults: table). |
||
type |
string |
||
enum |
table, form |
||
|
What modality to set upon entry close (defaults: view). |
||
type |
string |
||
enum |
create, update, view, history |
||
|
Form submit widget settings |
||
additionalProperties |
False |
SubmitWidgetSettings¶
type |
object |
|
properties |
||
|
Whether to disable submit button or not. |
|
type |
boolean |
|
default |
False |
|
|
Whether to disable apply button or not. |
|
type |
boolean |
|
default |
False |
|
|
Whether to disable save feedback or not. |
|
type |
boolean |
|
default |
False |
|
|
Whether to disable cancelling operation or not. |
|
type |
boolean |
|
default |
False |
|
|
Whether to disable closing operation or not. |
|
type |
boolean |
|
default |
False |
|
|
Submit button text override. |
|
type |
string |
|
|
Submit button icon override. |
|
type |
string |
|
|
Apply button text override. |
|
type |
string |
|
|
Apply button icon override. |
|
type |
string |
|
|
Cancel button text override. |
|
type |
string |
|
|
Cancel button icon override. |
|
type |
string |
|
|
Close button text override. |
|
type |
string |
|
|
Close button icon override. |
|
type |
string |
|
|
Status OK text override. |
|
type |
string |
|
|
Status OK icon override. |
|
type |
string |
|
|
Status in edition text override. |
|
type |
string |
|
|
Status in edition icon override. |
|
type |
string |
|
|
Status error icon override. |
|
type |
string |
|
|
Save error icon override. |
|
type |
string |
|
|
Cancel/close prompt labels override. |
|
additionalProperties |
False |
CancelPromptLabels¶
type |
object |
|
properties |
||
|
Title cancel prompt text override. |
|
type |
string |
|
|
Title cancel prompt text override. |
|
type |
string |
|
|
Message cancel prompt text override. |
|
type |
string |
|
|
Message close prompt text override. |
|
type |
string |
|
|
Yes button cancel prompt text override. |
|
type |
string |
|
|
No button cancel prompt text override. |
|
type |
string |
|
additionalProperties |
False |
FormWidget¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Form |
||
default |
Form |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Form widget settings |
||
additionalProperties |
False |
FormWidgetSettings¶
type |
object |
||
properties |
|||
|
Form reference |
||
type |
string |
||
|
Form widget options |
||
default |
useDefault |
True |
|
|
Toolbar settings. |
||
additionalProperties |
False |
FormOptions¶
type |
object |
|
properties |
||
|
Whether to use JSON schema default value or not |
|
type |
boolean |
|
default |
True |
|
additionalProperties |
False |
Gauge¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Gauge |
||
default |
Gauge |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Gauge widget settings |
||
oneOf |
|||
additionalProperties |
False |
Tachometer¶
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
enum |
Tachometer |
|||||
default |
Tachometer |
|||||
|
Value to display using the gauge. |
|||||
type |
string |
|||||
|
Minimum value displayed by the gauge. |
|||||
type |
integer |
|||||
default |
0 |
|||||
|
Maximum value displayed by the gauge. |
|||||
type |
integer |
|||||
default |
100 |
|||||
|
Sprintf.js text formatting. |
|||||
type |
string |
|||||
default |
%d%% |
|||||
|
Gauge label display either at top or bottom of the widget. |
|||||
oneOf |
type |
string |
||||
type |
boolean |
|||||
|
Gauge label position. |
|||||
type |
string |
|||||
enum |
TOP, BOTTOM |
|||||
default |
TOP |
|||||
|
Gauge label text height percentage. |
|||||
type |
integer |
|||||
maximum |
100 |
|||||
minimum |
0 |
|||||
default |
15 |
|||||
|
Widget background color. |
|||||
default |
#424242 |
|||||
|
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 |
||||||
|
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 |
|||||
|
Color of the needle gauge. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Color of the needle base gauge. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Enable (true) or Disable (false) the animation for the needle |
|||||
type |
boolean |
|||||
default |
False |
|||||
additionalProperties |
False |
Rounded¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Rounded |
||
default |
Rounded |
||
|
Value to display using the gauge. |
||
type |
string |
||
|
Minimum value displayed by the gauge. |
||
type |
integer |
||
default |
0 |
||
|
Maximum value displayed by the gauge. |
||
type |
integer |
||
default |
100 |
||
|
Sprintf.js text formatting. |
||
type |
string |
||
default |
%d%% |
||
|
Gauge label display either at top or bottom of the widget. |
||
oneOf |
type |
string |
|
type |
boolean |
||
|
Gauge label position. |
||
type |
string |
||
enum |
TOP, BOTTOM |
||
default |
TOP |
||
|
Gauge label text height percentage. |
||
type |
integer |
||
maximum |
100 |
||
minimum |
0 |
||
default |
15 |
||
|
Widget background color. |
||
default |
#424242 |
||
|
Text foreground color. |
||
default |
#3e98c7 |
||
|
Gauge arc fill background color. |
||
default |
#3e98c7 |
||
|
Gauge arc empty background color. |
||
default |
#d6d6d6 |
||
|
Icon foreground color. |
||
default |
#3e98c7 |
||
|
Stroke linecap (arc start/end shape). |
||
type |
string |
||
enum |
butt, round |
||
default |
butt |
||
|
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 |
||
|
Material UI icon to use for the gauge. |
||
type |
string |
||
|
Whether to display gauge clockwise or counter clockwise. |
||
type |
boolean |
||
default |
False |
||
|
Defines the width of the gauge widget. |
||
type |
integer |
||
default |
8 |
||
|
Defines the padding around the widget. |
||
type |
integer |
||
default |
5 |
||
additionalProperties |
False |
Icon¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Icon |
||
default |
Icon |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Icon widget value settings |
||
additionalProperties |
False |
IconWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Icon name. |
|||||
type |
string |
|||||
|
Icon font color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Widget background color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
Journal¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Journal |
||
default |
Journal |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Journal widget settings |
||
oneOf |
|||
additionalProperties |
False |
Timeline¶
type |
object |
|
properties |
||
|
type |
string |
enum |
Timeline |
|
default |
Timeline |
|
|
type |
string |
additionalProperties |
False |
Table¶
type |
object |
|
properties |
||
|
type |
string |
enum |
Table |
|
default |
Table |
|
|
type |
string |
|
Whether or not to show toolbar. |
|
type |
boolean |
|
default |
False |
|
|
Whether or not to show menu toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show side panel option in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show export option in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show column show/hide option in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show archive option in toolbar. |
|
type |
boolean |
|
default |
False |
|
|
Whether or not to show summary show/hide option in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show search option in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show column chooser in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Whether or not to show clear filter in toolbar. |
|
type |
boolean |
|
default |
True |
|
|
Define column resize mode: nextColumn, widget (default). |
|
type |
string |
|
enum |
nextColumn, widget |
|
default |
widget |
|
additionalProperties |
False |
Limit¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Limit |
||
default |
Limit |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Limit widget settings |
||
additionalProperties |
False |
LimitWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Background color |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Default limit value. |
|||||
type |
integer |
|||||
minimum |
0 |
|||||
default |
100 |
|||||
|
Default limit from value. Get x first values or x last values |
|||||
type |
string |
|||||
enum |
First, Last |
|||||
default |
Last |
|||||
|
Disable limit from selector |
|||||
type |
boolean |
|||||
default |
False |
|||||
additionalProperties |
False |
Maps¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Maps |
||
default |
Maps |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Maps widget settings |
||
additionalProperties |
False |
MapsWidgetSettings¶
type |
object |
||
properties |
|||
|
The different layers used in this widget. |
||
type |
array |
||
items |
|||
|
Styling for the MapBox maps (for example ‘mapbox://styles/mapbox/dark-v11’ to display the mapbox dark theme). |
||
|
Starting position at the start of the map (for example [7.451123, 46.947456] to center on Bern). |
||
type |
array |
||
items |
type |
number |
|
|
Zoom level at which the map starts (when it will be loaded), zoom levels goes from 0-25. |
||
type |
integer |
||
maximum |
25 |
||
minimum |
0 |
||
|
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 |
||
|
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 |
MapsLayerOptions¶
type |
object |
|
properties |
||
|
The layer id. |
|
type |
string |
|
|
If the layer is activated by default or not. |
|
type |
boolean |
|
default |
False |
|
additionalProperties |
False |
MapStyleOptions¶
type |
object |
|
properties |
||
|
The dark theme source/url. For example mapbox://styles/mapbox/dark-v11 |
|
type |
string |
|
|
The light theme source/url. For example mapbox://styles/mapbox/light-v11. |
|
type |
string |
|
additionalProperties |
False |
Markdown¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Markdown |
||
default |
Markdown |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Markdown widget value settings |
||
additionalProperties |
False |
MarkdownWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Markdown text to interpret. |
|||||
type |
string |
|||||
|
Text font color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Widget background color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Define how to align items. |
|||||
type |
string |
|||||
enum |
CENTER, LEFT, RIGHT |
|||||
|
Define how to align text. |
|||||
type |
string |
|||||
enum |
center, justify, start, end |
|||||
additionalProperties |
False |
ObjectBrowser¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
ObjectBrowser |
||
default |
ObjectBrowser |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
additionalProperties |
False |
PdfViewer¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
PdfViewer |
||
default |
PdfViewer |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Pdf viewer widget settings |
||
additionalProperties |
False |
PdfViewerWidgetSettings¶
type |
object |
|
properties |
||
|
Pdf content |
|
type |
string |
|
|
Display all pdf pages or one by one |
|
type |
string |
|
enum |
all, one |
|
default |
one |
|
|
Initial zoom value of the pdf, between 0 and 1 |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
1.0 |
|
additionalProperties |
False |
PtzController¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
PtzController |
||
default |
PtzController |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
PTZ controller widget settings |
||
additionalProperties |
False |
PtzControllerWidgetSettings¶
type |
object |
|
properties |
||
|
The movement perform by the PTZ on each click. |
|
type |
number |
|
default |
0.02 |
|
|
The minimal acceptable value for the zoom. |
|
type |
number |
|
default |
0.0 |
|
|
The maximal acceptable value for the zoom. |
|
type |
number |
|
default |
100.0 |
|
|
The pan minimal acceptable value. |
|
type |
number |
|
default |
-100.0 |
|
|
The pan maximal acceptable value. |
|
type |
number |
|
default |
100.0 |
|
|
The tilt minimal acceptable value. |
|
type |
number |
|
default |
0.0 |
|
|
The tilt maximal acceptable value. |
|
type |
number |
|
default |
100.0 |
|
additionalProperties |
False |
RangeWidget¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Range |
||
default |
Range |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Range widget settings |
||
additionalProperties |
False |
Refresh¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Refresh |
||
default |
Refresh |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Refresh widget settings |
||
additionalProperties |
False |
RefreshWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Background color |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Whether to allow user to manually refresh or not. |
|||||
type |
boolean |
|||||
default |
False |
|||||
|
Whether to allow user to toggle auto refresh or not. |
|||||
type |
boolean |
|||||
default |
False |
|||||
|
Default state of auto refresh. |
|||||
type |
boolean |
|||||
default |
False |
|||||
|
Whether to allow user to change the auto refresh rate or not. |
|||||
type |
boolean |
|||||
default |
False |
|||||
|
Default rate value as seconds for auto refresh. |
|||||
type |
integer |
|||||
default |
1 |
|||||
additionalProperties |
False |
ReportsList¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
ReportsList |
||
default |
ReportsList |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
ReportsList widget settings |
||
additionalProperties |
False |
ReportsListWidgetSettings¶
type |
object |
properties |
|
|
Filter Report template selector settings |
additionalProperties |
False |
ReportsTemplate¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
ReportsTemplate |
||
default |
ReportsTemplate |
||
|
Select default option. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to include from base options. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to exclude from base options. |
||
type |
array |
||
items |
type |
string |
|
|
Select icon. |
||
type |
string |
||
default |
picture_as_pdf |
||
|
Allow multiple selections. |
||
type |
boolean |
||
default |
True |
||
|
Number max of tags displayed. |
||
type |
integer |
||
default |
2 |
||
additionalProperties |
False |
ReportsViewer¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
ReportsViewer |
||
default |
ReportsViewer |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Report viewer widget settings |
||
additionalProperties |
False |
ReportsViewerWidgetSettings¶
type |
object |
properties |
|
|
Define the layout for the list and pdfViewer components |
|
Report list settings. |
|
PDF viewer settings. |
additionalProperties |
False |
LayoutArrangement¶
type |
object |
|
properties |
||
|
Width of the list component in percent (0 <= width <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.25 |
|
|
Width of the PdfViewer component in percent (0 <= width <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
default |
0.75 |
|
additionalProperties |
False |
Schematic¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Schematic |
||
default |
Schematic |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Schematic widget settings |
||
additionalProperties |
False |
SchematicWidgetSettings¶
type |
object |
||||
properties |
|||||
|
Schema resource path loaded by schematic widget. |
||||
oneOf |
type |
string |
|||
type |
object |
||||
properties |
|||||
|
oneOf |
type |
string |
||
|
oneOf |
type |
string |
||
additionalProperties |
False |
||||
|
Stylesheet resource path loaded by schematic widget. |
||||
oneOf |
type |
string |
|||
type |
object |
||||
properties |
|||||
|
oneOf |
type |
string |
||
|
oneOf |
type |
string |
||
additionalProperties |
False |
||||
|
Which diagram is shown by default (page). |
||||
type |
string |
||||
|
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 |
||||
|
Whether to disable toolbar or not. |
||||
type |
boolean |
||||
default |
False |
||||
|
Whether to disable paper background or not. |
||||
type |
boolean |
||||
default |
False |
||||
|
Whether fit schematic upon load or not. |
||||
type |
boolean |
||||
default |
False |
||||
|
Whether to disable scroll in schematic or not. |
||||
type |
boolean |
||||
default |
False |
||||
|
Whether to disable schematic panning or not. |
||||
type |
boolean |
||||
default |
False |
||||
|
Variables to send to schematic. |
||||
additionalProperties |
False |
Select¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Select |
||
default |
Select |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Select widget settings |
||
oneOf |
CustomSelect |
||
FormSelect |
|||
AnalyticsAggregateSelect |
|||
additionalProperties |
False |
CustomSelect¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Custom |
||
default |
Custom |
||
|
Select default option. |
||
type |
array |
||
items |
type |
string |
|
|
Select available options. |
||
type |
array |
||
items |
type |
string |
|
|
Select icon. |
||
type |
string |
||
|
Allow multiple selections. |
||
type |
boolean |
||
default |
True |
||
|
Number max of tags displayed. |
||
type |
integer |
||
default |
2 |
||
additionalProperties |
False |
AnalyticsMeasure¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AnalyticsMeasure |
||
default |
AnalyticsMeasure |
||
|
Select default option. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to include from base options. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to exclude from base options. |
||
type |
array |
||
items |
type |
string |
|
|
Select icon. |
||
type |
string |
||
default |
device_hub |
||
|
Allow multiple selections. |
||
type |
boolean |
||
default |
True |
||
|
Number max of tags displayed. |
||
type |
integer |
||
default |
2 |
||
additionalProperties |
False |
AnalyticsField¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
AnalyticsField |
||
default |
AnalyticsField |
||
|
Select default option. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to include from base options. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to exclude from base options. |
||
type |
array |
||
items |
type |
string |
|
|
Select icon. |
||
type |
string |
||
default |
timeline |
||
|
Allow multiple selections. |
||
type |
boolean |
||
default |
True |
||
|
Number max of tags displayed. |
||
type |
integer |
||
default |
2 |
||
additionalProperties |
False |
FormSelect¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Form |
||
default |
Form |
||
|
Select default option. |
||
type |
string |
||
|
List of options to include from base options. |
||
type |
array |
||
items |
type |
string |
|
|
List of options to exclude from base options. |
||
type |
array |
||
items |
type |
string |
|
|
Select icon. |
||
type |
string |
||
default |
code |
||
additionalProperties |
False |
Text¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Text |
||
default |
Text |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Text widget settings |
||
additionalProperties |
False |
TextWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Text. |
|||||
type |
string |
|||||
|
Text font color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Widget background color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
ValueSubscriptionWidget¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
ValueSubscription |
||
default |
ValueSubscription |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
additionalProperties |
False |
Value¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Value |
||
default |
Value |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Icon widget value settings |
||
additionalProperties |
False |
ValueWidgetSettings¶
type |
object |
|||||
properties |
||||||
|
Format of the value. |
|||||
type |
string |
|||||
|
Value to display. |
|||||
type |
string |
|||||
|
Text font color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
Widget background color. |
|||||
oneOf |
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
type |
object |
|||||
properties |
||||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
|
oneOf |
type |
string |
|||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
type |
object |
|||||
properties |
||||||
|
type |
string |
||||
|
type |
string |
||||
pattern |
^(#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}))?$ |
|||||
additionalProperties |
False |
|||||
additionalProperties |
False |
|||||
|
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 |
|||||
|
Value label position. |
|||||
type |
string |
|||||
enum |
TOP, BOTTOM, LEFT, RIGHT, NONE |
|||||
default |
TOP |
|||||
|
Value label text height percentage. |
|||||
type |
integer |
|||||
maximum |
100 |
|||||
minimum |
0 |
|||||
default |
20 |
|||||
additionalProperties |
False |
VideoPlayer¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
VideoPlayer |
||
default |
VideoPlayer |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Video player settings. |
||
additionalProperties |
False |
VideoPlayerWidgetSettings¶
type |
object |
|
properties |
||
|
Video ID used to display video feed. |
|
type |
string |
|
|
Disabled video label shown to user. If not set, will use default i18n value. |
|
type |
string |
|
additionalProperties |
False |
WebView¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
WebView |
||
default |
WebView |
||
|
The widget identifier, used to organize grid and internal widget communication. |
||
type |
string |
||
minLength |
1 |
||
|
The widget title |
||
type |
string |
||
|
Widget options. |
||
|
The data value subscriptions for given widget. |
||
|
List of widget’s Ids to subscribe to. |
||
type |
array |
||
items |
type |
string |
|
|
The menu applied to the given widget. |
||
type |
array |
||
items |
type |
string |
|
|
Limit menu height in pixel with overflowing menu displayed with scrollbars |
||
type |
integer |
||
minimum |
0 |
||
|
Web View widget settings |
||
additionalProperties |
False |
WebViewWidgetSettings¶
type |
object |
||||
properties |
|||||
|
Source of the iframe, must be a valid URL. |
||||
oneOf |
type |
string |
|||
type |
object |
||||
properties |
|||||
|
oneOf |
type |
string |
||
|
oneOf |
type |
string |
||
additionalProperties |
False |
||||
|
Title of the frame. |
||||
type |
string |
||||
additionalProperties |
False |
ChartToolbar¶
type |
object |
||||
properties |
|||||
|
type |
string |
|||
enum |
Chart |
||||
default |
Chart |
||||
|
Toolbar position. |
||||
type |
string |
||||
enum |
Top, Bottom |
||||
default |
Top |
||||
|
Display Refresh widget. |
||||
type |
boolean |
||||
default |
True |
||||
|
Refresh widget settings. |
||||
default |
disableSingleRefresh |
False |
|||
disableAutoRefresh |
False |
||||
defaultAutoRefresh |
False |
||||
disableAutoRefreshRate |
False |
||||
defaultAutoRefreshRate |
1 |
||||
|
Display Range widget. |
||||
type |
boolean |
||||
default |
True |
||||
|
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 |
||||
|
Display Measure select widget. |
||||
type |
boolean |
||||
default |
True |
||||
|
Measure Select widget settings. |
||||
default |
type |
AnalyticsMeasure |
|||
icon |
device_hub |
||||
multiple |
True |
||||
limitTags |
2 |
||||
|
Display Field select widget. |
||||
type |
boolean |
||||
default |
True |
||||
|
Field Select widget settings. |
||||
default |
type |
AnalyticsField |
|||
icon |
timeline |
||||
multiple |
True |
||||
limitTags |
2 |
||||
|
Display Aggregate widget. |
||||
type |
boolean |
||||
default |
True |
||||
|
Aggregate widget settings. |
||||
additionalProperties |
False |
FormToolbar¶
type |
object |
||
properties |
|||
|
type |
string |
|
enum |
Form |
||
default |
Form |
||
|
Toolbar position. |
||
type |
string |
||
enum |
Top, Bottom |
||
default |
Top |
||
|
Submit widget settings. |
||
default |
disableSubmit |
False |
|
disableApply |
False |
||
disableSaveFeedback |
False |
||
disableCancel |
False |
||
disableClose |
False |
||
|
Submit widget settings. |
||
default |
type |
Form |
|
icon |
code |
||
additionalProperties |
False |
BorderLayoutArrangement¶
type |
object |
properties |
|
|
Define the height of the north component. |
|
Define the height of the south component. |
|
Define the width of the west component. |
|
Define the height of the east component. |
additionalProperties |
False |
BorderLayoutHeightComponent¶
type |
object |
|
properties |
||
|
Height of component in percent (0 <= height <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
additionalProperties |
False |
BorderLayoutWidthComponent¶
type |
object |
|
properties |
||
|
Width of component in percent (0 <= width <= 1) the layout. |
|
type |
number |
|
maximum |
1 |
|
minimum |
0 |
|
additionalProperties |
False |
Layouts¶
type |
object |
|
properties |
||
|
Layout for large breakpoint. |
|
type |
array |
|
items |
||
|
Layout for medium breakpoint. |
|
type |
array |
|
items |
||
|
Layout for small breakpoint. |
|
type |
array |
|
items |
||
|
Layout for x-small breakpoint. |
|
type |
array |
|
items |
||
|
Layout for x-x-small breakpoint. |
|
type |
array |
|
items |
||
additionalProperties |
False |
Layout¶
type |
object |
|
properties |
||
|
Widget identifier. |
|
type |
string |
|
|
X position for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Y position for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Width for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Height for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Minimum width for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Maximum width for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Minimum height for widget. |
|
type |
integer |
|
minimum |
0 |
|
|
Maximum height for widget. |
|
type |
integer |
|
minimum |
0 |
|
additionalProperties |
False |
Breakpoint¶
type |
object |
|
properties |
||
|
Breakpoint to use large layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
1200 |
|
|
Breakpoint to use medium layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
996 |
|
|
Breakpoint to use small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
768 |
|
|
Breakpoint to use x-small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
480 |
|
|
Breakpoint to use x-x-small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
0 |
|
additionalProperties |
False |
ColumnPerLayout¶
type |
object |
|
properties |
||
|
Number of columns for large layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
12 |
|
|
Number of columns for medium layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
10 |
|
|
Number of columns for small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
6 |
|
|
Number of columns for x-small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
4 |
|
|
Number of columns for x-x-small layout. |
|
type |
integer |
|
minimum |
0 |
|
default |
2 |
|
additionalProperties |
False |