widget chart

applyOnEvent [Beta]

This property buffers changes to the local state of the select. Changes are not applied directly to the model, but are stored and only applied when a specified event occurs.

background

Set the background of the select; currently this only supports transparent as an option

transparent

compareBy [Beta]

This property allows the selection check in the selector to be based on any option’s property, instead of the default value. By setting compareBy to this.label or this.id, you can customize the attribute used to determine which option is selected.

defaultOption

Use this property to set default option for select

delay [Beta]

Sets the number of milliseconds to wait before applying the selector, effective in 'multi' mode

label

Label of selector

mode

Use this property to switch select type from single-choice to multi-choice

multi | single

onDefaultChange

Use this property to change behavior of selector when defaultOption is changed dynamically

reset | resetAndApply

options

List of options, consist of entities with mainType 'item' and properties 'value' and 'label'

preserveState [Beta]

This property determines whether the previous selection will remain when the select is shown again. If set to true, the previous selection will persist each time the select is made visible.

true | false

resetOnEvent [Beta]

This property resets the state of the select even if it’s buffered.

selected

Selected option value, it is set by system automatically, depends on user choice

selectedProperty

Entity with properties of entity within value, it is set by system automatically, depends on user choice

action setSelector

An action that allows setting a specific option in a selector.

action sendEvent [Beta]

An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard

action closeModal [Beta]

An action that closes modal

view listBox

View resembling a table with customizable columns and selectable rows

view list

Selector, that looks like list of checboxes or radiobuttons

view tabs [Beta]

Selector, that looks like tabs

button

A button located within the widget’s toolbar

criteria

Expression used to evaluate suppression

label

Text showed in case of suppression

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

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

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

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

name

Defining a scope filter name

value

Defining a scope filter value

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

barColorFormat

This is the conditional formatter to define the bar color.

barGap

The gap between two bar in the same category in pixels.

barSize

The width or height of each bar in pixels. If the barSize is not specified or bars with the specified values don’t fit, the size of bar will be calculated automatically. Note: it will only work if you specify barSize for all bars.

dataLabel

Changes the data label options

value | percent | percentThenValue | valueThenPercent | hide

gradientFill [Beta]

Changes the fill to a gradient based on the offset values provided

legendType

The interpolation type of line

line | square | rect | circle | cross | diamond | square | star | triangle | wye | none

maxBarSize

The maximum width or height of each bar in pixels. If the maxBarSize is not specified or bars with the specified values don’t fit, the maximum size of bar will be calculated automatically.

mode

This property changes the chart mode.

clustered

stacked | stacked100Percent | clustered

percentFormat

Formatter for percentage labels.

showBase

Show number of responses

false

true | false

showBaseInTooltip

Show base of a series in tooltip

true

true | false

showValue

Specifies whether the value is to be displayed or not.

true

true | false

stackId

The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL.

valueLabel

Changes the display values along with labels

valuePosition

Changes the display position of value in chart

inner

inner | outer

connectNulls

Whether to connect a graph line across null points.

true

true | false

dotColorFormat

Conditional formatter for dot color.

dotSize

Dot size

3

gradientFill [Beta]

Changes the fill to a gradient based on the offset values provided

legendType

The interpolation type of line

line | square | rect | circle | cross | diamond | square | star | triangle | wye | none

lineType

The interpolation type of line

basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter

lineWidth

This property allows to specify the custom width for the chart lines.

2

mode

This property changes the chart mode.

clustered

stacked | stacked100Percent | clustered

showBaseInTooltip

Show base of a series in tooltip

true

true | false

stackId

The stack ID of the bar. When two bars have the same value axis and the same stackId, then the two bars are stacked in the order in which they appear in the CDL.

connectNulls

Whether to connect a graph line across null points.

true

true | false

dotColorFormat

Conditional formatter for dot color.

dotSize

Dot size

3

legendType

The interpolation type of line

line | square | rect | circle | cross | diamond | square | star | triangle | wye | none

lineType

The interpolation type of line

basis | basisClosed | basisOpen | linear | linearClosed | natural | monotoneX | monotoneY | monotone | step | stepBefore | stepAfter

lineWidth

This property allows to specify the custom width for the chart lines.

2

showBase

Show number of responses

false

true | false

showBaseInTooltip

Show base of a series in tooltip

true

true | false

showDotValue

Specifies whether the dot value is to be displayed or not.

false

true | false

style [Beta]

Define which style of chart to render

comparison_line | comparison_bar

innerRadius

The inner radius of all the sectors.

legendType

The interpolation type of line

line | square | rect | circle | cross | diamond | square | star | triangle | wye | none

outerRadius

The outer radius of all the sectors.

showBase

Show number of responses

false

true | false

showBaseInTooltip

Show base of a series in tooltip

true

true | false

showValue

Specifies whether the value is to be displayed or not.

true

true | false

valuePosition

Changes the display position of value in chart

inner | outer

dotColorFormat

Conditional formatter for dot color.

dots

Visibility of graph dots

false

true | false

dotSize

Dot size

3

legendType

The interpolation type of line

line | square | rect | circle | cross | diamond | square | star | triangle | wye | none

max

Define a maximum value for the chart axis (the value may be 'auto', 'dataMax' or a number value)

auto

auto | dataMax

min

Define a maximum value for the chart axis (the value may be 'auto', 'dataMin' or a number value)

auto

auto | dataMin

shape

Chart shape

polygon

polygon | circle

showBaseInTooltip

Show base of a series in tooltip

true

true | false

tickCount

The count of axis ticks

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

format

Accepts an identifier of a formatter which transforms value to a custom format

hierarchy

Hierarchical field (vpath) - a field to define parent-child relations when building hierarchy (example - accounts:ParentAccountID)

label

Value title

record

The name of the filters for individual record selection

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

table

The name of the table (alias) for the widget to work with

accounts:

take

The number of cells to be fetched, cannot be used if path to series is specified as sortBy

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

where

contains post-aggregation filter expression for the list section

base

Chart report base

filter expression

Expression filter

scope filter

Changes applied filter to to different one

scope reportingPeriod

Changes the reporting period from default / selected in the filter to different one

scope reportingHierarchy

Changes the reporting hierarchy nodes to be used from default/selected in filter to different one

categories

Filter for categories used

collapseMulti

When set to true, this header acts like 'cutByMulti' for multi-choice variables, while it has no effect on other types of valriables.

true | false

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

format

Accepts an identifier of a formatter which transforms value to a custom format

label

Value title

palette

Here you define the custom list of colors that are to be applied to the lines in the category.

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

base

Chart report base

categories

Filter for categories used

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

format

Accepts an identifier of a formatter which transforms value to a custom format

label

Value title

palette

Here you define the custom list of colors that are to be applied to the lines in the category.

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

base

Chart report base

align

Set this property to true if date range should be aligned

true | false

breakdownBy

Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour).

year

year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour

categories

Filter for categories used

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

end

Contains description of range end, applies filter to the date expression.

format

Accepts an identifier of a formatter which transforms value to a custom format

label

Value title

movingAverageEnd

This defines a number of date parts after current to include in average window

movingAverageStart

This defines a number of date parts before current to include in average window

palette

Here you define the custom list of colors that are to be applied to the lines in the category.

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

start

Contains description of range start, applies filter to the date expression.

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

base

Chart report base

align

Set this property to true if date range should be aligned

true | false

breakdownBy

Here you input the time set that is to be used to divide up the Expression (year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour).

year

year | calendarQuarter | calendarMonth | calendarWeek | calendarDate | quarter | month | week | day | weekday | hour

categories

Filter for categories used

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

end

Contains description of range end, applies filter to the date expression.

endShift

Modification of ends of breakdown intervals in the form '<value> <period>'. Here 'value' is integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then the ends of the breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks.

format

Accepts an identifier of a formatter which transforms value to a custom format

label

Value title

palette

Here you define the custom list of colors that are to be applied to the lines in the category.

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

start

Contains description of range start, applies filter to the date expression.

startShift

Modification of starts of breakdown intervals in the form '<value> <period>'. Here 'value' is an integer (both positive and negative). 'period' can be 'year', 'quarter', 'month', 'week', 'day', 'hour'. If the property is absent, then starts of breakdown intervals will not be modified. Be aware that not all possible periods are valid for each breakdown interval. For example, if you breakdown dates by CalendarMonth you cannot then shift them by quarters. Also, shifts by weeks is only available for breakdown by weeks.

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

base

Chart report base

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

format

Accepts an identifier of a formatter which transforms value to a custom format

fromSeries

Transfer from series

label

Value title

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

base

Chart report base

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

format

Accepts an identifier of a formatter which transforms value to a custom format

label

Value title

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

value

A valid value expression in table engine

valueLabel

Value label

base

Chart report base

drillDown

Drill down

label

Value title

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

label

Value title

reportingHierarchy

Reporting hierarchy

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

base

Chart report base

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

label

Value title

labelSeparator

Label separator

reportingHierarchy

Reporting hierarchy

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

base

Chart report base

emptyFirst

For some header cells desired values can be empty. This setting specifies if such cells should go before or after others. Default value is false.

false

true | false

label

Value title

labelSeparator

Label separator

labelStyle

Hierarchy label display style. Has two options: nodeOnly and fullPath

fullPath

nodeOnly | fullPath

reportingHierarchy

Reporting hierarchy

sortBy

A valid series identifier or path to breakdown.

sortIndex

Defines which column on the other side of the table (from the header) the values are to be taken from. You can use negative values here. -1 means the last row/column. Default value is -1.

-1

sortOrder

Specify how the chart widget is to be sorted (none (default) | ascending | descending).

none

none | ascending | descending

takeBottom

Specifies how many cells are to be taken, starting at the bottom of the column.

takeTop

Specifies how many cells are to be taken, starting at the top of the column.

base

Chart report base

base

A valid expression for calculating the base of a series.

compare

Comparison mode for significance testing, 'parent' will compare among the hierarchy, 'next', 'first', 'last', 'previous' - compares column or row with next/first/etc column or row. 'adjacent' compares column with adjacent column. (Same as 'previous', preserved for compatability reasons),

adjacent | parent | all | previous | next | first | last | totalexclusive

confidenceLevels

Significance testing confidence levels

80 | 90 | 95 | 98 | 99 | 99.8

format

Accepts an identifier of a formatter which transforms value to a custom format

isSecondary

false

true | false

label

A valid value expression in table engine.

navigateFilter

Formula or question ID / alias

navigateHistory

Keep previous navigation filters

false

true | false

navigateTo

Page to navigate to or a cross-document link entity

palette

Here you define the custom list of colors that are to be applied to the lines in the series.

percentOver

The value will be calculated as a percentage of a full bar. It could be calculated over series or over categories.

series | categories

significanceTesting

Enables significance testings. Note: it is not available for multi and overlapping date categories, Pie, Radar and intra-series breakdown charts.

true | false

threshold

Sample threshold for significance test evaluation. If the value is specified then a test is not computed for smaller samples.

value

A valid value expression in table engine.

breakdownBy cut

Breakdown by cut section

breakdownBy cutByMulti

Breakdown by cut by multi section

breakdownBy date

Breakdown by date section

breakdownBy overlappingDate

Breakdown by overlapping date section