widget headline
The Headline widget is typically used to highlight key information in a simple and attractive format. With multiple tile options you can condense multiple data points into a digestible and engaging view.
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) |
|
|
|||
exportable |
This activates the possibility for the user to download the widget content as an image. Using Confirmit Go mobile app, this permits the user to share and send a snapshot image of the widget to someone else. |
false |
true | false |
|
||
hide |
Hide item |
true | false | pdf | web |
||||
ignoreFilters |
A list of filter names to ignore. Container name can be used to ignore group of filters (e.g name of layout area) |
|
||||
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) |
|
|
|||
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. |
small |
small | medium | halfwidth | large |
|
|
|
spacing |
Tile spacing settings |
medium |
small | medium | large | none |
|||
useOnlySources |
This defines the sources used by the widget to fetch data from. |
|||||
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
via |
Table(s) for join path conflict resolution |
|||||
viaStrategy |
Join path conflict resolution strategy |
default | shortest |
||||
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. |
||||
Suppression criteria for a widget |
|
|||
Options for optimization |
||||
Expression filter |
|
|||
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 |
||||
The button tile in the headline widget |
|
|
|
|
The chart tile in the headline widget |
|
|||
The chart tile in the headline widget |
|
|||
The image tile in the headline widget |
|
|
|
|
The svg tile in the headline widget |
|
|
||
The infographic tile in the headline widget |
|
|
||
The markdown tile in the headline widget |
|
|
||
The text tile in the headline widget |
|
|
|
|
The value tile in the headline widget |
|
|
|
|
This tile allows you to visualize difference between values of current reporting period and another one |
|
|
||
The gauge tile. Includes settings for the gauge graph and labeled values. |
|
|
||
The grid tile in the headline widget |
||||
The tile set in the headline widget |
||||
Tile microchart in headline |
||||
The summary tile in the headline widget |
|
|||
Tile custom in headline |
||||
The datum in headline. Hidden tile designed for calculations |
||||
The datum cut in headline. Hidden tile designed for calculations with cut by value |
||||
The datum cutByScope in headline. Hidden tile designed for calculations with cut by scope |
||||
This block defines icon view settings. You can use this configuration block to redefine default icon view settings. |
||||
This view displays a filled percent value. You can use this configuration block to redefine default numeric view settings. |
||||
RecordsBase value suppression. |
||||
RespondentsBase value suppression. |
||||
Custom suppression |
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 can open infobox with defined text and header |
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
info |
|
|||||
label |
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 |
suppressRule
Suppression criteria for a widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
criteria |
Expression used to evaluate suppression |
|
||||
label |
Text showed in case of suppression |
|
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 |
|
datum [Beta]
The datum in headline. Hidden tile designed for calculations
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
Cell ranking settings |
||||||
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks). |
||||||
This type of lookup allows retrieval of a single value from reference data source (benchmarks) |
||||||
This type of lookup allows retrieval of a vector from reference data source (benchmarks) |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell expression |
||||||
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column |
||||||
Cell header value settings. You can request header label or code with it |
||||||
This type of value allows to request a vector value |
||||||
This type of value allows to create a vector based on its individual items |
rank
Cell ranking settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
decimalPlaces |
Decimal places to compare use for ranking comparisons |
|||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatString |
Format string for rank. For example: '{rank} out of {total}'. Should take into account 'withMaxRank' |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
mode |
Ranking mode: all, within or between |
all | within | between |
|
|||
order |
Ranking order: asc or desc |
asc | desc |
||||
sourceValue |
Name of the value to rank. By default - 'value' |
value |
||||
withMaxRank |
Show a maximum rank for every cell |
true | false |
||||
Represents a collection of items as format string. |
lookup rank
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks).
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
ranks |
Defines indexes of a subset of the original benchmark array to be used for ranking. Indexes are 1-based |
|||||
source |
The name of reference data source |
|
||||
takeInArray |
The name of the reference data array for ranking |
|
||||
value |
Expression defining a source value to rank, or a name of previously defined value to rank |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
mode custom
Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
ends |
In some edge cases calculated rank may fall outside the defined range 1-n. This option defines a rule of handling such cases |
none | tonull | tonearest |
||||
interval |
Defines a rule of assigning ranks to values that are between range boundaries |
left | right |
||||
order |
Defines sorting order of ranking data points |
asc | desc |
lookup value
This type of lookup allows retrieval of a single value from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
source |
The name of reference data source |
|
||||
value |
The name of the value to retrieve. Optionally with index if the value is an array: 'name, index' |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
lookup items [Beta]
This type of lookup allows retrieval of a vector from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
array |
Name of the reference data array |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
indexes |
Indexes of the values to retrieve from array |
|
||||
source |
The name of reference data source |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
statistic trend
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
previous | next | first | last |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
value |
Calculate trend / percent for this expression |
|
||||
Represents a collection of items as format string. |
statistic percent
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
dimension |
Axis for significance testing: 'rows' or 'columns' |
columns |
rows | columns |
|||
formatter |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Calculate trend / percent for this expression |
|
||||
Rounding settings for percent statistics |
||||||
Represents a collection of items as format string. |
statistic mean
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
Represents a collection of items as format string. |
statistic proportional
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
filter |
Filter expression for proportional test |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
Represents a collection of items as format string. |
expression
Cell expression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
Represents a collection of items as format string. |
formula
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula to access aggregated values in a table and evaluate new values |
|
||||
Represents a collection of items as format string. |
headerInfo
Cell header value settings. You can request header label or code with it
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
depth |
Depth of header level to get information from (for multi-level headers like dates etc.) Default is 0 (top level) |
0 |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
headerId |
Header ID from which to get the value |
|
||||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
type |
Type of header value to request - code or label |
code |
code | label |
|||
Represents a collection of items as format string. |
vector [Beta]
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Resulting vector values are based on this expression |
|
||||
Represents a collection of items as format string. |
vector items [Beta]
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
datum cut [Beta]
The datum cut in headline. Hidden tile designed for calculations with cut by value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categories |
Filter for categories used |
|||||
collapseMulti |
When set to true, this header acts like 'cutByMulti' for multi-choice variables, while it has no effect on other types of valriables. |
true | false |
||||
emptyFirst |
For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false. |
true | false |
||||
exclude |
An array of codes that should be excluded from sorting. |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
takeBottom |
Specifies how many cells are to be taken, starting at the bottom of the column. |
|||||
takeTop |
Specifies how many cells are to be taken, starting at the top of the column. |
|||||
value |
Formula or question ID / alias |
|
||||
Cell ranking settings |
||||||
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks). |
||||||
This type of lookup allows retrieval of a single value from reference data source (benchmarks) |
||||||
This type of lookup allows retrieval of a vector from reference data source (benchmarks) |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell expression |
||||||
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column |
||||||
Cell header value settings. You can request header label or code with it |
||||||
This type of value allows to request a vector value |
||||||
This type of value allows to create a vector based on its individual items |
rank
Cell ranking settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
decimalPlaces |
Decimal places to compare use for ranking comparisons |
|||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatString |
Format string for rank. For example: '{rank} out of {total}'. Should take into account 'withMaxRank' |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
mode |
Ranking mode: all, within or between |
all | within | between |
|
|||
order |
Ranking order: asc or desc |
asc | desc |
||||
sourceValue |
Name of the value to rank. By default - 'value' |
value |
||||
withMaxRank |
Show a maximum rank for every cell |
true | false |
||||
Represents a collection of items as format string. |
lookup rank
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks).
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
ranks |
Defines indexes of a subset of the original benchmark array to be used for ranking. Indexes are 1-based |
|||||
source |
The name of reference data source |
|
||||
takeInArray |
The name of the reference data array for ranking |
|
||||
value |
Expression defining a source value to rank, or a name of previously defined value to rank |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
mode custom
Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
ends |
In some edge cases calculated rank may fall outside the defined range 1-n. This option defines a rule of handling such cases |
none | tonull | tonearest |
||||
interval |
Defines a rule of assigning ranks to values that are between range boundaries |
left | right |
||||
order |
Defines sorting order of ranking data points |
asc | desc |
lookup value
This type of lookup allows retrieval of a single value from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
source |
The name of reference data source |
|
||||
value |
The name of the value to retrieve. Optionally with index if the value is an array: 'name, index' |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
lookup items [Beta]
This type of lookup allows retrieval of a vector from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
array |
Name of the reference data array |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
indexes |
Indexes of the values to retrieve from array |
|
||||
source |
The name of reference data source |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
statistic trend
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
previous | next | first | last |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
value |
Calculate trend / percent for this expression |
|
||||
Represents a collection of items as format string. |
statistic percent
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
dimension |
Axis for significance testing: 'rows' or 'columns' |
columns |
rows | columns |
|||
formatter |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Calculate trend / percent for this expression |
|
||||
Rounding settings for percent statistics |
||||||
Represents a collection of items as format string. |
statistic mean
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
Represents a collection of items as format string. |
statistic proportional
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
filter |
Filter expression for proportional test |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
Represents a collection of items as format string. |
expression
Cell expression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
Represents a collection of items as format string. |
formula
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula to access aggregated values in a table and evaluate new values |
|
||||
Represents a collection of items as format string. |
headerInfo
Cell header value settings. You can request header label or code with it
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
depth |
Depth of header level to get information from (for multi-level headers like dates etc.) Default is 0 (top level) |
0 |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
headerId |
Header ID from which to get the value |
|
||||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
type |
Type of header value to request - code or label |
code |
code | label |
|||
Represents a collection of items as format string. |
vector [Beta]
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Resulting vector values are based on this expression |
|
||||
Represents a collection of items as format string. |
vector items [Beta]
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
datum cutByScope [Beta]
The datum cutByScope in headline. Hidden tile designed for calculations with cut by scope
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
emptyFirst |
For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false. |
true | false |
||||
exclude |
An array of codes that should be excluded from sorting. |
|||||
mainLabel |
Label for the main scope column |
|||||
otherLabel |
Label for the secondary scope column |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
takeBottom |
Specifies how many cells are to be taken, starting at the bottom of the column. |
|||||
takeTop |
Specifies how many cells are to be taken, starting at the top of the column. |
|||||
Cell ranking settings |
||||||
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks). |
||||||
This type of lookup allows retrieval of a single value from reference data source (benchmarks) |
||||||
This type of lookup allows retrieval of a vector from reference data source (benchmarks) |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell statistic value settings |
||||||
Cell expression |
||||||
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column |
||||||
Cell header value settings. You can request header label or code with it |
||||||
This type of value allows to request a vector value |
||||||
This type of value allows to create a vector based on its individual items |
||||||
Entity, that specifies the reporting periods that are used in cut |
|
rank
Cell ranking settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
decimalPlaces |
Decimal places to compare use for ranking comparisons |
|||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatString |
Format string for rank. For example: '{rank} out of {total}'. Should take into account 'withMaxRank' |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
mode |
Ranking mode: all, within or between |
all | within | between |
|
|||
order |
Ranking order: asc or desc |
asc | desc |
||||
sourceValue |
Name of the value to rank. By default - 'value' |
value |
||||
withMaxRank |
Show a maximum rank for every cell |
true | false |
||||
Represents a collection of items as format string. |
lookup rank
This type of lookup allows evaluation of ranks of calculated values against reference data (benchmarks).
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
ranks |
Defines indexes of a subset of the original benchmark array to be used for ranking. Indexes are 1-based |
|||||
source |
The name of reference data source |
|
||||
takeInArray |
The name of the reference data array for ranking |
|
||||
value |
Expression defining a source value to rank, or a name of previously defined value to rank |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Describes ranking behaviour |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
mode custom
Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
ends |
In some edge cases calculated rank may fall outside the defined range 1-n. This option defines a rule of handling such cases |
none | tonull | tonearest |
||||
interval |
Defines a rule of assigning ranks to values that are between range boundaries |
left | right |
||||
order |
Defines sorting order of ranking data points |
asc | desc |
lookup value
This type of lookup allows retrieval of a single value from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
source |
The name of reference data source |
|
||||
value |
The name of the value to retrieve. Optionally with index if the value is an array: 'name, index' |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
lookup items [Beta]
This type of lookup allows retrieval of a vector from reference data source (benchmarks)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
array |
Name of the reference data array |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
indexes |
Indexes of the values to retrieve from array |
|
||||
source |
The name of reference data source |
|
||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Mapping objects define correspondence between table headers or values and reference data selectors |
||||||
Represents a collection of items as format string. |
mapping header
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
depth |
Header level depth for multi-level headers |
|||||
flavor |
The 'flavor' of header cell values to map to the specified selector. If not defined, a cell value is mapped as is. If defined then a cell value is converted before mapping |
year | quarter | month | week | day |
||||
header |
Reference to local header |
|
||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
mapping value
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
value |
Expression defining the value to map |
|
mapping valueId
Mapping objects define correspondence between table headers or values and reference data selectors
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
header |
Reference to local header |
|||||
matching |
Specifies matching mode. "exact" (default) - find exactly matching selector, "nearest" - find a selector with closest numeric value (ignored for string values). |
exact | nearest |
||||
selector |
Name of the header in the lookup table |
|
||||
valueId |
Name of the expression to map |
|
statistic trend
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
previous | next | first | last |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
value |
Calculate trend / percent for this expression |
|
||||
Represents a collection of items as format string. |
statistic percent
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
dimension |
Axis for significance testing: 'rows' or 'columns' |
columns |
rows | columns |
|||
formatter |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Calculate trend / percent for this expression |
|
||||
Rounding settings for percent statistics |
||||||
Represents a collection of items as format string. |
statistic mean
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
Represents a collection of items as format string. |
statistic proportional
Cell statistic value settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
compare |
Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons), |
adjacent |
adjacent | parent | all | previous | next | first | last | totalexclusive |
|||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dimension |
Axis for significance testing: 'rows' or 'columns' |
rows | columns |
||||
filter |
Filter expression for proportional test |
|||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit [Beta] |
Specifies max number of nested leaf cell levels that can be included in a comparison group. If non present - largest possible comparison groups is creared, including as many nesting levels as possible to form independent groups. |
|||||
results |
Result format for significance testing: 'positive', 'negative' or 'both' |
default |
positive | negative | both | default |
|||
testingType |
Significance testing type |
T |
T | Z |
|
||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
Represents a collection of items as format string. |
expression
Cell expression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
Represents a collection of items as format string. |
formula
Formula allows you to calculate new values within the same row using values from different columns and/or different values in the same column
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Formula to access aggregated values in a table and evaluate new values |
|
||||
Represents a collection of items as format string. |
headerInfo
Cell header value settings. You can request header label or code with it
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
colorFormatter |
The formatter used to format the color of a value |
|
|
|||
depth |
Depth of header level to get information from (for multi-level headers like dates etc.) Default is 0 (top level) |
0 |
||||
formatter |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
headerId |
Header ID from which to get the value |
|
||||
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
type |
Type of header value to request - code or label |
code |
code | label |
|||
Represents a collection of items as format string. |
vector [Beta]
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
value |
Resulting vector values are based on this expression |
|
||||
Represents a collection of items as format string. |
vector items [Beta]
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport [Beta] |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
suppression recordsBase
RecordsBase value suppression.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
threshold |
Value will be compared with the threshold. |
none |
|
suppression respondentsBase
RespondentsBase value suppression.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
filter |
Formula or question ID / alias |
|||||
in |
Defines a position where the condition of suppressing should be calculated. |
sameCell |
sameCell | totalInRows | totalInColumns |
|||
suppressTotal |
If true, values in Total cells will be suppressed as well. |
false |
true | false |
|||
table |
Formula or question ID / alias |
|||||
threshold |
Value will be compared with the threshold. |
none |
|