widget surveyReport
Survey report widget
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 |
|
||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
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. |
||||
The Markdown widget is typically used to highlight key information in a more flexible format. Mark the text and click on the format editor to to apply some simple formatting, or open the Markdown style guide for help on how to style your content in Markdown language. |
|
|||
Sampling information widget |
||||
Survey calendar widget to setup emailing (invitation/reminders) |
||||
Survey scores widget. |
||||
Display answers on open text questions widget |
||||
The widget displays overall information of responses |
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 |
widget markdown
The Markdown widget is typically used to highlight key information in a more flexible format. Mark the text and click on the format editor to to apply some simple formatting, or open the Markdown style guide for help on how to style your content in Markdown language.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
cheatsheet |
Enable this option to display a brief description of Markdown syntax and some examples of its usage. For more information see the official Markdown Guide. (true | false). |
false |
true | false |
|
||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
markdown |
This property must contain a string containing Markdown syntax that will form the content of the widget. |
|
|
|||
pageBreak |
Controls the ability to define a page break for printing or PDF export purposes |
false |
true | false |
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
small |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
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. |
widget samplingInfo
Sampling information widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
Sampling contacts filter |
||||||
Sampling contact email list filter |
widget surveyCalendar
Survey calendar widget to setup emailing (invitation/reminders)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
widget surveyScores
Survey scores widget.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
description |
Description (widget header) |
|
|
|||
dimensionGroup |
Identifier of dimension group. Only questions that belong to dimension group will be listed in widget |
|||||
exportable |
Switching it enables survey scores export |
false |
true | false |
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
The description of flat tab. Can be used to define different properties of flat tab. |
||||||
The description of hierarchical tab. Can be used to define different properties of hierarchical tab. This one is rendered if no tabs specified. |
||||||
For custom questions should be used custom tab. |
||||||
The description of benchmark column. Can be used to define different properties of benchmark column. |
||||||
The description of breakdown column. Can be used to define different properties of breakdown column. |
||||||
Show icons for standard deviations on questions scores. |
||||||
The description of dimension column. Can be used to define different properties of dimension column. This one is always rendered even if not specified explicitly on the hierarchical tab. |
||||||
The description of question column. Can be used to define different properties of question column. This one is always rendered even if not specified explicitly on the hierarchical and flat tabs. |
||||||
The description of scores column. Can be used to define different properties of scores column. This one will be rendered as default column if no columns are specified (not including questions column). |
||||||
The description of visualScore column. Can be used to define different properties of visualScore column. |
tab flat
The description of flat tab. Can be used to define different properties of flat tab.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Title of tab |
widget surveyComments
Display answers on open text questions widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
description |
Description (widget header) |
|
|
|||
expanded |
Switching it enables expanded view for survey comments |
false |
true | false |
|||
exportable |
Switching it enables survey comments export |
false |
true | false |
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
questions |
Filter on specific questions |
|||||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |
widget responseOverview
The widget displays overall information of responses
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
description |
Description (widget header) |
|
|
|||
hide |
Hide item |
true | false | pdf | web |
||||
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) |
|
|
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|
|
|
useWeights |
This property holds a list of the weights that are to be used by default. |