config
config access
This is the basic block for specifying user access to the report, including single sign-on and portal ID.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
hierarchyVariable |
Provides a hierarchy variable to filter the current report in report list widgets for end users. The variable must be provided in the full format: [project].[level]:[name] |
|||||
portalid |
This property specifies the Portal ID, also known as the End user list ID. |
|||||
ssoConfig |
Single sign-on configuration name |
|||||
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. |
config actionManagement
This block contains the configuration code for Action Management.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
detailsPageId |
In this property you specify the ID for the case details page. |
|||||
listPageId |
In this property you specify the ID for the case list page. |
config actionPlanner
This block contains the configuration code for Action Planner.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
questions |
In this property you specify the questions that are to be included; everything else will be excluded. |
|||||
sources |
In this property you specify the sources that are to be included; everything else will be excluded. |
config breadcrumbs
Config of breadcrumbs options
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
combinedText |
Text for combined area of responsibility |
config calendarOptions
This is a set of options that allow you to set a distinct fiscal calendar. They allow you to manage different week start-days, redefine month durations, and define week rules.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
use |
This identifies the calendar used (Gregorian | some-calendar-guide) |
gregorian |
||||
weekRule |
This rule defines how the first week of a year is to be identified (firstDay | firstFullWeek | firstFourDayWeek) |
firstDay |
firstDay | firstFullWeek | firstFourDayWeek |
|||
weekStart |
This option determines the first day of a week (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday) |
monday |
sunday | monday | tuesday | wednesday | thursday | friday | saturday |
config dataExport
This block allows you to configure a survey data export
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
This code block contains the Survey data export settings |
rawDataExport
This code block contains the Survey data export settings
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
dataSet |
This is the survey dataset from which data will be exported |
|||||
dataTemplate |
This defines which data template is to be used for the survey export |
|||||
enableAllData |
Here you set the value for enableAllData to include or exclude None (all data) option from the export dialog |
true |
true | false |
|||
fileType |
This defines the file type of the exported file |
Excel |
all() | Excel | ExcelWithLabels | DelimitedTextFile | DelimitedTextFileWithLabels | TripleS | TripleSConfirmit | SPSS | SPSSSav | Quantum | SAS | FixedWidthFile |
|||
statusFilter |
Here you set the status values for the survey data status filter |
all() | Complete | Incomplete | Error | QuotaFull | Screened |
||||
survey |
This is the survey ID from which data will be exported |
config digitalFeedback
This block contains the configuration for Digital Feedback integration
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
programKey |
Here you input the Digital Feedback program key |
|||||
programKeySdk |
Here you input the Digital Feedback SDK program key |
config editor
This code block contains the configuration code for the editor and runtime environment.
config headerBarTheme
Header bar theme config
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
activeTabColor |
||||||
headerBackgroundColor |
||||||
headerBottomLineColor |
||||||
showPageBreadcrumbs |
Show page breadcrumbs (true | false). |
false |
true | false |
|||
tabsBackgroundColor |
||||||
tabsTextColor |
||||||
toolbarBackgroundColor |
config hub
This is the basic block for configuring the hub. Here you specify the data that is to be used in the report, define the relations between different data tables, and define any derived variables.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
dataSet |
The name of dataset which will be used to resolve incomplete vpath |
|||||
hub |
Each report can reference one hub in SmartHub. Input the appropriate hub ID here. |
|||||
preserveDeclarationsOrder |
Preserve order of different entities related to data extraction (filters/vtables/hierarchies/…), because this order can influence the obtained result |
true | false |
||||
table |
Table alias definitions |
|||||
via |
Table(s) for join path conflict resolution |
|||||
viaStrategy |
Join path conflict resolution strategy |
default | shortest |
||||
This object specifies that for each row in one table there can be many corresponding rows in the other table. |
||||||
This object specifies that for each row in one table there can be only one corresponding row in the other table. |
||||||
Derived auto variable |
||||||
Derived numeric variable |
||||||
Derived text variable |
||||||
Derived boolean variable |
||||||
Derived date variable |
||||||
Derived numeric list variable |
||||||
Derived text list variable |
||||||
Derived multi variable |
||||||
Derived grid variable |
||||||
Claim to be added as an extra user property on the @currentUser object. This can be referred to later in filters or access rules |
||||||
Specify the set of variables from source need to take |
||||||
Specify the set of categories from specific question to take |
||||||
Specify the set of items with any value in it, valueSet exposes items property with list of item entities |
||||||
This is a virtual table which defines the new variables "field" and "value" for a vector source. |
||||||
This is a custom virtual table |
||||||
Defines a virtual table that is constructed as a result of joining some other table with itself.Item objects define the structure of the level defined. Table items can be associated with “left”, “right” or “common” part of the join. |
||||||
Virtual table that is created from static data |
||||||
Block for custom properties |
||||||
Recoding for a discrete value variable |
||||||
Recoding for a variable with ranges |
||||||
This property allows you to define the weights using a weight model defined in Professional Authoring. |
||||||
This property allows you to define a weight by using an Expression. |
||||||
Dataset based on survey source |
||||||
Dataset based on custom data source |
||||||
Dataset for Text Analytics |
||||||
Dataset based on contact data source |
||||||
Dataset based on Action Management Cases data source |
||||||
Dataset based on Forsta survey source |
||||||
Self-ref lookup hierarchy |
||||||
Survey-based hierarchy |
||||||
Self-ref custom hierarchy |
||||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Specifies the data to retrieve with the use of dataGrid. These values can be referenced throughout CDL. |
||||||
Defenition of reference data table for using in lookups |
||||||
Reference to the PG Benchmarks data table |
Entities defined by default in config hub:
recoding values #_NPS {
label: "Standard NPS"
mapping #mapping {
from: "'0','1','2','3','4','5','6'"
to: "1"
label: "Detractors"
score: 1
}
mapping #mapping_2 {
from: "'7','8'"
to: "2"
label: "Passives"
score: 2
}
mapping #mapping_3 {
from: "'9','10'"
to: "3"
label: "Promoters"
score: 3
}
}
recoding values #_scale5To3 {
label: "5 point to 3 point scale"
mapping #mapping {
from: "'1','2'"
to: "1"
label: "Negative"
score: 1
}
mapping #mapping_2 {
from: "3"
to: "2"
label: "Neutral"
score: 2
}
mapping #mapping_3 {
from: "'4','5'"
to: "3"
label: "Positive"
score: 3
}
}
recoding values #_scale7To3 {
label: "7 point to 3 point scale"
mapping #mapping {
from: "'1','2'"
to: "1"
label: "Negative"
score: 1
}
mapping #mapping_2 {
from: "'3','4','5'"
to: "2"
label: "Neutral"
score: 2
}
mapping #mapping_3 {
from: "'6','7'"
to: "3"
label: "Positive"
score: 3
}
}
recoding values #_scale10To3 {
label: "10 point to 3 point scale"
mapping #mapping {
from: "'1','2','3'"
to: "1"
label: "Negative"
score: 1
}
mapping #mapping_2 {
from: "'4','5','6','7'"
to: "2"
label: "Neutral"
score: 2
}
mapping #mapping_3 {
from: "'8','9','10'"
to: "3"
label: "Positive"
score: 3
}
}
relation oneToMany
This object specifies that for each row in one table there can be many corresponding rows in the other table.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
foreignKey |
This must hold the Vpath expression specifying the name of the column in the connected table by which the relation between the tables is established. |
|||||
optionalKeys |
An array of indexes (0-based) in the key arrays. Key pairs with indexes included here are considered “optional”. Optional keys are skipped without error in case any variable of a pair is missing. At least one key pair in a relation must be non-optional. |
|||||
primaryKey |
This must hold the Vpath expression specifying the name of the column in the main table by which the relation between tables is established. |
relation oneToOne
This object specifies that for each row in one table there can be only one corresponding row in the other table.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
foreignKey |
This must hold the Vpath expression specifying the name of the column in the connected table by which the relation between the tables is established. |
|||||
optionalKeys |
An array of indexes (0-based) in the key arrays. Key pairs with indexes included here are considered “optional”. Optional keys are skipped without error in case any variable of a pair is missing. At least one key pair in a relation must be non-optional. |
|||||
primaryKey |
This must hold the Vpath expression specifying the name of the column in the main table by which the relation between tables is established. |
variable auto
Derived auto variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable numeric
Derived numeric variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable text
Derived text variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable bool
Derived boolean variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable date
Derived date variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable numericList
Derived numeric list variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable textList
Derived text list variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
variable multiChoice
Derived multi variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
|||||
Derived folded multi variable |
categories source
Derived folded multi variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
codes |
An expression to get the codes for categories of of the derived variable |
|||||
filter |
Filter expression |
|||||
labels |
An expression to get the labels for categories of the derived variable |
|||||
sortBy |
An expression used when sorting categories |
|||||
sortOrder |
sort order |
none | ascending | descending |
||||
value |
An expression to get the value of the derived variable |
variable singleChoice
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
|||||
An answer description |
variable grid
Derived grid variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the derived variable |
|||||
table |
This is the table in which the derived variable will be created |
|||||
value |
An expression to get the value of the derived variable |
|||||
An answer description |
userProperty claim
Claim to be added as an extra user property on the @currentUser object. This can be referred to later in filters or access rules
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultValue |
Value that will be used when no value was fetched in user property |
|||||
joinKey |
Column in a table (vpath) containing username to match with currently logged in user, e.g. accessRules:Username |
|||||
value |
Column in a table which corresponds to the value you want to use for the currently logged in user, e.g. accessRules:Role |
variableSet
Specify the set of variables from source need to take
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
allowEmpty |
Metadata lookup can return empty list of items. If this option is set to ‘true’, empty list will be returned. If it’s ‘false’ exception will be thrown. (default is false). |
true | false |
||||
exclude |
Exclude field specify which variables should be excluded |
|||||
include |
Include field specify which variables should be included |
|||||
items |
Auto generated list of all items which are fetched according to variables property |
|||||
order |
Order field specify how variables should be ordered |
AsSpecified |
Original | Alphabetically | AsSpecified |
|||
table |
||||||
variables |
categorySet
Specify the set of categories from specific question to take
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
question |
Question to take categories from |
valueSet
Specify the set of items with any value in it, valueSet exposes items property with list of item entities
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
items |
Auto generated list of all items specified in the body of valueSet |
|||||
Specify the item with required label and value properties |
vtable split
This is a virtual table which defines the new variables "field" and "value" for a vector source.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
baseLevel |
This defines the base level in the hierarchy onto which a sub level with the newly created variables will be added. |
|||||
source |
This defines the original vector variable, to which the split will be applied. |
|||||
This allows to give a name for the original vector variable, to which the split will be applied. |
vtable custom
This is a custom virtual table
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
inheritance |
A table reference defining the table to inherit variables from. If it is specified, then it is possible to refer to variables from inherited table in current table directly. |
|||||
Defines a link to the parent table. |
||||||
Variables created from table key. |
||||||
Expression filter |
||||||
Derived auto variable |
||||||
Derived numeric variable |
||||||
Derived text variable |
||||||
Derived boolean variable |
||||||
Derived date variable |
||||||
Derived numeric list variable |
||||||
Derived text list variable |
||||||
Derived multi variable |
||||||
Derived grid variable |
parent
Defines a link to the parent table.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
table |
Parent table. |
|||||
type |
A string defining relation type: "oneToOne" or "oneToMany". By default is "oneToMany". |
oneToMany |
oneToMany | oneToOne |
variablesFromKey
Variables created from table key.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
createRelation |
If set to true, a relation between the vtable and the specified table will automatically be created. Relation type (one-to-one or one-to-many) will be determined automatically based on other items in vtable definition. |
true | false |
||||
groupBy |
A list of grouping options. Only "values" keyword is supported. If omitted then no grouping is performed. |
values |
||||
isKey |
Indicates whether this variable is a part of primary key of the virtual table. |
true | false |
||||
table |
The table whose key will be used to create variables. |
vtable selfJoin
Defines a virtual table that is constructed as a result of joining some other table with itself.Item objects define the structure of the level defined. Table items can be associated with “left”, “right” or “common” part of the join.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
table |
The source table to be joined. |
|||||
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts). |
||||||
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts). |
||||||
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts). |
place common
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts).
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
Expression filter |
||||||
Variables created from table key. |
place left
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts).
place right
Defines a part of the join this items belongs to. Possible values: 'left', 'right' or 'common'. Defines how variable values are evaluated. If place is 'left' or 'right' then values are evaluated in the context of the specified part and these values become values of respective variables. If place is 'common' then such value is considered to be a part of matching keys of the join (so that these values are always the same in both parts).
vtable static
Virtual table that is created from static data
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
data |
Virtual table data - list of records, each record uses variable names as keys, values are variable values |
recoding values
Recoding for a discrete value variable
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Here you input the desired label for the recoding |
|||||
method |
This defines an implementation method which can be used for query optimization. |
default | case |
||||
Here you can specify a mapping to define a new code from an old code. |
recoding ranges
Recoding for a variable with ranges
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
intervals |
When performing range recoding, this is the interval that is to be recoded. |
open | closed | leftopen | rightopen |
||||
label |
Here you input the desired label for the recoding |
|||||
method |
This defines an implementation method which can be used for query optimization. |
default | case |
||||
Here you can specify a mapping to define a new code from an old code. |
weight model
This property allows you to define the weights using a weight model defined in Professional Authoring.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
model |
This is the name of the weight model that is to be used, as defined in the Professional Authoring survey specified in "weightmodel_survey". |
|||||
survey |
This is the name of the Professional Authoring survey in which the weight model to be used is defined. |
|||||
table |
Here you specify the table to which the weight is to be applied. |
weight expression
This property allows you to define a weight by using an Expression.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
table |
Here you specify the table to which the weight is to be applied. |
|||||
value |
This is the Expression which will be used as a weight. It can be a constant, a function or a scalar variable. |
dataset survey
Dataset based on survey source
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
response |
||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Recoding for a discrete value variable |
||||||
Recoding for a variable with ranges |
||||||
This is a virtual table which defines the new variables "field" and "value" for a vector source. |
||||||
This is a custom virtual table |
||||||
Defines a virtual table that is constructed as a result of joining some other table with itself.Item objects define the structure of the level defined. Table items can be associated with “left”, “right” or “common” part of the join. |
||||||
Virtual table that is created from static data |
||||||
This object specifies that for each row in one table there can be many corresponding rows in the other table. |
||||||
This object specifies that for each row in one table there can be only one corresponding row in the other table. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Date variable |
Entities defined by default in dataset survey:
measure custom #responseRate {
value: 100 * count(:, :status = "complete" OR :status != "complete" AND :status != "error") / :surveyInvited()
label: "Response Rate (Includes partials)"
}
measure custom #responseRateMR {
value: 100 * count(:, :status = "complete") / :surveyInvited()
label: "Response Rate (Does not include partials)"
}
measure custom #surveyInvited {
value: count(.respondent:, .respondent:smtpstatus = "MessageSent")
label: ""
}
measure custom #respondents {
value: count(.respondent:)
label: ""
}
measure custom #numberOfResponses {
value: count(:)
label: "Number of responses"
}
measure custom #numberOfRespondents {
value: count(.respondent:)
label: "Number of respondents"
}
variable singleChoice #surveyResponseStatus {
table: .respondent:
value: IIF(.respondent:smtpstatus = "MessageSent", IIF(:status = "complete", "r", IIF(:status != "complete" AND :status != "error", "p", "n")))
label: "Status"
option code #status {
label: "Full Response"
code: "r"
}
option code #codeOption {
label: "Partial Response"
code: "p"
}
option code #codeOption_2 {
label: "No Response"
code: "n"
}
}
variable date #responseRateDate {
table: .respondent:
value: .respondent:createddate
label: "Date"
}
dateVariable #responseDateVariable {
value: .response:interview_start
}
dateVariable #respondentDateVariable {
applyTo: "respondent"
value: .respondent:CreatedDate
}
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
dataset custom
Dataset based on custom data source
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
|||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Date variable |
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
dataset textAnalytics
Dataset for Text Analytics
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
analysisRecord |
||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Self-ref custom hierarchy |
||||||
Date variable |
Entities defined by default in dataset textAnalytics:
measure custom #categoryCount {
value: count(.categoryScore:)
label: "Number of categories"
}
measure custom #categoryAverage {
value: average(.categoryScore:score)
label: "Average category sentiment"
}
measure custom #categoryResponseBase {
value: countDistinct(.categoryScore:responseId)
label: "Number of responses within category"
}
measure custom #categoryRespondentBasePercent {
value: 100 * countDistinct(.categoryScore:responseid) / countDistinct(.overallScore:responseid, true, "__top")
label: "Percentage of respondents within category"
}
measure custom #categoryCommentsBase {
value: countDistinct(.categoryScore:)
label: "Number of comments categorised"
}
measure custom #categoryCommentsPercent {
value: 100 * countDistinct(.categoryScore:) / countDistinct(.categoryScore:, true, "__top")
label: "Percentage of comments categorised"
}
measure custom #categoryPositiveCount {
value: countIf(.categoryScore:categorySentimentGroup = "positive")
label: "Count of positive category sentiments"
}
measure custom #categoryPositivePercent {
value: PercentageOfAnswers(.categoryScore:categorySentimentGroup, "positive")
label: "Percentage of positive category sentiments"
}
measure custom #categoryNeutralCount {
value: countIf(.categoryScore:categorySentimentGroup = "neutral")
label: "Count of neutral category sentiments"
}
measure custom #categoryNeutralPercent {
value: PercentageOfAnswers(.categoryScore:categorySentimentGroup, "neutral")
label: "Percentage of neutral category sentiments"
}
measure custom #categoryNegativeCount {
value: countIf(.categoryScore:categorySentimentGroup = "negative")
label: "Count of negative category sentiments"
}
measure custom #categoryNegativePercent {
value: PercentageOfAnswers(.categoryScore:categorySentimentGroup, "negative")
label: "Percentage of negative category sentiments"
}
measure custom #overallCount {
value: count(.overallScore:score)
label: "Number of overall sentiments"
}
measure custom #overallAverage {
value: average(.overallScore:score)
label: "Average overall sentiment"
}
measure custom #overallResponseBase {
value: countDistinct(.overallScore:responseId)
label: "Number of responses in overall sentiments"
}
measure custom #overallRespondentBasePercent {
value: 100 * countDistinct(.overallScore:responseid) / countDistinct(.overallScore:responseid, true, "__top")
label: "Percentage of respondents in overall sentiments"
}
measure custom #overallCommentsBase {
value: countDistinct(.overallScore:)
label: "Number of comments with overall sentiments"
}
measure custom #overallCommentsPercent {
value: 100 * countDistinct(.overallScore:score) / countDistinct(.overallScore:score, true, "__top")
label: "Percentage of comments with overall sentiments"
}
measure custom #overallPositiveCount {
value: countIf(.overallScore:overallSentimentGroup = "positive")
label: "Count of positive overall sentiments"
}
measure custom #overallPositivePercent {
value: PercentageOfAnswers(.overallScore:overallSentimentGroup, "positive")
label: "Percentage of positive overall sentiments"
}
measure custom #overallNeutralCount {
value: countIf(.overallScore:overallSentimentGroup = "neutral")
label: "Count of neutral overall sentiment"
}
measure custom #overallNeutralPercent {
value: PercentageOfAnswers(.overallScore:overallSentimentGroup, "neutral")
label: "Percentage of neutral overall sentiments"
}
measure custom #overallNegativeCount {
value: countIf(.overallScore:overallSentimentGroup = "negative")
label: "Count of negative overall sentiments"
}
measure custom #overallNegativePercent {
value: PercentageOfAnswers(.overallScore:overallSentimentGroup, "negative")
label: "Percentage of negative overall sentiments"
}
measure custom #averageOverallSentiment {
value: avg(avg(.Overallscore:score, true, .responses:))
label: "Average Sentiment Score"
}
measure custom #numberOfTaResponses {
value: count(.responses:, some(.Overallscore:, true, .responses:))
label: "Number of Text Analytics responses"
}
measure custom #responseSentimentGroup {
value: recode(avg(.overallScore:score, true, .responses:), @recodeSentiments)
label: "Average Sentiment Recoded"
}
measure custom #percentOfTaResponses {
value: count(.responses:, some(.overallScore:, true, .responses:)) / count(.responses:, true, "__top") * 100
label: "Percent of Text Analytics respondeses across all respondenses"
}
measure custom #averageResponseCategorySentiment {
value: avg(avg(.categoryScore:score, true, .responses:))
label: "Average Sentiment across Categories"
}
measure custom #responseCategoryGroup {
value: recode(.categoryScore:score, @recodeSentiments)
label: "Average Sentiment across categories Recoded"
}
variable singleChoice #categorySentimentGroup {
label: "Positive/Neutral/Negative category groups"
table: .categoryScore:
value: iif(.categoryScore:score > 0, "positive", iif(.categoryScore:score < 0, "negative", iif(.categoryScore:score = 0, "neutral")))
option code #codeOption {
label: "Positive"
code: "positive"
score: 1
}
option code #codeOption_2 {
label: "Neutral"
code: "neutral"
score: 0
}
option code #codeOption_3 {
label: "Negative"
code: "negative"
score: -1
}
}
variable singleChoice #overallSentimentGroup {
label: "Positive/Neutral/Negative overall groups"
table: .overallScore:
value: iif(.overallScore:score > 0, "positive", iif(.overallScore:score < 0, "negative", iif(.overallScore:score = 0, "neutral")))
option code #codeOption {
label: "Positive"
code: "positive"
score: 1
}
option code #codeOption_2 {
label: "Neutral"
code: "neutral"
score: 0
}
option code #codeOption_3 {
label: "Negative"
code: "negative"
score: -1
}
}
reportingHierarchy selfRefCustom #categoryHierarchy {
label: "Categories model"
mode: "direct"
parent: .model:parent
nodeLabel: .model:label
showBreadcrumb: false
}
recoding ranges #recodeSentiments {
intervals: "leftopen"
method: "case"
mapping #mapping {
from: "0.25.."
to: "Positive"
}
mapping #mapping_2 {
from: "-0.25..0.25"
to: "Neutral"
}
mapping #mapping_3 {
from: "..-0.25"
to: "Negative"
}
}
propagateFilter #propagateFilterModelToCategoryScore {
from: .model:
to: .categoryScore:
dropOriginal: false
}
propagateFilter #propagateFilterCategoryScoreToOverallScore {
from: .categoryScore:
to: .overallScore:
dropOriginal: false
}
propagateFilter #propagateFilterOverallScoreToResponses {
from: .overallScore:
to: .responses:
dropOriginal: false
}
propagateFilter #propagateFilterOverallScoreToAnalysisRecord {
from: .overallScore:
to: .analysisRecord:
dropOriginal: false
}
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
measure filter
Definition of measure filter
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure filter |
|||||
value |
Formula or question ID / alias |
reportingHierarchy selfRefCustom
Self-ref custom hierarchy
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|||||
mode |
Self-ref custom hierarchy mode |
rollup |
rollup | direct |
|||
nodeLabel |
column in the table used to display the label of the tree node |
|||||
nodeSorting |
Defines the system wide default sorting order for hierarchy nodes, defaults to alphabetical. |
alphabetical | byKeys | natural |
||||
parent |
column in the table that is used to build self-ref hierarchy tree |
|||||
where |
Post-filter to apply to all headers that use this hierachy |
dataset contacts
Dataset based on contact data source
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
response |
||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Date variable |
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
dataset cases
Dataset based on Action Management Cases data source
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
case |
||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Date variable |
Entities defined by default in dataset cases:
dateVariable #caseDateVariable {
value: :DateCreated
}
dateVariable #caseActivityDateVariable {
value: .caseActivity:DateModified
}
variable singleChoice #isOverdue {
table: .CASE:
value: IIF(.CASE:SystemStatus = "open" AND DiffDay(.CASE:DateDue, GetDate()) > 0, "yes", "no")
label: "Is Overdue"
option code #codeOption {
label: "Is Overdue"
code: "yes"
}
option code #codeOption_2 {
label: "Is Not Overdue"
code: "no"
}
}
measure custom #daysOpen {
value: DiffDay(.CASE:DateCreated, IIF(.CASE:SystemStatus = "open", GetDate(), .CASE:DateClosed))
label: "Days Open"
}
measure custom #daysOverdue {
value: IIF(cases:SystemStatus = "open" AND DiffDay(cases:DateDue, GetDate()) > 0, DiffDay(cases:DateDue, GetDate()), 0)
label: "Days Overdue"
}
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
dataset forstaSurvey
Dataset based on Forsta survey source
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
defaultTable |
Default table |
response |
||||
publicName |
Public name |
|||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||||
A virtual level representing many-to-many relation between two existing levels. |
||||||
Custom definition of measure function |
||||||
Definition of measure filter |
||||||
Date variable |
Entities defined by default in dataset forstaSurvey:
measure custom #responseRate {
value: 100 * count(:, :status = "complete" OR :status != "complete" AND :status != "error") / :surveyInvited()
label: "Response Rate (Includes partials)"
}
measure custom #responseRateMR {
value: 100 * count(:, :status = "complete") / :surveyInvited()
label: "Response Rate (Does not include partials)"
}
measure custom #surveyInvited {
value: count(.respondent:, .respondent:smtpstatus = "MessageSent")
label: ""
}
measure custom #respondents {
value: count(.respondent:)
label: ""
}
measure custom #numberOfResponses {
value: count(:)
label: "Number of responses"
}
measure custom #numberOfRespondents {
value: count(.respondent:)
label: "Number of respondents"
}
variable singleChoice #surveyResponseStatus {
table: .respondent:
value: IIF(.respondent:smtpstatus = "MessageSent", IIF(:status = "complete", "r", IIF(:status != "complete" AND :status != "error", "p", "n")))
label: "Status"
option code #status {
label: "Full Response"
code: "r"
}
option code #codeOption {
label: "Partial Response"
code: "p"
}
option code #codeOption_2 {
label: "No Response"
code: "n"
}
}
variable date #responseRateDate {
table: .respondent:
value: .respondent:createddate
label: "Date"
}
dateVariable #responseDateVariable {
value: .response:interview_start
}
dateVariable #respondentDateVariable {
applyTo: "respondent"
value: .respondent:CreatedDate
}
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
measure custom
Custom definition of measure function
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of measure function |
|||||
value |
Formula or question ID / alias |
|||||
Mean significance testing specification |
||||||
Proportional significance testing specification |
||||||
This setting allows the association of metadata with a measure expression, enhancing the measure’s functionality |
significance mean
Mean significance testing specification
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
argument |
Defines expression to use to calculate mean significance test |
reportingHierarchy selfRefLookup
Self-ref lookup hierarchy
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|||||
mode |
Self-ref custom hierarchy mode |
rollup |
rollup | direct |
|||
nodeSorting |
Defines the system wide default sorting order for hierarchy nodes, defaults to alphabetical. |
alphabetical | byKeys | natural |
||||
selectorOptions |
Self-ref lookup hierarchy source |
|||||
source |
Self-ref lookup hierarchy source |
|||||
where |
Post-filter to apply to all headers that use this hierachy |
reportingHierarchy surveyBased
Survey-based hierarchy
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|||||
where |
Post-filter to apply to all headers that use this hierachy |
|||||
Survey-based hierarchy level |
reportingHierarchy selfRefCustom
Self-ref custom hierarchy
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|||||
mode |
Self-ref custom hierarchy mode |
rollup |
rollup | direct |
|||
nodeLabel |
column in the table used to display the label of the tree node |
|||||
nodeSorting |
Defines the system wide default sorting order for hierarchy nodes, defaults to alphabetical. |
alphabetical | byKeys | natural |
||||
parent |
column in the table that is used to build self-ref hierarchy tree |
|||||
where |
Post-filter to apply to all headers that use this hierachy |
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 |
vtable twoWayLink [Deprecated]
A virtual level representing many-to-many relation between two existing levels.
dataTable
Specifies the data to retrieve with the use of dataGrid. These values can be referenced throughout CDL.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
data |
||||||
deps |
Explicitly defines dependencies for this dataTable that the system cannot automatically identify. These dependencies can include references to other dataTables. |
|||||
ifEmpty |
Fallback value to use if no row was found due to filtering or other reasons |
|||||
loadStrategy |
Specifies data loading strategy, can be used for optimisation. Accepts values: 'currentPageOnly', 'default'. |
currentPageOnly | initial |
||||
The Data Grid widget can be used to create a variety of table views, such as revenue tier with simple averages, key metrics (like NPS or OSAT) for those revenue tiers over a period of time, or show those key metrics for the levels of your hierarchy, and more. To illustrate changes in your key metrics: add chart visualizations, then toggle on significance testing to draw attention to where action needs to be taken. |
||||||
Map specified rows to some template |
||||||
Map specified row into cdl valid for vtable static |
dataGrid
The Data Grid widget can be used to create a variety of table views, such as revenue tier with simple averages, key metrics (like NPS or OSAT) for those revenue tiers over a period of time, or show those key metrics for the levels of your hierarchy, and more. To illustrate changes in your key metrics: add chart visualizations, then toggle on significance testing to draw attention to where action needs to be taken.
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 |
|||||
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) |
|||||
enableSortingByRowLabels |
Enable sorting by rows column label |
true | false |
||||
exportable |
This activates the possibility for the user to download the widget content as a Microsoft Excel (.xslx) file. |
true |
true | false |
|||
fixedHeader |
This defines whether the Table Header is to be fixed in position when the table is scrolled. |
true |
true | false |
|||
hide |
Hide item |
true | false | pdf | web |
||||
ignoreFilters |
A list of filter names to ignore. Container name can be used to ignore group of filters (e.g name of layout area) |
|||||
ignoreFiscalCalendar |
This allows you to use standard calendar instead of fiscal one |
true | false |
||||
ignoreWeights |
Use this property to specify any weights that have been defined but are to be ignored at this time. If the list contains multiple items, separate the items with comma. |
|||||
label |
Label (widget header) |
|||||
legendLabel |
Legend headers text |
|||||
navigateDirectNodeTo |
Input the name of the page that is to be navigated to when the user clicks the direct node link. |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|||||
postFilters |
Contains list of hierarchy filters which should be applied afterwards. |
|||||
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 |
|||
rowHeaderLabel |
Header label for the first row |
|||||
rowHeaderWidths |
Array of widths of row header in CSS units (px - pixels, mm - millimeters, cm - centimeters, in - inches, rem) |
|||||
showLegend |
Determined by color formatters thresholds will be displayed. It only works for tables with global, global and row, global and column cells |
false |
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. |
|||||
useOnlyExistingColumns |
Use only existing columns |
true | false |
||||
useOnlyExistingRows |
Use only existing rows |
true | false |
||||
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 |
||||
virtualize |
Virtualize table rows to improve performance. Highly recommended to use in conjunction with 'rowHeaderWidths' and 'width' on columns. |
true | false |
||||
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 |
||||||
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 cut by table header |
||||||
Data Grid cut by scope 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 cut by table header |
||||||
Data Grid row |
||||||
Variable row |
||||||
Variable list row, supports variableSet |
||||||
Data Grid selectedFlat row |
||||||
Data Grid comparisonFlat row |
||||||
Data Grid row drill down |
||||||
Data Grid nested headers row |
||||||
Indices row |
||||||
Data Grid comparison row |
||||||
Data Grid selectedHierarchy row |
||||||
Data Grid reportingHierarchy row |
||||||
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 |
||||||
This item creates a colored tile with a centered, colored digit of predefined width inside it. The tile is used to present metric data, and includes an arrow (up or down) or a flat icon located to the right of the digit to indicate how the value has changed from the previous period. |
||||||
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 |
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. |
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 closeModal An action that closes modal
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 |
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 |
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 |
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 |
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 |
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 |
|||||
skip |
The number of rows to be skipped, cannot be used if path to column is specified as sortBy |
|||||
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 |
first |
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. |
||||||
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 cut by table header |
||||||
Data Grid row |
||||||
Variable row |
||||||
Variable list row, supports variableSet |
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
|||||
Variable list row, supports variableSet |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
row cutByTable Data Grid cut by table header
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 |
Common label for a whole column |
|||||
labels |
A list of expressions to create labels for all levels of the header. |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
table |
The table that this header is based on |
|||||
take |
The number of items to take |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
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 |
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 |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
|||||
Variable list row, supports variableSet |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
row cutByTable
Data Grid cut by table header
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 |
Common label for a whole column |
|||||
labels |
A list of expressions to create labels for all levels of the header. |
|||||
showLabel |
Show label |
false |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
table |
The table that this header is based on |
|||||
take |
The number of items to take |
|||||
view |
defaultRowHeaderVisualizationView |
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 |
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 |
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 |
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row comparisonFlat
Data Grid comparisonFlat 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 |
|||
maxNodesToLoad |
Maximum number of nodes to load |
|||||
maxNodesToLoadWarning |
Warning text displayed if maximum number of nodes to load exceeded |
|||||
mode |
Overrides hierachy mode for this row |
direct | rollup | mixed |
||||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row drillDown
Data Grid row drill down
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 |
|||||
drillDown |
Drill down |
|||||
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}" |
|||||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row nestedHeaders
Data Grid nested headers row
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
removeEmptyParents |
Data Grid nested headers row remove empty parents property |
false |
true | false |
|||
viewMode |
View mode |
dynamic |
expanded | dynamic |
|||
Data Grid nested headers row nesting description |
||||||
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 comparisonFlat row |
||||||
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 comparisonFlat row |
nesting byTable Data Grid nested headers row nesting description
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
child |
Formula or question ID / alias |
|||||
parent |
Formula or question ID / alias |
parent 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 |
|||||
skip |
The number of rows to be skipped, cannot be used if path to column is specified as sortBy |
|||||
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 |
first |
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 |
parent 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
parent 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
parent 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
parent 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
parent 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 |
parent comparisonFlat Data Grid comparisonFlat 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 |
|||
maxNodesToLoad |
Maximum number of nodes to load |
|||||
maxNodesToLoadWarning |
Warning text displayed if maximum number of nodes to load exceeded |
|||||
mode |
Overrides hierachy mode for this row |
direct | rollup | mixed |
||||
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 |
child 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 |
|||||
skip |
The number of rows to be skipped, cannot be used if path to column is specified as sortBy |
|||||
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 |
first |
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 |
child 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
child 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
child 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
child 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 |
first |
none | first | last |
|||
totalLabel |
Total label |
|||||
value |
Formula or question ID / alias |
|||||
view |
defaultRowHeaderVisualizationView |
child 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 |
child comparisonFlat Data Grid comparisonFlat 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 |
|||
maxNodesToLoad |
Maximum number of nodes to load |
|||||
maxNodesToLoadWarning |
Warning text displayed if maximum number of nodes to load exceeded |
|||||
mode |
Overrides hierachy mode for this row |
direct | rollup | mixed |
||||
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 |
row indices
Indices 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 |
|||
indices |
Name of indices configuration |
|||||
label |
The label, accepts template values, for example: "{code} - {label}" |
|||||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
view |
defaultRowHeaderVisualizationView |
|||||
viewMode |
View mode |
dynamic |
collapsed | expanded | dynamic |
|||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row comparison
Data Grid comparison 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 |
|||||
exportLevelsDepth |
Count of expanded hierarchy levels for export |
|||||
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}" |
|||||
maxNodesToLoad |
Maximum number of nodes to load |
|||||
maxNodesToLoadWarning |
Warning text displayed if maximum number of nodes to load exceeded |
|||||
mode |
Overrides hierachy mode for this row |
direct | rollup | mixed |
||||
nodeIds |
Changes the reporting hierarchy nodes from default / selected in the filter to particular nodes |
|||||
reportingHierarchy |
Name of hierarchy configuration |
|||||
requestTotal |
Enables request for total regardless of showTotal. Required for formulas that reference a total. |
true | false |
||||
showTotal |
Enables total |
true |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row selectedHierarchy
Data Grid selectedHierarchy 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 |
|||||
exportLevelsDepth |
Count of expanded hierarchy levels for export |
|||||
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 |
|||||
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 |
|||||
requestTotal |
Enables request for total regardless of showTotal. Required for formulas that reference a total. |
true | false |
||||
showTotal |
Enables total |
true |
true | false |
|||
sortBy |
Path to column that data should be sorted by. |
|||||
sortOrder |
Sort order |
none | ascending | descending |
||||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
row reportingHierarchy
Data Grid reportingHierarchy 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 |
|||||
displayMode |
Display mode of hierarchy row. Has two options: 'nested' and 'flat' |
nested |
nested | flat |
|||
displayModeIcon |
Position of display mode icon. Has two options: 'left', 'right' |
left | right |
||||
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. |
|||||
exportLevelsDepth |
Count of expanded hierarchy levels for export |
|||||
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 |
|||
loadAll |
Try to load all data beforehand |
true | false |
||||
maxNodesToLoad |
Maximum number of nodes to load |
|||||
mode |
Overrides hierachy mode for this row |
direct | rollup | mixed |
||||
nodeIds |
Changes the reporting hierarchy nodes from default / selected in the filter to particular nodes |
|||||
reportingHierarchy |
Name of hierarchy configuration |
|||||
requestTotal |
Enables request for total regardless of showTotal. Required for formulas that reference a total. |
true | false |
||||
rowType |
Row type. Has two options: 'comparison' and 'selected' |
comparison |
selected | comparison |
|||
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
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 |
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 |
|||||
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 |
|||||
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 |
|||||
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 |
inner |
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 |
||||||
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 |
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 | |||
---|---|---|---|---|---|---|
formatString |
Format string for custom cell. Supports html. Example: '<b>{value1}</b> (#{rank})' |
|||||
tooltipFormatString |
Format string for custom cell tooltip. Example: '{value2}' |
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 |
map
Map specified rows to some template
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
data |
||||||
from |
Row header name to map |
|||||
ifEmpty |
Fallback value to use if no row was found due to filtering or other reasons |
|||||
to |
Template to map each row from 'from'. For example 'to: {value: this.columnHeader.columnLabel.value}'. Do note that access to row contents is specified by 'this' prefix |
|||||
If present, transform map result from array to a record, with a specififc keys |
||||||
If present, transform map result from array to a record, with indexes as keys |
config hubloader
This is the basic block to configure the hub loader.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
mappings |
The mappings to apply |
|||||
transforms |
The transforms to apply |
|||||
A block to define a dimension group |
||||||
A entity to create a table of dimensions |
||||||
A block to create a pivot table of variables |
||||||
A block to define changes to an existing table |
||||||
Recoding for a discrete value variable |
||||||
Recoding for a variable with ranges |
||||||
A block to create a pivot table of variables |
config layout
In this block you configure the general layout of the report.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
cardBackgroundColor |
This property specifies the background color of the widget. Input alpha-numeric hex codes (e.g. #388e3c) or Decimal code (e.g. rgba(225,69,0, 0.5) for the color. |
|||||
horizontalAlignmentMode |
This property specifies how the widgets are to be aligned horizontally (fourColumnsCentered | fullWidth | threeColumnsCentered | twoColumnsCentered). |
fourColumnsCentered | threeColumnsCentered | twoColumnsCentered | fullWidth |
||||
pageBackground |
This property specifies the background color or image of the report page. Input alpha-numeric hex codes (e.g. #388e3c), Decimal code (e.g. rgba(225,69,0, 0.5) for the color, URL to an image, base64 encoded image or linear-gradient (e.g. linear-gradient(180deg, #388e3c, #ffffff)). |
|||||
pageBackgroundColor [Deprecated] |
This property specifies the background color or image of the report page. Input alpha-numeric hex codes (e.g. #388e3c), Decimal code (e.g. rgba(225,69,0, 0.5) for the color, URL to an image, base64 encoded image or linear-gradient (e.g. linear-gradient(180deg, #388e3c, #ffffff)). |
|||||
pageBackgroundImage [Deprecated] |
This property specifies the background image of the report page. This should either be a URL to an image or a base64 encoded image. |
|||||
showHeader |
This defines whether or not the page header is to be presented on the page (true | false). |
true |
true | false |
|||
showNavigator |
This defines whether or not the navigation bar is to be presented on the page (true | false). |
true |
true | false |
config mobile
In this block you configure the mobile related settings.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
showShareButton |
Show the open in GO app button in the layout toolbar. |
false |
true | false |
config pdfExport
This object holds the configuration settings for PDF export
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
allowFileNaming |
This defines whether or not pdf file is to be named by user |
true | false |
||||
expandedHierarchyLevels |
This defines how many hierarchy levels should be expanded via pdf export |
|||||
exportMode |
This defines the export mode for the pdf export |
pdf | htmlToPdf |
||||
pageMargins |
Here you define the page margins for the export (in inches). If the margin property has four values: (top) (right) (bottom) (left). If the margin property has three values: (top) (right and left) (bottom). If the margin property has two values: (top and bottom) (right and left). If the margin property has one value: (all four margins). |
0.4 |
||||
pageOrientation |
This defines the page orientation (portrait | landscape). |
portrait | landscape |
||||
pageScaling |
Here you define how the page is to be scaled. It can be fitToWidth, fitToPage or noScaling. fitToWidth and fitToPage options are based on zooming page so that too wide/high elements are fitted to page width/whole page. Also using these options leads to taking into account page size via pdf export. |
fitToWidth | fitToPage | noScaling |
||||
pageSize |
This sets the page size. The property accepts one of the following values: Letter, Ledger, Tabloid, HalfLetter, Folio, Legal, Note, B5-B0, A10-A0. |
Letter | Ledger | Tabloid | HalfLetter | Folio | Legal | Note | B5 | B4 | B3 | B2 | B1 | B0 | A10 | A9 | A8 | A7 | A6 | A5 | A4 | A3 | A2 | A1 | A0 |
||||
rowLimit |
This defines table-based widgets row limit in pdf file |
|||||
version |
This defines export agent version |
1 |
config pdfExportSchedules
This object holds the configuration settings for PDF scheduled export
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
This object holds a single pdf export schedule setting. |
schedule
This object holds a single pdf export schedule setting.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
aggregateHierarchyNodes |
This defines how to send reports to users in hierarchy. |
false |
true | false |
|||
emailBody |
This defines the email body. |
|||||
emailFromEmail |
This defines the sender email. |
|||||
emailFromName |
This defines the sender name. |
|||||
emailSubject |
This defines the email subject. |
|||||
filterByEndUserIds |
When send to end users or end users wave is selected, this defines the list of end user ids. |
|||||
globalFilters |
This defines the global filters to be used for filtering the dashboard based on the selected filters |
|||||
includePdf |
This defines whether the email should contain a pdf attachment. |
false |
true | false |
|||
name |
This defines the name of the schedule |
|||||
pageOrientation |
This defines the exported pdf page orientation (portrait | landscape). |
portrait |
portrait | landscape |
|||
pageSize |
This sets the page size. The property accepts one of the following values: Letter, Ledger, Tabloid, HalfLetter, Folio, Legal, Note, B5-B0, A10-A0. |
A4 |
Letter | Ledger | Tabloid | HalfLetter | Folio | Legal | Note | B5 | B4 | B3 | B2 | B1 | B0 | A10 | A9 | A8 | A7 | A6 | A5 | A4 | A3 | A2 | A1 | A0 |
|||
reportPages |
This defines the pages identifiers included in the exported pdf |
|||||
sendToEmails |
This defines send to external emails type pdf scheduled export |
false |
true | false |
|||
sendToEndUsers |
This defines send to end users type pdf scheduled export |
false |
true | false |
|||
sendToHierarchy |
This defines send to hierarchy type pdf scheduled export |
false |
true | false |
|||
toEmails |
When send to external emails is selected, this defines the actual email list. |
|||||
toEndUserListId |
When send to end users is selected, this defines the end user list ID. |
0 |
||||
toEndUsers |
When send to end users is selected, this defines the list of end user ids. |
|||||
toWaveEndUsers |
When send to end users wave is selected, this defines the wave. |
|||||
workflowDocumentId |
The related workflow cdl document ID. |
0 |
||||
zoomPercentage |
This defines page scaling for the exported pdf. It must be an integer between 10 and 200. |
55 |
||||
This is the recurrent trigger definition of the scheduled export setting. |
trigger recurring
This is the recurrent trigger definition of the scheduled export setting.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
endAt |
This is the end at date the the trigger setting. |
|||||
format |
This is the trigger format the the trigger setting. |
Horizons |
||||
interval |
This is the schedule interval the the trigger setting. |
|||||
monthDays |
This is the month days the the trigger setting. |
|||||
recurrence |
This is the recurrence mode the the trigger setting. |
Once | Hourly | Daily | Weekly | Monthly |
||||
startAt |
This is the start at date the the trigger setting. |
|||||
weekdays |
This is the weekdays the the trigger setting. |
config pptExport
This object holds the configuration settings for PPT export
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
showExportButton |
This defines if ppt export is enabled |
false |
true | false |
config pulse
Pulse options
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
callbackPassword |
Callback password |
|||||
callbackUrl |
Callback url |
|||||
callbackUserName |
Callback user name |
|||||
canCreateSurveys |
Allow to create and commit surveys |
true |
true | false |
|||
contactDatabase |
Contact database project ID |
|||||
delayDaysBeforeFirstReminder |
Days delay to send first reminder |
|||||
delayDaysBeforeSubsequentReminders |
Days delay before subsequent reminders |
|||||
enablePagesForDimensions |
Enable individual pages for dimensions |
false |
true | false |
|||
enableSurveyDuplication |
Allow to duplicate surveys |
false |
true | false |
|||
enableSurveyNotes |
Switch to control survey notes |
true |
true | false |
|||
hierarchyQuestion |
Hierarchy for HR and Manager access |
|||||
languages |
Pulse survey languages |
|||||
librarySurvey |
Library survey project ID |
|||||
maxNumberOfQuestions |
Max number of questions |
|||||
maxNumberOfRecipients |
Maximum number of recipients |
|||||
minNumberOfRecipients |
Minimum number of recipients |
|||||
overviewPage |
Overview page |
|||||
reportAccessPage |
Report access page |
|||||
reportPage |
Report page |
|||||
sendInSelectedLanguageOnly |
Switch to send emails in selected language only |
false |
true | false |
|||
shareReportAccessWithSurveyRecipients |
Share report access with survey recipients |
false |
true | false |
|||
surveyDurationInDays |
Survey duration in days |
|||||
surveyInputPage |
Survey input page |
|||||
surveyListPage |
Survey list page |
|||||
totalReminders |
Total reminders count by default |
|||||
workflowPage |
Workflow page |
|||||
wpaPage |
WPA page |
|||||
Pulse custom questions prototypes |
||||||
Pulse template |
||||||
Config pulse dimension definition |
||||||
Config pulse reporting grid definition |
||||||
Pulse notifications |
||||||
Allows to specify survey freeze periods |
customQuestions
Pulse custom questions prototypes
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
maxNumber |
Max number of custom questions |
|||||
Pulse custom question prototype |
template pulse
Pulse template
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
additionalSelectableQuestions |
Allow templates to offer a subset of library questions for selection |
|||||
allowOpenLink |
Allow to create open link surveys |
true | false |
||||
emailInvite |
Email invitation template |
|||||
emailReminder |
Email reminder template |
|||||
isAvailable |
Allow to set user role access to templates |
true |
true | false |
|||
label |
Title of template |
|||||
languages |
Template languages |
|||||
locked |
Switch to control template questions |
false |
true | false |
|||
lockedQuestions |
Locked questions in template |
|||||
managerEmailInvite |
Manager email invite template |
|||||
managerEmailReminder |
Manager email reminder template |
|||||
notes |
Template notes |
|||||
openLinkSetting |
Set default for survey open link |
true | false |
||||
questions |
Questions in template |
|||||
samplingTemplate |
Allow templates to use selected sampling template |
dimension
Config pulse dimension definition
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
color |
Dimension color |
|||||
description |
Description of dimension |
|||||
icon |
Dimension icon |
|||||
label |
Title of dimension |
|||||
questions |
Questions in dimension |
reportingGrid
Config pulse reporting grid definition
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
customQuestionsAnswerLists |
Custom questions in reporting grid |
|||||
questions |
Questions in reporting grid |
|||||
targetAnswerList |
Target answer list reference |
|||||
Reporting grid recoding definition |
notifications
Pulse notifications
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
openLinkEmailTemplate |
Open link email template |
|||||
reportAccessEmailTemplate |
Report access email template |
config queryOptions
Config of query options
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
boolNullsAsFalse |
A boolean option defining whether NULLs in boolean values should be replaced by false values by Query Engine. Optional, true by default. |
true | false |
||||
cacheOff |
Disables response caching. The default value is false. |
true | false |
||||
explicitLevelAggregation |
By default if an aggregated table defines grouping on a child level (e.g. loop) and aggregates values from a parent table (e.g. response) values from the latter are duplicated for every loop record and aggregated values include duplicated source values. If set to true then every source record is considered once in each aggregation group. |
true | false |
||||
preserveDeleted |
If set to true, allows to see deleted answers. |
true | false |
||||
requestInfoKey |
Key for logging of the request body. If it is not specified, the request body is not logged if there are no errors. Default value is null. |
|||||
Optimization schema |
config report
This object holds the code to configure the report. It may include configurations for formatters, views and specification for widget defaults.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
enableInboxNotifications |
Show inbox notifications |
true | false |
||||
logoAlignment |
Align the logo |
left | center |
||||
minNumberOfAnswers |
Minimum number of answers |
|||||
minNumberOfResponses |
Minimum number of responses |
|||||
reportingDate |
Reporting date |
|||||
reportingPeriod |
Reporting period |
rollingMonth |
rollingWeek | rollingMonth | rollingYear |
|||
showPrintButton |
This defines whether or not the Print button is to be displayed in the toolbar |
true |
true | false |
|||
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
This block defines the threshold values at which the colors used in the dials and graphs in the widgets are to change, and the associated colors that are to be used for each range of values. Multiple color formatters can be used to define different color schemes; each formatter must have a unique name. |
||||||
This defines how numeric values are to be presented. The number formatter will not fail on text strings. If the value is an empty string, the number formatter will fall back to the value specified in |
||||||
This is a default value formatter. It makes no transformation to the value, apart from returning the string specified in |
||||||
Formats an 7ISO_8601 date to a human-readable form. If |
||||||
Formats date part variables and places them in one string. |
||||||
The text formatter defines how texts are to be displayed. Multiple text formatters can be used to define different text layouts; each formatter must have a unique name. If a text is an empty string and you want to output something specific, use the |
||||||
Formatter to pick property as value from object |
||||||
This block defines the threshold values at which the emojis/text used in the tiles and cells in the widgets are to change. |
||||||
This allows you to define custom palettes |
||||||
This allows you to define custom palettes by answer list |
||||||
Block for custom properties |
||||||
Suppression criteria for a widget |
||||||
Override minimum number of answers for selected questions |
||||||
Defines the template used in the report |
Entities defined by default in config report:
formatter value #valueDefaultFormatter {
}
formatter text #textDefaultFormatter {
length: 25
useDots: true
}
formatter color #kpiColorDefaultFormatter {
label: "Red Amber Green Percent (KPI)"
thresholds: #62b31c >= 100%, #ff8e00 >= 80%, #d40001 < 80%
defaultValue: #007db8
}
formatter color #gridDefaultValueColorFormatter {
label: "Red Amber Green Percent (Grid)"
thresholds: #388e3c >= 95%, #ff8e00 >= 90%, #d40000 < 90%
}
formatter color #gridDefaultBackgroundColorFormatter {
label: "Red Amber Green Background"
thresholds: #eef7ea >= 95%, #fff5e7 >= 90%, #ffecee < 90%
}
formatter color #surveyResponseColorDefaultFormatter {
label: "Red Amber Green Numeric"
thresholds: #62b31c > 8, #ff8e00 >= 5, #d40001 >= 0
}
formatter color #dropOffDefaultFormatter {
label: "One Color"
thresholds: #ffab00 >= 100%, #ffab00 < 100%
}
formatter color #taSentimentColorDefaultFormatter {
label: "TA Sentiment Color Numeric"
thresholds: #51ca3a > 0.25, #ff8e00 >= -0.25, #ff6b7e >= -5
defaultValue: #ff6b7e
}
formatter color #differenceDefaultFormatter {
label: "Green Red Numeric"
thresholds: #388e3c > 0, #d40000 < 0
}
formatter color #differenceDefaultPercentageFormatter {
label: "Green Red Percentage"
thresholds: #388e3c > 100%, #d40000 < 100%
}
formatter date #dataTemplateDateFormatter {
relative: true
locale: "en"
shortForm: true
datePart: "custom"
}
formatter date #dateDefaultFormatter {
locale: "en"
shortForm: true
relative: false
datePart: "custom"
}
formatter date #DoMMMYYYYDefaultFormatter {
formatString: "Do MMM YYYY"
locale: "en"
shortForm: true
relative: false
datePart: "custom"
}
formatter number #bigNumberFormatter {
label: "No Decimals"
numberDecimals: 0
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #currencyDefaultFormatter {
label: "Currency $"
numberDecimals: 0
prefix: "$"
shortForm: true
postfix: ""
decimalSeparator: "."
integerSeparator: " "
keepTrailingZeros: false
ordinal: false
}
formatter number #floatDefaultFormatter {
label: "Two Decimals with No Empty Value"
numberDecimals: 2
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #integerDefaultFormatter {
label: "Short Form"
numberDecimals: 0
shortForm: true
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
keepTrailingZeros: false
ordinal: false
}
formatter number #metricsItemMetricDefaultFormatter {
label: "One Decimal2"
numberDecimals: 1
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #numberStatisticDefaultFormatter {
numberDecimals: 2
label: "Two Decimals"
emptyValue: ""
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #oneDigitFloatDefaultFormatter {
label: "One Decimal"
numberDecimals: 1
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #percentDefaultFormatter {
label: "Percent One Decimal"
numberDecimals: 1
postfix: "%"
prefix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #statisticCountDefaultFormatter {
numberDecimals: 2
label: "Two Decimals2"
emptyValue: "0"
prefix: ""
postfix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #statisticPercentsDefaultFormatter {
numberDecimals: 2
label: "Percent Two Decimals"
postfix: "%"
emptyValue: "0%"
prefix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #baseDefaultFormatter {
label: "Base formatter"
prefix: "(N="
numberDecimals: 0
postfix: ")"
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter number #percentNoDecimal {
label: "Percent No Decimal"
numberDecimals: 0
postfix: "%"
emptyValue: "-"
prefix: ""
decimalSeparator: "."
integerSeparator: " "
shortForm: false
keepTrailingZeros: false
ordinal: false
}
formatter period #yearDefaultFormatter {
datePart: "year"
emptyValue: "-"
}
formatter period #quarterDefaultFormatter {
datePart: "quarter"
emptyValue: "-"
}
formatter period #monthDefaultFormatter {
datePart: "month"
emptyValue: "-"
}
formatter period #weekDefaultFormatter {
datePart: "week"
emptyValue: "-"
}
formatter period #dayDefaultFormatter {
datePart: "day"
emptyValue: "-"
}
formatter period #weekdayDefaultFormatter {
datePart: "weekday"
emptyValue: "-"
}
formatter period #hourDefaultFormatter {
datePart: "hour"
emptyValue: "-"
}
formatter period #calendarMonthDefaultFormatter {
datePart: "calendarMonth"
emptyValue: "-"
}
formatter period #calendarQuarterDefaultFormatter {
datePart: "calendarQuarter"
emptyValue: "-"
}
formatter period #calendarWeekDefaultFormatter {
datePart: "calendarWeek"
emptyValue: "-"
}
formatter period #calendarDateDefaultFormatter {
datePart: "calendarDate"
emptyValue: "-"
}
palette #defaultColorPalette {
label: "Default Color Palette"
colors: json`["#A4D357","#62B31C","#50C6F8","#9C75FF","#DAC9FF","#AEE7FF","#F5B8EA","#0097BE","#2EC4B6","#C7DF7D","#FFE000","#218380","#FFC802","#E85328","#FF8E00"]`
}
palette #singleColorPalette {
label: "Single Color"
colors: json`["#A4D357"]`
}
palette
This allows you to define custom palettes
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
colors |
List of colors of your custom palette |
|||||
label |
Label of your custom palette |
palette answerList
This allows you to define custom palettes by answer list
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
Label of your custom palette |
|||||
Palette answer list item |
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 |
config sampling
Sampling options
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
Sampling hierarchy selector |
||||||
Sampling contacts filter |
||||||
Sampling multi select filter |
||||||
Sampling randomization filter |
||||||
Sampling exclusion filter |
||||||
Sampling paste emails list |
||||||
Sampling contact email list filter |
||||||
Sampling template |
config style
In this block you configure the general style of the report.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
This block contains all the configuration such as css variables and AI settings for the theme generator feature. |
||||||
An instance of the style that can be used within the report. |
Entities defined by default in config style:
style #valueStyles {
fontSize: 40
fontWeight: 600
}
style #targetTextStyles {
fontSize: 16
fontWeight: 400
}
style #diffTextStyles {
fontSize: 16
fontWeight: 600
}
style #diffValueStyle {
switch #diffSwitch {
byValue: "value"
case #positive {
condition: ">0"
body #body {
color: "#0f766e"
background: "#0f766e1a"
}
}
case #negative {
condition: "<0"
body #body {
color: "#be185d"
background: "#be185d1a"
}
}
}
padding: "2px 4px"
borderRadius: "4px"
}
style #headingTitleStyles {
fontSize: 24
font: "var(--studio-heading-title-font, normal 600 24px 'Inter')"
color: "var(--studio-heading-title-color, #334155)"
}
style #headingSubtitleStyles {
fontSize: 16
font: "var(--studio-heading-subtitle-font, normal 400 16px 'Inter')"
color: "var(--studio-heading-subtitle-color, #0f172a)"
}
brandStyle brandVariables
This block contains all the configuration such as css variables and AI settings for the theme generator feature.
style
An instance of the style that can be used within the report.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
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 |
config voxpopme
This object holds the code used to configure Voxpopme
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
accountId |
This holds the Voxpopme account ID |
|||||
apiKey |
This holds the Voxpopme api key |
|||||
compositeIdAlias |
This defines an alias for the composite ID. This is the key for where you stored the composite ID, which comprises the project ID and the response ID |
confirmit_compositeId |