widget scatterChart

The Scatter chart widget is typically used to show the relationship between two sets of variables. This data is shown by placing various data points between the x- and y-axes. The goal of using this widget is to determine if there are patterns or correlations between the two variables.

Available properties

Name Description Default value Available options

animation

Use chart animation

false

true | false

cardAlign

This sets the widget card row alignment (top | center | bottom | none)

none

top | center | bottom | none

image

chartBackgroundColor

The background color of the chart.

chartBackgroundOpacity

The opacity of the background color.

dataSet

The name of dataset which will be used to resolve incomplete vpath

description

Description (widget header)

image

image

exportable

This activates the possibility for the user to download the widget content as an image. Using Confirmit Go mobile app, this permits the user to share and send a snapshot image of the widget to someone else.

true

true | false

image

gridLines

This defines the Grid lines display mode.

none | horizontal | vertical | both | perpendicular | parallel

image

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)

image

ignoreFiscalCalendar

This allows you to use standard calendar instead of fiscal one

true | false

image

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)

image

image

legend

Here you define the location of the legend on the chart. Allowed values are (none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight). Default value is none.

none

none | topLeft | topCenter | topRight | leftTop | leftMiddle | leftBottom | rightTop | rightMiddle | rightBottom | bottomLeft | bottomCenter | bottomRight

navigateTo

Page to navigate to or a cross-document link entity

image

image

palette

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

defaultColorPalette

image

postFilters

Contains list of filters which should be applied afterwards.

removeEmptyItems

Use this property to remove from the results all items that contain no data (true | false).

false

true | false

showValues

Use this property to show / hide item’s labels (true | false).

true

true | false

showWidgetHeader [Beta]

Shows widget header. True by default.

true | false

size

This defines the size of the widget when it is displayed on the Dashboard.

small

small | medium | halfwidth | large

image

image

useOnlySources

This defines the sources used by the widget to fetch data from.

useWeights

This property holds a list of the weights that are to be used by default.

via

Table(s) for join path conflict resolution

viaStrategy

Join path conflict resolution strategy

default | shortest

widgetVariant [Beta]

Widget variant

default | subtle | emphasised

Available objects

Name Description

Selector allows you to select option and exposes property 'selected' which can be referenced from any place

This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown.

This is widget documentation; information about the widget that is provided by the dashboard designer to the end report viewer. This allows the designer to add custom content for the widget "info" to provide the user with information necessary to understand the visualisation, type of analysis performed, data, etc. for example details about the risk model applied in the Risk assessment.

image

image

The Toolbar widget is typically used to highlight key information in a simple text format and a selector.

Suppression criteria for a widget

image

Options for optimization

Expression filter

image

This allows variables for a date filter to be redefined

image

This allows a level for a filter to be redefined

image

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

This code block enables you to define the Chart margins.

Scatter chart X axis

Scatter chart Y axis

Item list section

image

Item cut section

image

Item cut by multi section

image

Item date section

image

Item overlapping date section

image

Item filter section

image

Item drill down section

image

Item selected hierarchy section

image

Item selected flat section

image

Quadrant

Selector

select

Selector allows you to select option and exposes property 'selected' which can be referenced from any place

Name Description Default value Available options

applyOnEvent [Beta]

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

background

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

transparent

compareBy [Beta]

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

defaultOption

Use this property to set default option for select

delay [Beta]

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

label

Label of selector

mode

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

multi | single

onDefaultChange

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

reset | resetAndApply

options

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

image

preserveState [Beta]

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

true | false

resetOnEvent [Beta]

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

selected

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

selectedProperty

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

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

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

An action that closes modal

View resembling a table with customizable columns and selectable rows

Selector, that looks like list of checboxes or radiobuttons

Selector, that looks like tabs

action setSelector

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

Name Description Default value Available options

compareBy [Beta]

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

select

A reference that specifies the select entity in which the option should be selected.

image

value

Specifies the value of the option to be selected.

image

action sendEvent [Beta]

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

image

action closeModal [Beta]

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

button

A button located within the widget’s toolbar

Name Description Default value Available options

label

A menu option that opens upon clicking, which

An action that navigates to other page

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

An action that can open infobox with defined text and header

An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more

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

An action that closes modal

option

A menu option that opens upon clicking, which

Name Description Default value Available options

label

image

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

 action navigate [Beta]
An action that navigates to other page
Name Description Default value Available options

navigateFilter

Formula or question ID / alias

navigateHistory

Keep previous navigation filters

false

true | false

navigateTo

Page to navigate to or a cross-document link entity

image

image

 action showInfobox [Beta]
An action that can open infobox with defined text and header
Name Description Default value Available options

info

image

label

 action export [Beta]
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more
Name Description Default value Available options

format

Specifies the desired format for the exported file

png

png | default

action navigate [Beta]

An action that navigates to other page

Name Description Default value Available options

navigateFilter

Formula or question ID / alias

navigateHistory

Keep previous navigation filters

false

true | false

navigateTo

Page to navigate to or a cross-document link entity

image

image

action showInfobox [Beta]

An action that can open infobox with defined text and header

Name Description Default value Available options

info

image

label

action export [Beta]

An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more

Name Description Default value Available options

format

Specifies the desired format for the exported file

png

png | default

suppressRule

Suppression criteria for a widget

Name Description Default value Available options

criteria

Expression used to evaluate suppression

image

label

Text showed in case of suppression

image

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

image

image

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

image

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

image

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

image

scope filter

Changes applied filter to to different one

Name Description Default value Available options

name

Defining a scope filter name

image

value

Defining a scope filter value

propagateFilter

This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered

Name Description Default value Available options

dropOriginal

This flag allows to skip apply of the filter on 'source' level

false

true | false

from

A level reference specifying the source level

image

to

A level reference specifying the target level

image

chartMargin

This code block enables you to define the Chart margins.

Name Description Default value Available options

bottom

Define a margin between the bottom of the chart and the lower edge of the widget.

5

left

Define a margin between the left edge of the chart and the left edge of the widget.

5

right

Define a margin between the right edge of the chart and the right edge of the widget.

5

top

Define a margin between the top of the chart and the top edge of the widget.

5

axis x

Scatter chart X axis

Name Description Default value Available options

axisLine

Use this property to hide the axis line on this chart. If set to false, no axis line will be drawn (true | false).

true

true | false

image

format

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

image

hide

Use this property to hide the axis on this chart. If set to true, the axis will not be displayed in the chart (true | false).

false

true | false

image

label

Chart axis label value.

maxValue

Specify the maximum value of the axis.

image

minValue

Specify the minimum value of the axis.

image

orientation

Tick text orientation ("vertical" or degrees from -90 till 90).

0

vertical | 0 | 45 | -45 | 90 | -90

reversed

Reverse the ticks or not

true | false

strokeWidth

Change the width of the axis

textSize

Defines the size (width or height, depending on location) of the axis label text in pixels

tickLine

Use this property to include a tick-line on the chart. If set false, no axis tick-lines will be drawn. Bear in mind that adding this property and then specifying false is the same as not adding the property (true | false).

true

true | false

image

value

A valid value expression in table engine

image

axis y

Scatter chart Y axis

Name Description Default value Available options

axisLine

Use this property to hide the axis line on this chart. If set to false, no axis line will be drawn (true | false).

true

true | false

image

format

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

image

hide

Use this property to hide the axis on this chart. If set to true, the axis will not be displayed in the chart (true | false).

false

true | false

image

label

Chart axis label value.

maxValue

Specify the maximum value of the axis.

image

minValue

Specify the minimum value of the axis.

image

orientation

Tick text orientation ("vertical" or degrees from -90 till 90).

0

vertical | 0 | 45 | -45 | 90 | -90

reversed

Reverse the ticks or not

true | false

strokeWidth

Change the width of the axis

textSize

Defines the size (width or height, depending on location) of the axis label text in pixels

tickLine

Use this property to include a tick-line on the chart. If set false, no axis tick-lines will be drawn. Bear in mind that adding this property and then specifying false is the same as not adding the property (true | false).

true

true | false

image

value

A valid value expression in table engine

image

item list

Item list section

Name Description Default value Available options

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

image

maxSize

Maximum size

1000

minSize

Minimum size

100

record

The name of the filters for individual record selection

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

table

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

accounts:

value

A valid value expression in table engine

image

image

where

contains post-aggregation filter expression for the list section

Expression filter

image

Changes applied filter to to different one

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

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

item cut

Item cut section

Name Description Default value Available options

categories

Filter for categories used

collapseMulti

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

true | false

format

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

label

Value title

image

maxSize

Maximum size

1000

minSize

Minimum size

100

palette

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

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

value

A valid value expression in table engine

image

image

item cutByMulti

Item cut by multi section

Name Description Default value Available options

categories

Filter for categories used

format

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

label

Value title

image

maxSize

Maximum size

1000

minSize

Minimum size

100

palette

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

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

value

A valid value expression in table engine

image

image

item date

Item date section

Name Description Default value Available options

align

Set this property to true if date range should be aligned

true | false

breakdownBy

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

year

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

image

categories

Filter for categories used

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

image

maxSize

Maximum size

1000

minSize

Minimum size

100

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.

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

start

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

value

A valid value expression in table engine

image

image

item overlappingDate

Item overlapping date section

Name Description Default value Available options

align

Set this property to true if date range should be aligned

true | false

breakdownBy

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

year

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

image

categories

Filter for categories used

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.

image

format

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

label

Value title

image

maxSize

Maximum size

1000

minSize

Minimum size

100

palette

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

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

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.

value

A valid value expression in table engine

image

image

item filter

Item filter section

Name Description Default value Available options

format

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

label

Value title

image

maxSize

Maximum size

1000

minSize

Minimum size

100

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

value

A valid value expression in table engine

image

image

valueText

Value text

image

item drillDown

Item drill down section

Name Description Default value Available options

drillDown

Drill down

image

label

Value title

image

maxSize

Maximum size

1000

minSize

Minimum size

100

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

item selectedHierarchy

Item selected hierarchy section

Name Description Default value Available options

label

Value title

image

labelSeparator

Label separator

maxSize

Maximum size

1000

minSize

Minimum size

100

reportingHierarchy

Reporting hierarchy

image

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

item selectedFlat

Item selected flat section

Name Description Default value Available options

label

Value title

image

labelSeparator

Label separator

labelStyle

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

fullPath

nodeOnly | fullPath

maxSize

Maximum size

1000

minSize

Minimum size

100

reportingHierarchy

Reporting hierarchy

image

scale

Size scale option

auto

auto | linear | pow | sqrt | log | identity | time | band | point | ordinal | quantile | quantize | utc | sequential | threshold

shape

Size scale option

circle

circle | cross | diamond | square | star | triangle | wye

size

A valid value expression in table engine

image

sizeFormat

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

quadrant

Quadrant

Name Description Default value Available options

colors

Quadrant colors

titles

Quadrant titles

image

selector

Selector

Name Description Default value Available options

label

Selector option

option

Selector option

Name Description Default value Available options

label

Selector option content

content

Selector option content

Name Description Default value Available options

Item list section

image

Item cut section

image

Item cut by multi section

image

Item date section

image

Item overlapping date section

image

Item filter section

image

Item drill down section

image

Item selected hierarchy section

image

Item selected flat section

image

Scatter chart X axis

Scatter chart Y axis

Quadrant