widget reportList
This widget displays a list of published dashboards in the configured hub
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) |
|||||
mappingKey |
Mapping key will indicate reportID column to map custom data to the report list widget |
|||||
paginationType |
Specifies pagination type for table. |
paging |
infiniteScroll | paging | none |
|||
personalizedAccess |
Indicates whether the report list is filtered by user node assignments. By default, it is set to false. |
false |
true | false |
|||
rowsPerPage |
Specifies the number of rows per page options available for the pager select (the list of integers, e.g. 20, 30, 40). Applied with paginationType = paging. |
10 |
||||
showHeader |
Specifies whether the column header is to be displayed. |
true |
true | false |
|||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
large |
small | medium | halfwidth | large |
|||
skip |
The number of items (starting from the first item) that are to be ignored when fetching data. |
0 |
||||
sortColumn |
Specifies which column the list is to be sorted by. Input the column ID. |
accessed |
||||
sortOrder |
Filter options sort order |
descending |
ascending | descending | reverse |
|||
table |
The name of the table (alias) for the widget to work with |
|||||
take |
The number of items to be fetched for one request. |
10 |
||||
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. |
||||
A default view settings for displaying value with a toggle arrow to show or hide details |
||||
This is a preset view configuration for displaying multi-line text, which by default has 3 lines. This view is available as defaultCommentView when you specify the view for a column. You also may define your own view based on this one to redefine default settings. You can have multiple view_comment objects in a report; each object must have a unique name. |
||||
This block defines icon view settings. You can use this configuration block to redefine default icon view settings. |
||||
This block defines icon view settings. You can use this configuration block to redefine default icon view settings. |
||||
A preset view configuration for displaying a progress bar to track the current date related to the expiry date. Note that this property will normally be unnecessary unless you want to redefine some default settings. |
||||
This is a preset type of view that allows you to style an item or text in a tile with cascading style sheets (CSS) using |
||||
This item creates a colored tile with a centered, colored digit of predefined width inside it. The tile is used to present metric data, and includes an arrow (up or down) or a flat icon located to the right of the digit to indicate how the value has changed from the previous period. |
||||
A view that renders link (does not apply any wrapping) |
||||
This item creates a colored tile with a centered, colored digit of predefined width inside it. The tile is used to present metric data, and includes an arrow (up or down) or a flat icon located to the right of the digit to indicate how the value has changed from the previous period. |
||||
value item |
||||
This view renders HTML. |
||||
This object defines a standard way of displaying a value column. You can override the formatting to change the look and feel as required by adding properties. You can add as many columns as required; each must have a unique name. |
||||
This object provides a standard way of displaying a link. You can override the formatting to change the look and feel as required. |
||||
This object provides a standard way of rendering column with formatted date value. The default date formatter applied to this column displays dates in short-form e.g. "17 Jan '17".
You can override the default formatting to change the look and feel as required by specifying a custom value for the |
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 |