widget programSurveyList
This widget displays the list of surveys and provides links to the connected reports for each survey
Available properties
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
dataSet |
The name of dataset which will be used to resolve incomplete vpath |
|||||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
ignoreFiscalCalendar |
This allows you to use standard calendar instead of fiscal one |
true | false |
|
|||
ignoreWeights |
Use this property to specify any weights that have been defined but are to be ignored at this time. If the list contains multiple items, separate the items with comma. |
|||||
label |
Label (widget header) |
Surveys |
|
|
||
showWidgetHeader [Beta] |
Shows widget header. True by default. |
true | false |
||||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
medium |
small | medium | halfwidth | large |
|
|
|
skip |
The number of items (starting from the first item) that are to be ignored when fetching data. |
0 |
|
|||
stretchColumns |
Here you can specify that any columns without a defined width are to be stretched such that the table fills the entire table width |
false |
true | false |
|||
take |
The number of items to be fetched for one request. |
20 |
|
|||
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
widgetVariant [Beta] |
Widget variant |
default | subtle | emphasised |
Available objects
| Name | Description | |||
|---|---|---|---|---|
Selector allows you to select option and exposes property 'selected' which can be referenced from any place |
||||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||
This is widget documentation; information about the widget that is provided by the dashboard designer to the end report viewer. This allows the designer to add custom content for the widget "info" to provide the user with information necessary to understand the visualisation, type of analysis performed, data, etc. for example details about the risk model applied in the Risk assessment. |
|
|
||
The Toolbar widget is typically used to highlight key information in a simple text format and a selector. |
||||
Options for optimization |
||||
This allows variables for a date filter to be redefined |
|
|||
This allows a level for a filter to be redefined |
|
|||
Changes the reporting period from default / selected in the filter to different one |
||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||
Changes applied filter to to different one |
||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||
View that renders a survey icon |
||||
View that renders a dropdown list of links |
select
Selector allows you to select option and exposes property 'selected' which can be referenced from any place
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
applyOnEvent [Beta] |
This property buffers changes to the local state of the select. Changes are not applied directly to the model, but are stored and only applied when a specified event occurs. |
|||||
background |
Set the background of the select; currently this only supports transparent as an option |
transparent |
||||
compareBy [Beta] |
This property allows the selection check in the selector to be based on any option’s property, instead of the default value. By setting compareBy to this.label or this.id, you can customize the attribute used to determine which option is selected. |
|||||
defaultOption |
Use this property to set default option for select |
|||||
delay [Beta] |
Sets the number of milliseconds to wait before applying the selector, effective in 'multi' mode |
|||||
label |
Label of selector |
|||||
mode |
Use this property to switch select type from single-choice to multi-choice |
multi | single |
||||
onDefaultChange |
Use this property to change behavior of selector when defaultOption is changed dynamically |
reset | resetAndApply |
||||
options |
List of options, consist of entities with mainType 'item' and properties 'value' and 'label' |
|
||||
preserveState [Beta] |
This property determines whether the previous selection will remain when the select is shown again. If set to true, the previous selection will persist each time the select is made visible. |
true | false |
||||
resetOnEvent [Beta] |
This property resets the state of the select even if it’s buffered. |
|||||
selected |
Selected option value, it is set by system automatically, depends on user choice |
|||||
selectedProperty |
Entity with properties of entity within value, it is set by system automatically, depends on user choice |
|||||
An action that allows setting a specific option in a selector. |
||||||
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard |
||||||
An action that closes modal |
||||||
View resembling a table with customizable columns and selectable rows |
||||||
Selector, that looks like list of checboxes or radiobuttons |
||||||
Selector, that looks like tabs |
action setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy [Beta] |
This property allows the selection check in the selector to be based on any option’s property, instead of the default value. By setting compareBy to this.label or this.id, you can customize the attribute used to determine which option is selected. |
|||||
select |
A reference that specifies the select entity in which the option should be selected. |
|
||||
value |
Specifies the value of the option to be selected. |
|
toolbar
The Toolbar widget is typically used to highlight key information in a simple text format and a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
A button located within the widget’s toolbar |
button
A button located within the widget’s toolbar
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
||||||
A menu option that opens upon clicking, which |
||||||
An action that navigates to other page |
||||||
An action that allows setting a specific option in a selector. |
||||||
An action that can open infobox with defined text and header |
||||||
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more |
||||||
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard |
||||||
An action that closes modal |
option
A menu option that opens upon clicking, which
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
|
|||||
An action that navigates to other page |
||||||
An action that can open infobox with defined text and header |
||||||
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more |
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
info |
|
|||||
label |
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Specifies the desired format for the exported file |
png |
png | default |
action navigate [Beta]
An action that navigates to other page
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
action showInfobox [Beta]
An action that can open infobox with defined text and header
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
info |
|
|||||
label |
action export [Beta]
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Specifies the desired format for the exported file |
png |
png | default |
overrideFilter date
This allows variables for a date filter to be redefined
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dateVariables |
This property defines data fields for the date filter |
|
|
|||
level |
This property specifies a level which selection in filter should be applied to |
|||||
name |
This property specifies the name of the filter that is to be redefined |
|
||||
via |
This property specifies an intermediate level to be used to join not directly related levels: level at which filter is defined and level where filter should be applied to |
overrideFilter level
This allows a level for a filter to be redefined
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
level |
This property specifies a level which selection in filter should be applied to |
|||||
name |
This property specifies the name of the filter that is to be redefined |
|
||||
via |
This property specifies an intermediate level to be used to join not directly related levels: level at which filter is defined and level where filter should be applied to |
scope reportingPeriod
Changes the reporting period from default / selected in the filter to different one
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
applyTo |
References to attribute of date variable from dataSet, if omitted then date variables apply for are not changed |
|||||
period |
Defining a new reporting period |
AllData | YoY | Previous | Current |
scope reportingHierarchy
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
mode |
Changes the reporting hierarchy mode |
direct | rollup |
||||
nodeIds |
Changes the reporting hierarchy nodes from default / selected in the filter to particular nodes |
|||||
nodes |
Changes the reporting hierarchy nodes from default / selected in the filter to different one |
AllData | ParentsFromTop | ParentsFromCurrent | Roots | Children | Base |
||||
reportingHierarchy |
Reporting hierarchy name |
|
scope filter
Changes applied filter to to different one
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Defining a scope filter name |
|
||||
value |
Defining a scope filter value |
propagateFilter
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dropOriginal |
This flag allows to skip apply of the filter on 'source' level |
false |
true | false |
|||
from |
A level reference specifying the source level |
|
||||
to |
A level reference specifying the target level |
|