tile
tile accountDetails
Account details tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
accountOwner |
Account owner |
|||||
accountOwnerFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
accountOwnerLabel |
Account owner label |
Account Owner |
||||
region |
Region |
|||||
regionFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
regionLabel |
Region label |
Region |
||||
renewalDate |
Renewal date |
|||||
renewalDateFormat |
Accepts an identifier of a formatter which transforms |
dateDefaultFormatter |
||||
renewalDateLabel |
Renewal date label |
Renewal Date |
||||
revenue |
Revenue |
|||||
revenueFormat |
Accepts an identifier of a formatter which transforms |
currencyDefaultFormatter |
||||
revenueLabel |
Revenue label |
Revenue |
||||
salesManager |
Sales manager |
|||||
salesManagerFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
salesManagerLabel |
Sales manager label |
Sales Manager |
tile bigText
big text tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
bigTextDefaultView |
tile button
The button tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
The property in the button tile that determines where the button is placed horizontally |
left | center | right |
|
|
||
areaId |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
type |
THe property in the button tile that determines the type of button (appearance) |
secondary |
primary | danger | success | secondary | link |
|
|
|
value |
The property in the button tile that determines what is shown in the button |
|
|
|
||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
The property in the button tile that determines where the button is placed horizontally |
left | center | right |
|
|
||
areaId |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
type |
THe property in the button tile that determines the type of button (appearance) |
primary | danger | success | secondary | link |
|
|
||
value |
The property in the button tile that determines what is shown in the button |
|
|
|||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
tile casesStatus
Cases status tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label |
Cases status |
||||
open |
Open |
|
||||
overdue |
Overdue |
|
||||
showOverdueText |
This specifies whether the overdue value is to be shown under the thermometer (true | false) |
true |
true | false |
tile chart
The chart tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
animation |
Use chart animation |
false |
true | false |
|||
areaId |
||||||
chartBackgroundColor |
The background color of the chart. |
|||||
chartBackgroundOpacity |
The opacity of the background color. |
|||||
padding |
The property in the image tile that determines if the image is padded. |
true | false |
|
|
||
palette |
Here you define the custom list of colors that are to be applied to the lines in the chart. |
defaultColorPalette |
|
|||
removeEmptyCategories |
Use this property to remove from the results all categories that contain no data (true | false). |
false |
true | false |
|
||
removeEmptySeries |
Use this property to remove from the results all series that contain no data (true | false). |
false |
true | false |
|||
Category date section |
|
|||||
Area chart type |
|
|||||
This code block creates a Bar chart |
|
|||||
Series section |
|
|||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
Custom suppression |
||||||
RespondentsBase value suppression. |
||||||
Switch statement for canvas and headline |
category date
Category date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
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. |
false |
true | false |
|||
end |
Contains description of range end, applies filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
palette |
Here you define the custom list of colors that are to be applied to the lines in the category. |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
none | ascending | descending |
|||
start |
Contains description of range start, applies filter to the date expression. |
|||||
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 |
A valid value expression in table engine |
|
|
|||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
chart area
Area chart type
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
connectNulls |
Whether to connect a graph line across null points. |
true |
true | false |
|
||
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dotSize |
Dot size |
3 |
|
|||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
lineType |
The interpolation type of line |
basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter |
||||
lineWidth |
This property allows to specify the custom width for the chart lines. |
2 |
|
|||
mode |
This property changes the chart mode. |
clustered |
stacked | stacked100Percent | clustered |
|
||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
stackId |
The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL. |
chart bar
This code block creates a Bar chart
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
barColorFormat |
This is the conditional formatter to define the bar color. |
|
||||
barGap |
The gap between two bar in the same category in pixels. |
|||||
barSize |
The width or height of each bar in pixels. If the barSize is not specified or bars with the specified values don’t fit, the size of bar will be calculated automatically. Note: it will only work if you specify barSize for all bars. |
|||||
dataLabel |
Changes the data label options |
value | percent | percentThenValue | valueThenPercent | hide |
|
|||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
maxBarSize |
The maximum width or height of each bar in pixels. If the maxBarSize is not specified or bars with the specified values don’t fit, the maximum size of bar will be calculated automatically. |
|||||
mode |
This property changes the chart mode. |
clustered |
stacked | stacked100Percent | clustered |
|
||
percentFormat |
Formatter for percentage labels. |
|
||||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showValue |
Specifies whether the value is to be displayed or not. |
true |
true | false |
|||
stackId |
The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL. |
|||||
valueLabel |
Changes the display values along with labels |
|||||
valuePosition |
Changes the display position of value in chart |
inner |
inner | outer |
series
Series section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
base |
A valid expression for calculating the base of a series. |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
format |
Accepts an identifier of a formatter which transforms |
|
||||
isSecondary |
false |
true | false |
|
|||
label |
A valid value expression in table engine. |
|
||||
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 |
|
|
|||
palette |
Here you define the custom list of colors that are to be applied to the lines in the series. |
|||||
percentOver |
The value will be calculated as a percentage of a full bar. It could be calculated over series or over categories. |
series | categories |
|
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date categories, Pie, Radar and intra-series breakdown charts. |
true | false |
||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
value |
A valid value expression in table engine. |
|
|
|||
Expression filter |
|
|||||
Breakdown by cut section |
|
|||||
Breakdown by cut by multi section |
|
|||||
Breakdown by date section |
|
|||||
Breakdown by overlapping date section |
|
|||||
Chart series transfer schema |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
This code block creates a Bar chart |
|
|||||
Area chart type |
|
|||||
Line chart type |
|
|||||
Specifies that the chart is to be presented as a pie chart and provides available settings for that type of chart. |
|
|||||
This code block specifies that the chart is to be presented as a radar chart and provides available settings for that type of chart. |
breakdownBy cut
Breakdown by cut section
| 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 |
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categories |
Filter for categories used |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
|
|||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
|
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
|
|||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy transfer
Chart series transfer schema
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
fromCategory |
Transfer from category |
|
|
|||
label |
Value title |
|
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 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 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 |
chart line
Line chart type
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
connectNulls |
Whether to connect a graph line across null points. |
true |
true | false |
|
||
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dotSize |
Dot size |
3 |
|
|||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
lineType |
The interpolation type of line |
basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter |
||||
lineWidth |
This property allows to specify the custom width for the chart lines. |
2 |
|
|||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
style |
Define which style of chart to render |
comparison_line | comparison_bar |
chart pie
Specifies that the chart is to be presented as a pie chart and provides available settings for that type of chart.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
innerRadius |
The inner radius of all the sectors. |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
outerRadius |
The outer radius of all the sectors. |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showValue |
Specifies whether the value is to be displayed or not. |
true |
true | false |
|||
valuePosition |
Changes the display position of value in chart |
inner | outer |
chart radar
This code block specifies that the chart is to be presented as a radar chart and provides available settings for that type of chart.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dots |
Visibility of graph dots |
false |
true | false |
|
||
dotSize |
Dot size |
3 |
|
|||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Define a maximum value for the chart axis (the value may be 'auto', 'dataMax' or a number value) |
auto |
auto | dataMax |
|
||
min |
Define a maximum value for the chart axis (the value may be 'auto', 'dataMin' or a number value) |
auto |
auto | dataMin |
|
||
shape |
Chart shape |
polygon |
polygon | circle |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
tickCount |
The count of axis ticks |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
suppression recordsBase
RecordsBase value suppression.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
threshold |
Value will be compared with the threshold. |
none |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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. |
dataPoint |
dataPoint | totalCategories | totalSeries |
|||
table |
Formula or question ID / alias |
|||||
threshold |
Value will be compared with the threshold. |
none |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
animation |
Use chart animation |
true | false |
||||
areaId |
||||||
chartBackgroundColor |
The background color of the chart. |
|||||
chartBackgroundOpacity |
The opacity of the background color. |
|||||
padding |
The property in the image tile that determines if the image is padded. |
true | false |
|
|
||
palette |
Here you define the custom list of colors that are to be applied to the lines in the chart. |
|
||||
removeEmptyCategories |
Use this property to remove from the results all categories that contain no data (true | false). |
true | false |
|
|||
removeEmptySeries |
Use this property to remove from the results all series that contain no data (true | false). |
true | false |
||||
Category date section |
|
|||||
Series section |
|
|||||
Chart report base |
|
|||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
Custom suppression |
||||||
RespondentsBase value suppression. |
tile chartPlus
The chart tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
animation |
Use chart animation |
false |
true | false |
|||
areaId |
||||||
chartBackgroundColor |
The background color of the chart. |
|||||
chartBackgroundOpacity |
The opacity of the background color. |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
gridLines |
This defines the Grid lines display mode. |
none | horizontal | vertical | both | perpendicular | parallel |
|
|||
layout |
Specify how the chart is to be orientated (horizontal | vertical). Default value is horizontal. |
horizontal |
horizontal | vertical |
|
||
legend |
Here you define the location of the legend on the chart. Allowed values are (none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight). Default value is none. |
none |
none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight |
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
palette |
Here you define the custom list of colors that are to be applied to the lines in the chart. |
defaultColorPalette |
|
|||
postFilters |
Contains list of filters which should be applied afterwards. |
|||||
removeEmptyCategories |
Use this property to remove from the results all categories that contain no data (true | false). |
false |
true | false |
|
||
removeEmptySeries |
Use this property to remove from the results all series that contain no data (true | false). |
false |
true | false |
|||
scroll |
auto |
disabled | enabled | auto |
||||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date categories, Pie, Radar and intra-series breakdown charts. |
true | false |
||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
This code block creates a Bar chart |
|
|||||
Area chart type |
|
|||||
Line chart type |
|
|||||
Specifies that the chart is to be presented as a pie chart and provides available settings for that type of chart. |
|
|||||
This code block specifies that the chart is to be presented as a radar chart and provides available settings for that type of chart. |
||||||
Category list section |
|
|||||
Category cut section |
|
|||||
Category cut by multi section |
|
|||||
Category date section |
|
|||||
Category overlapping date section |
|
|||||
Chart category transfer schema |
|
|||||
Chart category filter schema |
|
|||||
Category drill down section |
|
|||||
Category comparison section |
|
|||||
Category total of selected section |
|
|||||
Category selected flat section |
|
|||||
Series section |
|
|||||
Chart report base |
|
|||||
Chart category axis |
|
|||||
Chart primary axis |
|
|||||
Chart secondary axis |
|
|||||
This defines the source of the Chart grid. |
|
|||||
This code block enables you to define the Chart margins. |
||||||
RespondentsBase value suppression. |
||||||
RecordsBase value suppression. |
||||||
Custom suppression |
||||||
Custom series section |
||||||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
Switch statement for canvas and headline |
chart bar
This code block creates a Bar chart
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
barColorFormat |
This is the conditional formatter to define the bar color. |
|
||||
barGap |
The gap between two bar in the same category in pixels. |
|||||
barSize |
The width or height of each bar in pixels. If the barSize is not specified or bars with the specified values don’t fit, the size of bar will be calculated automatically. Note: it will only work if you specify barSize for all bars. |
|||||
dataLabel |
Changes the data label options |
value | percent | percentThenValue | valueThenPercent | hide |
|
|||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
maxBarSize |
The maximum width or height of each bar in pixels. If the maxBarSize is not specified or bars with the specified values don’t fit, the maximum size of bar will be calculated automatically. |
|||||
mode |
This property changes the chart mode. |
clustered |
stacked | stacked100Percent | clustered |
|
||
percentFormat |
Formatter for percentage labels. |
|
||||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showValue |
Specifies whether the value is to be displayed or not. |
true |
true | false |
|||
stackId |
The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL. |
|||||
valueLabel |
Changes the display values along with labels |
|||||
valuePosition |
Changes the display position of value in chart |
inner |
inner | outer |
chart area
Area chart type
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
connectNulls |
Whether to connect a graph line across null points. |
true |
true | false |
|
||
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dotSize |
Dot size |
3 |
|
|||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
lineType |
The interpolation type of line |
basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter |
||||
lineWidth |
This property allows to specify the custom width for the chart lines. |
2 |
|
|||
mode |
This property changes the chart mode. |
clustered |
stacked | stacked100Percent | clustered |
|
||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
stackId |
The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL. |
chart line
Line chart type
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
connectNulls |
Whether to connect a graph line across null points. |
true |
true | false |
|
||
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dotSize |
Dot size |
3 |
|
|||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
lineType |
The interpolation type of line |
basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter |
||||
lineWidth |
This property allows to specify the custom width for the chart lines. |
2 |
|
|||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
style |
Define which style of chart to render |
comparison_line | comparison_bar |
chart pie
Specifies that the chart is to be presented as a pie chart and provides available settings for that type of chart.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
innerRadius |
The inner radius of all the sectors. |
|||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
outerRadius |
The outer radius of all the sectors. |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
showValue |
Specifies whether the value is to be displayed or not. |
true |
true | false |
|||
valuePosition |
Changes the display position of value in chart |
inner | outer |
chart radar
This code block specifies that the chart is to be presented as a radar chart and provides available settings for that type of chart.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dotColorFormat |
Conditional formatter for dot color. |
|
||||
dots |
Visibility of graph dots |
false |
true | false |
|
||
dotSize |
Dot size |
3 |
|
|||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Define a maximum value for the chart axis (the value may be 'auto', 'dataMax' or a number value) |
auto |
auto | dataMax |
|
||
min |
Define a maximum value for the chart axis (the value may be 'auto', 'dataMin' or a number value) |
auto |
auto | dataMin |
|
||
shape |
Chart shape |
polygon |
polygon | circle |
|||
showBaseInTooltip |
Show base of a series in tooltip |
true |
true | false |
|||
tickCount |
The count of axis ticks |
category list
Category list section
| 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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
hierarchy |
Hierarchical field (vpath) - a field to define parent-child relations when building hierarchy (example - accounts:ParentAccountID) |
|||||
label |
Value title |
|
||||
record |
The name of the filters for individual record selection |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
none | ascending | descending |
|||
table |
The name of the table (alias) for the widget to work with |
accounts: |
||||
take |
The number of cells to be fetched, cannot be used if path to series is specified as sortBy |
|||||
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 |
A valid value expression in table engine |
|
|
|||
where |
contains post-aggregation filter expression for the list section |
|||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category cut
Category cut section
| 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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
palette |
Here you define the custom list of colors that are to be applied to the lines in the category. |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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 |
A valid value expression in table engine |
|
|
|||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category cutByMulti
Category cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categories |
Filter for categories used |
|||||
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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
palette |
Here you define the custom list of colors that are to be applied to the lines in the category. |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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 |
A valid value expression in table engine |
|
|
|||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category date
Category date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
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. |
false |
true | false |
|||
end |
Contains description of range end, applies filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
palette |
Here you define the custom list of colors that are to be applied to the lines in the category. |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
none | ascending | descending |
|||
start |
Contains description of range start, applies filter to the date expression. |
|||||
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 |
A valid value expression in table engine |
|
|
|||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category overlappingDate
Category overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
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. |
false |
true | false |
|||
end |
Contains description of range end, applies filter to the date expression. |
|||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
palette |
Here you define the custom list of colors that are to be applied to the lines in the category. |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
none | ascending | descending |
|||
start |
Contains description of range start, applies filter to the date expression. |
|||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is an integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then starts of breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
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 |
A valid value expression in table engine |
|
|
|||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category transfer
Chart category transfer schema
| 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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
fromSeries |
Transfer from series |
|
||||
label |
Value title |
|
||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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. |
|||||
Chart report base |
|
category filter
Chart category filter schema
| 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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|
||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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 |
A valid value expression in table engine |
|
|
|||
valueLabel |
Value label |
|
||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category drillDown
Category drill down section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
drillDown |
Drill down |
|
||||
label |
Value title |
|
category comparison
Category comparison section
| 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. |
false |
true | false |
|||
label |
Value title |
|
||||
reportingHierarchy |
Reporting hierarchy |
|
||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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. |
|||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category selectedHierarchy
Category total of selected section
| 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. |
false |
true | false |
|||
label |
Value title |
|
||||
labelSeparator |
Label separator |
|||||
reportingHierarchy |
Reporting hierarchy |
|
||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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. |
|||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
category selectedFlat
Category selected flat section
| 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. |
false |
true | false |
|||
label |
Value title |
|
||||
labelSeparator |
Label separator |
|||||
labelStyle |
Hierarchy label display style. Has two options: nodeOnly and fullPath |
fullPath |
nodeOnly | fullPath |
|||
reportingHierarchy |
Reporting hierarchy |
|
||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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. |
|||||
Chart report base |
|
|||||
Expression filter |
|
|||||
Changes applied filter to to different one |
||||||
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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
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 |
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 |
|
series
Series section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
base |
A valid expression for calculating the base of a series. |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
format |
Accepts an identifier of a formatter which transforms |
|
||||
isSecondary |
false |
true | false |
|
|||
label |
A valid value expression in table engine. |
|
||||
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 |
|
|
|||
palette |
Here you define the custom list of colors that are to be applied to the lines in the series. |
|||||
percentOver |
The value will be calculated as a percentage of a full bar. It could be calculated over series or over categories. |
series | categories |
|
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date categories, Pie, Radar and intra-series breakdown charts. |
true | false |
||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
value |
A valid value expression in table engine. |
|
|
|||
Expression filter |
|
|||||
Breakdown by cut section |
|
|||||
Breakdown by cut by multi section |
|
|||||
Breakdown by date section |
|
|||||
Breakdown by overlapping date section |
|
|||||
Chart series transfer schema |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
This code block creates a Bar chart |
|
|||||
Area chart type |
|
|||||
Line chart type |
|
|||||
Specifies that the chart is to be presented as a pie chart and provides available settings for that type of chart. |
|
|||||
This code block specifies that the chart is to be presented as a radar chart and provides available settings for that type of chart. |
breakdownBy cut
Breakdown by cut section
| 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 |
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categories |
Filter for categories used |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
|
|||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
|
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
|
|||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy transfer
Chart series transfer schema
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
fromCategory |
Transfer from category |
|
|
|||
label |
Value title |
|
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 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 |
base
Chart report base
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
If set true, the base do not display in the category label. |
false |
true | false |
|
||
value |
Report base value expression |
COUNT() |
|
axis category
Chart category axis
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
axisLine |
Use this property to hide the axis line on this chart. If set to false, no axis line will be drawn (true | false). |
true | false |
|
|||
hide |
Use this property to hide the axis on this chart. If set to true, the axis will not be displayed in the chart (true | false). |
false |
true | false |
|
||
interval |
If set all, all the ticks will be shown. If set preserveStart, preserveEnd or preserveStartEnd, the ticks which are to be shown or hidden will be calculated automatically. |
all |
preserveStart | preserveEnd | preserveStartEnd | all |
|||
label |
Chart axis label value. |
|||||
orientation |
Tick text orientation ("vertical" or degrees from -90 till 90). |
0 |
vertical | 0 | 45 | -45 | 90 | -90 |
|||
textSize |
Defines the size (width or height, depending on location) of the axis label text in pixels |
|||||
tickLine |
Use this property to include a tick-line on the chart. If set false, no axis tick-lines will be drawn. Bear in mind that adding this property and then specifying false is the same as not adding the property (true | false). |
true |
true | false |
|
axis primary
Chart primary axis
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
axisLine |
Use this property to hide the axis line on this chart. If set to false, no axis line will be drawn (true | false). |
true | false |
|
|||
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
Use this property to hide the axis on this chart. If set to true, the axis will not be displayed in the chart (true | false). |
false |
true | false |
|
||
label |
Chart axis label value. |
|||||
maxValue |
Specify the maximum value of the axis. |
|
||||
minValue |
Specify the minimum value of the axis. |
|
||||
orientation |
Tick text orientation ("vertical" or degrees from -90 till 90). |
0 |
vertical | 0 | 45 | -45 | 90 | -90 |
|||
reversed |
Reverse the ticks or not |
true | false |
||||
strokeWidth |
Change the width of the axis |
|||||
textSize |
Defines the size (width or height, depending on location) of the axis label text in pixels |
|||||
tickCount |
Use this property to include tick-counts on the chart primary-axis. |
|
||||
tickLine |
Use this property to include a tick-line on the chart. If set false, no axis tick-lines will be drawn. Bear in mind that adding this property and then specifying false is the same as not adding the property (true | false). |
true |
true | false |
|
axis secondary
Chart secondary axis
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
axisLine |
Use this property to hide the axis line on this chart. If set to false, no axis line will be drawn (true | false). |
true | false |
|
|||
format |
Accepts an identifier of a formatter which transforms |
|
||||
hide |
Use this property to hide the axis on this chart. If set to true, the axis will not be displayed in the chart (true | false). |
false |
true | false |
|
||
label |
Chart axis label value. |
|||||
maxValue |
Specify the maximum value of the axis. |
|
||||
minValue |
Specify the minimum value of the axis. |
|
||||
orientation |
Tick text orientation ("vertical" or degrees from -90 till 90). |
0 |
vertical | 0 | 45 | -45 | 90 | -90 |
|||
reversed |
Reverse the ticks or not |
true | false |
||||
strokeWidth |
Change the width of the axis |
|||||
textSize |
Defines the size (width or height, depending on location) of the axis label text in pixels |
|||||
tickLine |
Use this property to include a tick-line on the chart. If set false, no axis tick-lines will be drawn. Bear in mind that adding this property and then specifying false is the same as not adding the property (true | false). |
true |
true | false |
|
gridSource
This defines the source of the Chart grid.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categoryFormat |
Accepts an identifier of a formatter which transforms |
|||||
categoryLabel |
Value title |
|||||
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. |
false |
true | false |
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
grid |
Grid expression |
|
|
|||
isSecondary |
false |
true | false |
||||
label |
A valid value expression in table engine. |
|||||
percent |
This property specifies whether the height of the chart bars is to be the full height of the chart diagram. The series values will be displayed as percentages of each bar (true | false). |
false |
true | false |
|||
seriesFormat |
Accepts an identifier of a formatter which transforms |
|||||
seriesLabel |
Value title |
|||||
sortBy |
A valid series identifier or path to breakdown. |
|||||
sortIndex |
Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1. |
-1 |
||||
sortOrder |
Specify how the chart widget is to be sorted (none (default) | ascending | descending). |
none |
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. |
|||||
transpose |
Transpose grid fields and categories |
false |
true | false |
|
||
value |
A valid value expression in table engine. |
|
|
|||
Chart report base |
|
chartMargin
This code block enables you to define the Chart margins.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
bottom |
Define a margin between the bottom of the chart and the lower edge of the widget. |
5 |
||||
left |
Define a margin between the left edge of the chart and the left edge of the widget. |
5 |
||||
right |
Define a margin between the right edge of the chart and the right edge of the widget. |
5 |
||||
top |
Define a margin between the top of the chart and the top edge of the widget. |
5 |
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. |
dataPoint |
dataPoint | totalCategories | totalSeries |
|||
table |
Formula or question ID / alias |
|||||
threshold |
Value will be compared with the threshold. |
none |
|
suppression recordsBase
RecordsBase value suppression.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
threshold |
Value will be compared with the threshold. |
none |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
series custom
Custom series section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
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 |
|
|
|||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
valueKey |
A pointer to the expression that the series is based on. |
value |
|
|||
Expression filter |
|
|||||
Breakdown by cut section |
|
|||||
Breakdown by cut by multi section |
|
|||||
Breakdown by date section |
|
|||||
Breakdown by overlapping date section |
|
|||||
Chart series transfer schema |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
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 |
breakdownBy cut
Breakdown by cut section
| 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 |
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
categories |
Filter for categories used |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
|
|||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
|
|||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
|
|||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
value |
A valid value expression in table engine |
|
breakdownBy transfer
Chart series transfer schema
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
fromCategory |
Transfer from category |
|
|
|||
label |
Value title |
|
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 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 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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
value |
Resulting vector values are based on this expression |
|
||||
Breakdown by cut section |
|
|||||
Breakdown by cut by multi section |
|
|||||
Breakdown by date section |
|
|||||
Breakdown by overlapping date section |
|
|||||
Represents a collection of items as format string. |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
animation |
Use chart animation |
true | false |
||||
areaId |
||||||
chartBackgroundColor |
The background color of the chart. |
|||||
chartBackgroundOpacity |
The opacity of the background color. |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
gridLines |
This defines the Grid lines display mode. |
none | horizontal | vertical | both | perpendicular | parallel |
|
|||
layout |
Specify how the chart is to be orientated (horizontal | vertical). Default value is horizontal. |
horizontal | vertical |
|
|||
legend |
Here you define the location of the legend on the chart. Allowed values are (none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight). Default value is none. |
none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight |
||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
palette |
Here you define the custom list of colors that are to be applied to the lines in the chart. |
|
||||
postFilters |
Contains list of filters which should be applied afterwards. |
|||||
removeEmptyCategories |
Use this property to remove from the results all categories that contain no data (true | false). |
true | false |
|
|||
removeEmptySeries |
Use this property to remove from the results all series that contain no data (true | false). |
true | false |
||||
scroll |
disabled | enabled | auto |
|||||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date categories, Pie, Radar and intra-series breakdown charts. |
true | false |
||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
Category list section |
|
|||||
Category cut section |
|
|||||
Category cut by multi section |
|
|||||
Category date section |
|
|||||
Category overlapping date section |
|
|||||
Chart category transfer schema |
|
|||||
Chart category filter schema |
|
|||||
Category drill down section |
|
|||||
Category comparison section |
|
|||||
Category total of selected section |
|
|||||
Category selected flat section |
|
|||||
Series section |
|
|||||
Chart category axis |
|
|||||
Chart primary axis |
|
|||||
Chart secondary axis |
|
|||||
This defines the source of the Chart grid. |
|
|||||
This code block enables you to define the Chart margins. |
||||||
RespondentsBase value suppression. |
||||||
RecordsBase value suppression. |
||||||
Custom suppression |
||||||
Custom series section |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
tile company
Company tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
companyDefaultView |
tile contactDetails
Contact details tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
emailFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
emailLabel |
Email Label |
|||||
industry |
Industry |
|||||
industryFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
industryLabel |
Industry Label |
Industry |
||||
phone |
Phone |
|||||
phoneFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
phoneLabel |
Phone Label |
Phone |
||||
role |
Role |
|||||
roleFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
roleLabel |
Role Label |
Role |
||||
title |
Title |
|||||
titleFormat |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
titleLabel |
Title Label |
Title |
tile custom
Tile custom in headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
valueColorFormatter |
The formatter used by the headline widget tiles to format the color of a value |
|
|
|||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
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 |
||||||
Represents data in svg view. |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
value |
Resulting vector values are based on this expression |
|
||||
Breakdown by cut section |
|
|||||
Breakdown by cut by multi section |
|
|||||
Breakdown by date section |
|
|||||
Breakdown by overlapping date section |
|
|||||
Represents a collection of items as format string. |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
vector items
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
valueColorFormatter |
The formatter used by the headline widget tiles to format the color of a value |
|
|
|||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
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 |
||||||
Represents data in svg view. |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
tile diff
This tile allows you to visualize difference between values of current reporting period and another one
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
diff |
absolute |
absolute | relative | percentage |
||||
indicator |
Tile diff indicator |
sign |
chevron | arrow | sign | none |
|||
label |
Input the text to be displayed as the widget diff label |
|
|
|||
main |
|
|||||
other |
|
|||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
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 |
tile dotsBar
dots bar tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
completed |
Formula or question ID / alias |
|
||||
total |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
dotsBarDefaultView |
tile gauge
The gauge tile. Includes settings for the gauge graph and labeled values.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
aboveTargetLabel |
Here you define the label that will be shown when the value is more than the target. |
Gap to target |
|
|
||
arcLength |
The total length of the gauge, between 0 or 360 |
|||||
areaId |
||||||
atTargetLabel |
Here you define the label that will be shown when the value is equal to the target. |
Gap to target |
|
|
||
baseColor |
The base color of the gauge |
|||||
belowTargetLabel |
Here you define the label that will be shown when the value is less than the target. |
Gap to target |
|
|
||
exceedingSign |
Here you specify the difference sign to be used when the value is more than the target. |
positive |
positive | negative |
|
|
|
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
gaugeColorFormat |
Input here the identifier (name) of the color formatter you want to use for the gauge tile. The gauge scale will be divided into colored segments according to the thresholds defined in the specified formatter. |
kpiColorDefaultFormatter |
|
|
||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
hideValue |
Here you can hide gauge tile value. |
false |
true | false |
|
||
label |
Input the text to be displayed as the gauge value label |
|
|
|||
max |
This property defines the maximum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 100. |
10 |
|
|
||
min |
This property defines the minimum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 0. |
0 |
|
|
||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
showRange |
Show range numbers |
false |
true | false |
|
||
target |
Use this property to specify the target value that the actual value is to be compared against. The property accepts numbers or expressions including arithmetic formulas, aliases and variables. |
|
|
|||
targetFormat |
This property must hold the identifier (name) of the custom number formatter code block, which is to be applied to the target value to define its format. |
floatDefaultFormatter |
|
|
||
value |
This property holds the expression used to calculate the gauge value that is to be displayed on the gauge. |
|
|
|
||
Expression filter |
|
|||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
aboveTargetLabel |
Here you define the label that will be shown when the value is more than the target. |
|
|
|||
arcLength |
The total length of the gauge, between 0 or 360 |
|||||
areaId |
||||||
atTargetLabel |
Here you define the label that will be shown when the value is equal to the target. |
|
|
|||
baseColor |
The base color of the gauge |
|||||
belowTargetLabel |
Here you define the label that will be shown when the value is less than the target. |
|
|
|||
exceedingSign |
Here you specify the difference sign to be used when the value is more than the target. |
positive | negative |
|
|
||
format |
Accepts an identifier of a formatter which transforms |
|
|
|||
gaugeColorFormat |
Input here the identifier (name) of the color formatter you want to use for the gauge tile. The gauge scale will be divided into colored segments according to the thresholds defined in the specified formatter. |
|
|
|||
hide |
Use this property to remove header from widget response. |
true | false |
||||
hideValue |
Here you can hide gauge tile value. |
true | false |
|
|||
label |
Input the text to be displayed as the gauge value label |
|
|
|||
max |
This property defines the maximum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 100. |
|
|
|||
min |
This property defines the minimum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 0. |
|
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
showRange |
Show range numbers |
true | false |
|
|||
target |
Use this property to specify the target value that the actual value is to be compared against. The property accepts numbers or expressions including arithmetic formulas, aliases and variables. |
|
|
|||
targetFormat |
This property must hold the identifier (name) of the custom number formatter code block, which is to be applied to the target value to define its format. |
|
|
|||
value |
This property holds the expression used to calculate the gauge value that is to be displayed on the gauge. |
|
|
|||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
tile grid
The grid tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeColumns |
Use this property to reorder or hide columns by specifying desired list of column names |
|||||
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
areaId |
||||||
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|
||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
dataSet |
The name of dataset which will be used to resolve incomplete vpath |
|||||
description |
Description (widget header) |
|
|
|||
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) |
|
|
|||
removeEmptyColumns |
Use this property to remove from the results all columns that contain no data (true | false). |
false |
true | false |
|||
removeEmptyRows |
Use this property to remove from the results all rows that contain no data (true | false). |
false |
true | false |
|||
showBullets |
The property responsible for showing/not showing counter bullets for the ranked list of tile grid |
true |
true | false |
|||
showWidgetHeader |
Shows widget header. True by default. |
true | false |
||||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
small |
small | medium | halfwidth | large |
|
|
|
stacking |
This controls widget stacking in a column |
none |
start | stack | none |
|||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
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 |
Widget variant |
default | subtle | emphasised |
||||
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 |
||||||
Data Grid column |
||||||
Data Grid cut column |
||||||
Data Grid cut by multi column |
||||||
Data Grid cut by date column |
||||||
Data Grid cut by overlapping date column |
||||||
Variable column |
||||||
Variable list column, supports variableSet |
||||||
Path hierarchy column |
||||||
Data Grid list row |
||||||
Data Grid cut row |
||||||
Data Grid cut by multi row |
||||||
Data Grid cut by date row |
||||||
Data Grid cut by overlapping date row |
||||||
Data Grid selectedFlat row |
||||||
Data Grid row |
||||||
Variable row |
||||||
Variable list row, supports variableSet |
||||||
Sorting of rows |
||||||
Sorting of columns |
||||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Trend view for data grid widget |
||||||
Mean test view for data grid widget |
||||||
Proportional test view for data grid widget |
||||||
Visualization view for row header in data grid widget |
||||||
Visualization view for cell in data grid widget |
||||||
Switch statement for canvas and headline |
Entities defined by default in tile grid:
view meanTest #defaultMeanTestView {
backgroundColorFormatter: gridDefaultBackgroundColorFormatter
valueColorFormatter: gridDefaultValueColorFormatter
}
view trend #defaultTrendView {
backgroundColorFormatter: gridDefaultBackgroundColorFormatter
valueColorFormatter: gridDefaultValueColorFormatter
}
view comparativeStatistic #defaultComparativeStatisticView {
backgroundColorFormatter: gridDefaultBackgroundColorFormatter
valueColorFormatter: gridDefaultValueColorFormatter
}
view rowHeaderVisualization #defaultRowHeaderVisualizationView {
}
view cellVisualization #defaultCellVisualizationView {
}
view proportionalTest #defaultProportionalTestView {
backgroundColorFormatter: gridDefaultBackgroundColorFormatter
valueColorFormatter: gridDefaultValueColorFormatter
}
tileStyle #defaultTileStyle {
fullWidth: false
}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 |
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 |
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 |
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 |
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 |
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 |
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
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
An action that can open infobox with defined text and header
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
info |
|
|||||
label |
action export
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 |
|
row list
Data Grid list row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
hierarchy |
Hierarchical field (vpath) - a field to define parent-child relations when building hierarchy (example - accounts:ParentAccountID) |
|||||
key |
Formula or question ID / alias |
|||||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
notAnsweredLabel |
Not answered label |
|||||
sortBy |
This will be the expression used when sorting the row or a path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
table |
The name of the table (alias) for the widget to work with |
accounts: |
||||
take |
The number of rows to be fetched, cannot be used if path to column is specified as sortBy |
|||||
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. |
|||||
total |
Total position |
none |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
This text/value will be the label for the row |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
where |
This is the post-aggregation filter expression for the list section |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row cut
Data Grid cut row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categories |
Filter for categories used |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
categoryLabel |
Category label, accepts template values, for example: "{code} - {label}" |
|||||
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. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
notAnswered |
Not answered position |
none |
none | first | last |
|||
notAnsweredLabel |
Not answered label |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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. |
|||||
total |
Total position |
none |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row cutByMulti
Data Grid cut by multi row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categories |
Filter for categories used |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
categoryLabel |
Category label, accepts template values, for example: "{code} - {label}" |
|||||
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. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
notAnswered |
Not answered position |
none |
none | first | last |
|||
notAnsweredLabel |
Not answered label |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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. |
|||||
total |
Total position |
none |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row cutByDate
Data Grid cut by date row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
categoryLabel |
Category label, accepts template values, for example: "{code} - {label}" |
|||||
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 |
||||
end |
Contains description of range end and applies filter to the date expression. |
|||||
exclude |
An array of codes that should be excluded from sorting. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
movingAverageEnd |
This defines a number of date parts after current to include in average window |
|||||
movingAverageStart |
This defines a number of date parts before current to include in average window |
|||||
notAnswered |
Not answered position |
none |
none | first | last |
|||
notAnsweredLabel |
Not answered label |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
start |
Contains description of range start and applies filter to the date expression. |
|||||
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. |
|||||
total |
Total position |
none |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row cutByOverlappingDate
Data Grid cut by overlapping date row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
align |
Set this property to true if date range should be aligned |
true | false |
||||
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
categories |
Filter for categories used |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
categoryLabel |
Category label, accepts template values, for example: "{code} - {label}" |
|||||
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 |
||||
end |
Contains description of range end and applies filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is an integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then ends of breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
exclude |
An array of codes that should be excluded from sorting. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
notAnswered |
Not answered position |
none |
none | first | last |
|||
notAnsweredLabel |
Not answered label |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
start |
Contains description of range start and applies filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is an integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then starts of breakdown intervals will not be modified. Be aware, that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth, you cannot then shift them by quarter. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
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. |
|||||
total |
Total position |
none |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row selectedFlat
Data Grid selectedFlat row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
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. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
labelSeparator |
Data Grid selectedHierarchy row label separator |
|||||
labelStyle |
Hierarchy label display style. Has two options: nodeOnly and fullPath |
fullPath |
nodeOnly | fullPath |
|||
mode |
Overrides hierachy mode for this row |
direct | rollup |
||||
nodeIds |
Changes the reporting hierarchy nodes from default / selected in the filter to particular nodes |
|||||
reportingHierarchy |
Name of hierarchy configuration |
|
||||
showTotal |
Enables total |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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. |
|||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row
Data Grid row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row variable
Variable row
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
variable |
Formula or question ID / alias |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
row variableList
Variable list row, supports variableSet
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
variableSet |
|
|||||
view |
defaultRowHeaderVisualizationView |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
sort rows
Sorting of rows
| 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. |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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. |
sort columns
Sorting of columns
| 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. |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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. |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
tile header
This tile contains the header for the metrics widget. Input the appropriate text string.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
Item representing cell with title of column |
item title
Item representing cell with title of column
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Alignment to cell content |
left |
left | center | right |
|||
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
rowHeader |
Display cell as a row header |
false |
true | false |
|||
value |
Formula or question ID / alias |
|
||||
Suppression criteria for an item |
tile icon
Icon tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
iconDefaultView |
tile image
The image tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Defines image alignment when smaller than card width |
center |
left | center | right |
|
||
areaId |
||||||
crop |
Defines how the image should crop if constrained |
center |
top left | top | top right | left | center | right | bottom left | bottom | bottom right | none |
|
||
height |
Defines image height |
|
||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
padding |
The property in the image tile that determines if the image is padded. |
true | false |
|
|
||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
This property determines which image is to be displayed. This should either be a URL to an image or a base64 encoded image. |
|
|
|
||
width |
Defines image width |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
Switch statement for canvas and headline |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Defines image alignment when smaller than card width |
left | center | right |
|
|||
areaId |
||||||
crop |
Defines how the image should crop if constrained |
top left | top | top right | left | center | right | bottom left | bottom | bottom right | none |
|
|||
height |
Defines image height |
|
||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
padding |
The property in the image tile that determines if the image is padded. |
true | false |
|
|
||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
This property determines which image is to be displayed. This should either be a URL to an image or a base64 encoded image. |
|
|
|||
width |
Defines image width |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
tile infographic
The infographic tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
baseColor |
The base color of the infographic |
|||||
colorFormatter |
The formatter used by the infographic tile to format the color of the icons/numbers in the infographic depending on the value |
|
||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the value tile that determines the studio expression or string that is resolved. |
|
|
|||
view |
The view for the infographic tile |
icon |
|
|||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
baseColor |
The base color of the infographic |
|||||
colorFormatter |
The formatter used by the infographic tile to format the color of the icons/numbers in the infographic depending on the value |
|
||||
hide |
Use this property to remove header from widget response. |
true | false |
||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the value tile that determines the studio expression or string that is resolved. |
|
||||
view |
The view for the infographic tile |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
tile kpi
The main KPI settings are specified inside this block. Inherits all properties from the gauge tile.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
aboveTargetLabel |
Here you define the label that will be shown when the value is more than the target. |
Gap to target |
|
|
||
arcLength |
The total length of the gauge, between 0 or 360 |
|||||
atTargetLabel |
Here you define the label that will be shown when the value is equal to the target. |
Gap to target |
|
|
||
baseColor |
The base color of the gauge |
|||||
belowTargetLabel |
Here you define the label that will be shown when the value is less than the target. |
Gap to target |
|
|
||
exceedingSign |
Here you specify the difference sign to be used when the value is more than the target. |
positive |
positive | negative |
|
|
|
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
gaugeColorFormat |
Input here the identifier (name) of the color formatter you want to use for the gauge tile. The gauge scale will be divided into colored segments according to the thresholds defined in the specified formatter. |
kpiColorDefaultFormatter |
|
|
||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
hideValue |
Here you can hide gauge tile value. |
false |
true | false |
|
||
label |
Input the text to be displayed as the gauge value label |
|
|
|||
max |
This property defines the maximum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 100. |
10 |
|
|
||
min |
This property defines the minimum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 0. |
0 |
|
|
||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
showRange |
Show range numbers |
false |
true | false |
|
||
target |
Use this property to specify the target value that the actual value is to be compared against. The property accepts numbers or expressions including arithmetic formulas, aliases and variables. |
|
|
|||
targetFormat |
This property must hold the identifier (name) of the custom number formatter code block, which is to be applied to the target value to define its format. |
floatDefaultFormatter |
|
|
||
value |
This property holds the expression used to calculate the gauge value that is to be displayed on the gauge. |
|
|
|
||
Expression filter |
|
|||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
This tile allows you to display an additional value, with label and progress bar, in the KPI widget. Note that you can include multiple value tiles in the widget. |
|
|
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 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 |
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 |
|
tile label
The label tile in tile set of headline widget which shows current category text
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
14 |
|
|
||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
Switch statement for canvas and headline |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
tile layout
layout tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
layoutDefaultView |
||||
progress bar tile |
||||||
dots bar tile |
||||||
big text tile |
||||||
text bar tile |
tile list
list tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
listDefaultView |
||||
Settings for the email item |
||||||
currency item |
||||||
date item |
||||||
link item |
item value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item email
Settings for the email item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueEmailDefaultView |
item currency
currency item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
currencyDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item date
date item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
dateDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item link
link item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueLinkDefaultView |
tile list
List tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
listDefaultView |
||||
Settings for the email item |
||||||
currency item |
||||||
date item |
||||||
link item |
item value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item email
Settings for the email item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueEmailDefaultView |
item currency
currency item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
currencyDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item date
date item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
dateDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueTextDefaultView |
item link
link item
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
label |
Label for item |
|||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
keyValueLinkDefaultView |
tile list
Allows to add section with title and items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Formula or question ID / alias |
|
|
|||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
groupDefaultView |
|
|||
Bar item settings |
||||||
Comment item settings |
|
item bar
Bar item settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
barFill |
fullCells |
fullCells | exactValue |
|
|||
format |
Accepts an identifier of a formatter which transforms |
integerDefaultFormatter |
|
|||
max |
A numeric value |
10 |
|
|||
min |
A numeric value |
0 |
|
|||
value |
Formula or question ID / alias |
|
|
|||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
surveyResponseItemBarDefaultView |
|
item comment
Comment item settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
|
|||
value |
Formula or question ID / alias |
|
|
|||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
surveyResponseItemCommentDefaultView |
|
tile markdown
The markdown tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the markdown tile that determines the markdown that gets displayed. This should contain a string containing Markdown syntax that will form the content of the tile. |
|
|
|||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the markdown tile that determines the markdown that gets displayed. This should contain a string containing Markdown syntax that will form the content of the tile. |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
tile metric
Metric tile schema
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
backgroundColorFormatter |
Accepts an identifier of a formatter which transforms |
|||||
format |
Accepts an identifier of a formatter which transforms |
oneDigitFloatDefaultFormatter |
||||
label |
Label |
Metric |
||||
max |
Maximum value |
10 |
||||
min |
Minimum value |
0 |
||||
showGapToTarget |
This specifies whether the gap to target is to be shown (true | false) |
true |
true | false |
|||
target |
Target |
|
||||
targetFormat |
Accepts an identifier of a formatter which transforms |
oneDigitFloatDefaultFormatter |
||||
value |
Value |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
metricDefaultView |
tile microchart
Tile microchart in headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
target |
Target |
|||||
value |
Formula or question ID / alias |
|
||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
Switch statement for canvas and headline |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
false |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
false |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
false |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Chart label in Data Grid |
|||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
target |
Target |
|||||
value |
Formula or question ID / alias |
|||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
tile progressBar
progress bar tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
max |
Maximum value |
10 |
|
|||
min |
Minimum value |
0 |
|
|||
target |
Formula or question ID / alias |
|
||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
progressBarDefaultView |
tile responseRate
Response rate tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
backgroundColorFormatter |
Accepts an identifier of a formatter which transforms |
|||||
invites |
Invites |
|
||||
label |
Label |
Response rate |
||||
responses |
Responses |
|
||||
showInvites |
This specifies whether the invites value is to be shown under the thermometer |
true |
true | false |
|||
showResponses |
This specifies whether the responses value is to be shown under the thermometer |
true |
true | false |
|||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
responseRateDefaultView |
tile risk
Risk tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
backgroundColorFormatter |
Accepts an identifier of a formatter which transforms |
|||||
format |
Accepts an identifier of a formatter which transforms |
oneDigitFloatDefaultFormatter |
||||
label |
Label |
Renewal risk |
||||
max |
Maximum value |
10 |
||||
min |
Minimum value |
0 |
||||
renewal |
Renewal |
|||||
renewalFormat |
Accepts an identifier of a formatter which transforms |
dateDefaultFormatter |
||||
renewalLabel |
Renewal Label |
Renewal |
||||
revenue |
Revenue |
|||||
revenueFormat |
Accepts an identifier of a formatter which transforms |
currencyDefaultFormatter |
||||
revenueLabel |
Revenue Label |
Revenue |
||||
showThermometer |
This specifies whether the thermometer is to be shown. |
true |
true | false |
|||
target |
Target |
|
||||
textValue |
Text value |
|
||||
value |
Value |
|
tile role
Role tile setting
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
roleDefaultView |
tile row
Tile contains row with data
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
Item representing cell with value |
||||||
Item representing cell with metric |
item value
Item representing cell with value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Alignment to cell content |
left |
left | center | right |
|||
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
rowHeader |
Display cell as a row header |
false |
true | false |
|||
value |
Formula or question ID / alias |
|
||||
Suppression criteria for an item |
item metric
Item representing cell with metric
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
align |
Alignment to cell content |
left |
left | center | right |
|||
format |
Accepts an identifier of a formatter which transforms |
oneDigitFloatDefaultFormatter |
||||
max |
A numeric value |
10 |
||||
min |
A numeric value |
0 |
||||
rowHeader |
Display cell as a row header |
false |
true | false |
|||
target |
A numeric value |
7 |
||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
valueDefaultView |
||||
Suppression criteria for an item |
tile set
The tile set in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
palette |
Here you specify palette name that will be used in tile set |
|||||
The breakdownBy indices in the headline widget tile set |
||||||
The breakdownBy cut in the headline widget tile set |
||||||
The breakdownBy list in the headline widget tile set |
||||||
The breakdownBy data, specified inline in cdl (or taken from dataTable) |
||||||
Expression filter |
|
|||||
The infographic tile in the headline widget |
|
|
||||
The markdown tile in the headline widget |
|
|
||||
Tile microchart in headline |
||||||
The text tile in the headline widget |
|
|
|
|||
The label tile in tile set of headline widget which shows current category text |
||||||
The summary 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. |
|
|
||||
Tile custom in headline |
||||||
The value tile in the headline widget |
|
|
|
|||
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 |
||||||
Switch statement for canvas and headline |
breakdownBy indices
The breakdownBy indices in the headline widget tile set
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
indices |
The breakdownBy indices ID in the headline widget tile set |
|
breakdownBy cut
The breakdownBy cut in the headline widget tile set
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
value |
The breakdownBy cut value expression in the headline widget tile set |
|
breakdownBy list
The breakdownBy list in the headline widget tile set
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
activeRows |
Use this property to reorder or hide rows by specifying desired list of row names |
|||||
categoriesForRank |
Filter for categories used in ranking |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
height |
Row height in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem). Minimum value is 40px |
|||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
hierarchy |
Hierarchical field (vpath) - a field to define parent-child relations when building hierarchy (example - accounts:ParentAccountID) |
|||||
key |
Formula or question ID / alias |
|||||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
notAnsweredLabel |
Not answered label |
|||||
sortBy |
This will be the expression used when sorting the row or a path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
table |
The name of the table (alias) for the widget to work with |
accounts: |
||||
take |
The number of rows to be fetched, cannot be used if path to column is specified as sortBy |
|||||
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 |
This text/value will be the label for the row |
|
||||
view |
defaultRowHeaderVisualizationView |
|||||
where |
This is the post-aggregation filter expression for the list section |
|||||
Data Grid value cell. |
||||||
Row percentage cell |
||||||
Column percentage cell |
||||||
Data Grid trend cell. |
||||||
Mean T test cell |
||||||
Mean Z test cell |
||||||
Proportional T test cell |
||||||
Proportional Z test cell |
||||||
Data Grid chart cell |
||||||
Cell diff |
||||||
Data Grid custom cell. |
||||||
Expression filter |
|
|||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
cell
Data Grid value cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 | parent | all | previous | next | first | last | totalexclusive |
||||
confidenceLevels |
Significance testing confidence levels |
80 | 90 | 95 | 98 | 99 | 99.8 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
significanceTesting |
Enables significance testings. Note: it is not available for multi and overlapping date headers |
true | false |
||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell rowPercentage
Row percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell columnPercentage
Column percentage cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
showBase |
Show number of responses |
false |
true | false |
|||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultComparativeStatisticView |
|||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell trend
Data Grid trend cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
view |
defaultTrendView |
|||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanTtest
Mean T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell meanZtest
Mean Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
argument |
Non-aggregated expression for mean testing |
|
||||
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultMeanTestView |
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalTtest
Proportional T test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell proportionalZtest
Proportional Z test cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
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 |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filter |
Filter expression for proportional test |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
||||
level |
Level for proportional test |
|||||
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 |
|
|
|||
nestingLimit |
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 |
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
threshold |
Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
A valid value expression in table engine |
|||||
view |
View options for statistic visualisation |
defaultProportionalTestView |
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell microchart
Data Grid chart cell
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
||||
label |
Chart label in Data Grid |
|||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
value |
Formula or question ID / alias |
|
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
||||||
Bar chart in Data Grid |
||||||
100% Stacked bar chart in Data Grid |
||||||
Stacked bar chart in Data Grid |
||||||
Line chart in Data Grid |
||||||
Pie chart in Data Grid |
||||||
Breakdown by cut section |
||||||
Breakdown by cut by multi section |
||||||
Breakdown by date section |
||||||
Breakdown by overlapping date section |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
microchart bar
Bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the bar |
|||||
colorFormat |
Color formatter for bar chart in Data Grid |
kpiColorDefaultFormatter |
||||
gradientFill |
Changes the fill to a gradient based on the offset values provided |
|||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
auto |
|
|||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
0 |
|
|||
valuePosition |
inner |
outer | inner | none |
microchart stacked100PercentBar
100% Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart stackedBar
Stacked bar chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering segments in stacked bar |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percent |
false |
true | false |
||||
roundToEven |
false |
true | false |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
valuePosition |
inner |
outer | inner | none |
microchart line
Line chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
color |
||||||
max |
Maximum value. If you want auto calculated maximum, use 'auto' |
|||||
min |
Minimum value. If you want auto calculated minimum, use 'auto' |
|||||
showDots |
true | false |
|||||
showDotValue |
Specifies whether the dot value is to be displayed or not. |
false |
true | false |
|||
showTooltip |
true |
true | false |
microchart pie
Pie chart in Data Grid
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
donutWidth |
Allows to turn a pie into a donut. The width of the donut is calculated as a percentage of the chart size. |
|||||
endAngle |
The end angle of last sector. |
90 |
||||
legendType |
The interpolation type of line |
line | square | rect | circle | cross | diamond | square | star | triangle | wye | none |
||||
notAnswered |
false |
first | last | true | false |
||||
order |
Defines the method for ordering slices in pie |
original |
original | suggested |
|||
palette |
Here you specify palette name that will be used in the bars |
defaultColorPalette |
||||
percentFormat |
Percent formatter for 100% stacked bar chart in Data Grid |
percentDefaultFormatter |
||||
showBase |
Show the base size value in the legend |
false |
true | false |
|||
showLegend |
Enable/Disable the micro-chart legend |
true |
true | false |
|||
showTooltip |
true |
true | false |
||||
startAngle |
The start angle of first sector. |
450 |
||||
valuePosition |
outer | inner | none |
breakdownBy cut
Breakdown by cut section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
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 |
||||
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy cutByMulti
Breakdown by cut by multi section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Value title |
|||||
value |
A valid value expression in table engine |
|
breakdownBy date
Breakdown by date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|||||
value |
A valid value expression in table engine |
|
breakdownBy overlappingDate
Breakdown by overlapping date section
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
breakdownBy |
Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour). |
year |
year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour |
|
||
end |
This contains the definition of the range end, and applies a filter to the date expression. |
|
||||
endShift |
Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|
||||
format |
Accepts an identifier of a formatter which transforms |
|||||
label |
Value title |
|||||
start |
This contains the definition of the range start, and applies a filter to the date expression. |
|
||||
startShift |
Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is the integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the starts of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks. |
|||||
value |
A valid value expression in table engine |
|
cell diff
Cell diff
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
diff |
absolute |
absolute | percentage | relative |
||||
extraValue |
Formula or question ID / alias |
|||||
extraValueFormat |
Accepts an identifier of a formatter which transforms |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
format |
Accepts an identifier of a formatter which transforms |
|||||
main |
||||||
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 |
|
|
|||
other |
||||||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
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 |
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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. |
cell custom
Data Grid custom cell.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
column |
List of columns IDs to apply cell |
|||||
filterSummaryFormatString |
Format string for filter summary when navigating, can access values via their names and headers label/text. Example: '({rowLabel}: {rowText} | {columnLabel}: {columnText}): {value}' |
|||||
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|
||||
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 |
|
|
|||
row |
List of row IDs to apply cell |
|||||
target |
Target |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
view |
defaultComparativeStatisticView |
|||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
mode rank Describes ranking behaviour
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
order |
Defines sorting order of ranking data points |
desc |
asc | desc |
mode percentile 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 |
tonull |
tonull | tonearest |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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. |
rounding Rounding settings for percent statistics
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
numberOfDecimalPlaces |
Number of decimal places in return value |
0 |
||||
type |
Rounding type |
truncate | floor | ceiling | roundToEven | roundAwayFromZero |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
item Item of the resulting vector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Label of the resulting vector item |
|||||
value |
Value of the resulting vector item |
|
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 |
|
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 |
breakdownBy inlineData
The breakdownBy data, specified inline in cdl (or taken from dataTable)
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
value |
Data for breakdownBy inlineData. E.g: {value: 42 label: 'Value1'}, {value: 43 label: 'Value2'} |
|
datum
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 |
||||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
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 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 |
datum cut
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. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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 |
||||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
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 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 |
datum cutByScope
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. |
|||||
sortIndex [Beta] |
Specify index of the header to be used in sorting. You can use negative values here. -1 means the last row/column. |
|||||
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 |
||||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
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 |
|||||
dense |
A boolean property that controls the ranking method. When set to true, the ranking is continuous without gaps |
true | false |
||||
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 |
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 |
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 |
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
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 |
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 |
|
||||
Item describing the value to retrieve |
||||||
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. |
item
Item describing the value to retrieve
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
index |
Index of the item to retrieve |
0 |
|
|||
label |
Label of the retrieved item |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
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 |
This flag allows to hide value during exel export |
true | false |
||||
nestingLimit |
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 |
This flag allows to hide value during exel export |
true | false |
||||
level |
Level for proportional test |
|||||
nestingLimit |
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 |
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 |
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 |
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
This type of value allows to request a vector value
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
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
This type of value allows to create a vector based on its individual items
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hideInExport |
This flag allows to hide value during exel export |
true | false |
||||
Item of the resulting vector |
|
|||||
Represents a collection of items as format string. |
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 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 |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
formatString |
Allows to format the input value. |
|||||
hide |
Use this property to remove header from widget response. |
true | false |
||||
percentage |
This property indicates whether percentage value should be used or not |
true | false |
||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the value tile that determines the studio expression or string that is resolved. If not provided it will use the last value from chartTile if available |
|
|
|||
valueColorFormatter |
The formatter used by the headline widget tiles to format the color of a value |
|
|
|||
valueFormatter |
The formatter used by headline widget tiles to format the value |
|
|
|||
view |
The view for the value tile |
|
tile statuses
Respond rate chart tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
||||||
breakBy |
Formula or question ID / alias |
|
||||
chart |
bar |
bar | pie |
|
|
||
format |
Accepts an identifier of a formatter which transforms |
integerDefaultFormatter |
|
|||
label |
Status |
|
||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
palette |
|
|||||
percentFormat |
Accepts an identifier of a formatter which transforms |
percentDefaultFormatter |
|
|
||
value |
Formula or question ID / alias |
|
|
tile summary
The summary tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
14 |
|
|
||
max_tokens |
500 |
|||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
prompt |
What’s the summary of all comments? |
|||||
promptLabel |
Prompt 1 |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
table |
: |
|
||||
take |
50 |
50 | 100 | 250 | 500 | 1000 |
||||
value |
|
|||||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Switch statement for canvas and headline |
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 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 |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
max_tokens |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
prompt |
||||||
promptLabel |
||||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
table |
||||||
take |
50 | 100 | 250 | 500 | 1000 |
|||||
value |
tile surveyResponses
Survey responses tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
backgroundColorFormatter |
Accepts an identifier of a formatter which transforms |
|||||
completed |
Completed |
|
||||
label |
Label |
Survey response |
||||
showResponseRate |
This specifies whether the responses rate value is to be shown under the thermometer |
true |
true | false |
|||
total |
Total |
|
tile svg
The svg tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
overwriteFill |
Set to true if you want your 'fill' property to take precedence |
true |
true | false |
|
||
overwriteStroke |
Set to true if you want your 'stroke' property to take precedence |
true |
true | false |
|
||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
This property determines which image is to be displayed. This should either be a URL to an svg file |
|
|
|||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
Switch statement for canvas and headline |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
overwriteFill |
Set to true if you want your 'fill' property to take precedence |
true | false |
|
|||
overwriteStroke |
Set to true if you want your 'stroke' property to take precedence |
true | false |
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
This property determines which image is to be displayed. This should either be a URL to an svg file |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
tile text
text bar tile
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
valueDefaultFormatter |
||||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
textDefaultView |
tile text
The text tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the text tile that determines the text that is shown. |
|
|
|
||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the text tile that determines the text that is shown. |
|
|
|||
An action that navigates to other page |
||||||
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 |
||||||
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 |
tile title
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
value |
Formula or question ID / alias |
|
|
|||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
titleDefaultView |
tile value
Value tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
value |
Formula or question ID / alias |
|
||||
view |
This is the identifier of a View, where the View is a special case of a formatter which is responsible for the UI (a formatter is normally used for data transformation). A View must be specified if non-default behavior is needed |
valueDefaultView |
tile value
This tile allows you to display an additional value, with label and progress bar, in the KPI widget. Note that you can include multiple value tiles in the widget.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseColor |
The base color of the KPI gauge |
|||||
format |
Accepts an identifier of a formatter which transforms |
floatDefaultFormatter |
|
|
||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
Input the text to be displayed as the value tile label |
|
|
|||
max |
This property defines the maximum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 100. |
|
||||
min |
This property defines the minimum value of the displayed value range scale. This allows you to show a 'zoomed-in' section of the scale, allowing the user to more easily compare the actual value against the target value. Numbers or expressions including arithmetic formulas, aliases and variables can be used as the property values. Defaults to 0. |
|
||||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
value |
This holds the expression to calculate the value for the KPI value tile. This value will be presented on the progress bar, allowing it to be compared against the maximum value (when this value has been specified). |
|
|
|
||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
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 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 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 |
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 |
|
tile value
Secondary metrics tile settings
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
format |
Accepts an identifier of a formatter which transforms |
|
|
|||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
label |
|
|
||||
value |
Formula or question ID / alias |
|
|
|||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
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 |
tile value
The value tile in the headline widget
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
formatString |
Allows to format the input value. |
{value} |
||||
hide |
Use this property to remove header from widget response. |
false |
true | false |
|||
lastInterval |
The property in the value tile that determines whether it should show the difference between current and last value from chart response under the value property |
false |
true | false |
|||
lastIntervalColorFormatter |
The formatter used by headline widget tiles to format the color of the last interval value |
|
||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the value tile that determines the studio expression or string that is resolved. If not provided it will use the last value from chartTile if available |
|
|
|||
valueColorFormatter |
The formatter used by the headline widget tiles to format the color of a value |
|
|
|||
valueFormatter |
The formatter used by headline widget tiles to format the value |
oneDigitFloatDefaultFormatter |
|
|
||
view |
The view for the value tile |
valueDefaultView |
|
|||
Expression filter |
|
|||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||||
Changes the reporting period from default / selected in the filter to different one |
||||||
Changes applied filter to to different one |
||||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |
||||||
Switch statement for canvas and headline |
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 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 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 |
action navigate
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 setSelector
An action that allows setting a specific option in a selector.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
compareBy |
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. |
|
action sendEvent
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Name of an event |
|
action export
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 |
|
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 |
|
suppression custom
Custom suppression
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
condition |
Custom suppression condition: either expression, value name, or formula entity |
|
||||
valuesToKeep |
List of values that should not be suppressed. By default all values are suppressed |
switch
Switch statement for canvas and headline
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
isSwitchActive |
If the switch style should be applied or not |
true |
true | false |
|||
linkedToValue |
Reference to the tile. For example 'linkedToValue: @valueTile'. Switch will use the value of this tile for condition checks |
|||||
Switch statement case |
|
case
Switch statement case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
byValue |
Name of the value to check condition for |
|||||
condition |
Condition of the switch statement in a form "[> | < | ⇐ | >= | = | !=][value]". For example ">42" |
|
||||
Body of switch case |
|
body
Body of switch case
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
areaId |
||||||
fontSize |
The property used by the headline widget to define the fontSize of the specific tile |
|
|
|||
formatString |
Allows to format the input value. |
|||||
hide |
Use this property to remove header from widget response. |
true | false |
||||
lastInterval |
The property in the value tile that determines whether it should show the difference between current and last value from chart response under the value property |
true | false |
||||
lastIntervalColorFormatter |
The formatter used by headline widget tiles to format the color of the last interval value |
|
||||
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
true | false |
||||
navigateOptions |
Navigate to different dashboard in new tab and vice versa. |
new_tab | same_tab |
|
|||
navigateTo |
Page to navigate to or a cross-document link entity |
|
|
|||
spacing |
Tile spacing settings |
small | medium | large | none |
||||
value |
The property in the value tile that determines the studio expression or string that is resolved. If not provided it will use the last value from chartTile if available |
|
|
|||
valueColorFormatter |
The formatter used by the headline widget tiles to format the color of a value |
|
|
|||
valueFormatter |
The formatter used by headline widget tiles to format the value |
|
|
|||
view |
The view for the value tile |
|
||||
An action that navigates to other page |
||||||
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 |
||||||
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 |
||||||
RecordsBase value suppression. |
||||||
RespondentsBase value suppression. |
||||||
Custom suppression |