create_plot_insight

Usage

The following shows how the step can be used in a recipe.

Examples

Signature

General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.

create_plot_insight(, {
    "param": value,
    ...
})

Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").

Inputs

Outputs

Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

selectedChart

string

default:"Area Chart"

required

Area Chart. Area Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

The element’s position and size. The position refers to the top-left corner of the rectangle representing the insight element, while the size is given by its width and height. For reference, the entire insight is 12 units wide and 9 units high, and the origin (0, 0) of the x/y coordinates is in its top-left corner.

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

Time unit to specify the discretization period.Values must be one of the following:MILLISECOND SECOND MINUTE HOUR DAY YEAR_DAY MONTH_DAY WEEK_DAY WEEK WEEK_OF_YEAR MONTH QUARTER YEAR

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

foregroundColor

string

Chart markers foregroundColor.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

stat

object

Stat configuration. For example, for a max stat it would be: { "stat": "max" } For stats that require a param like “countWhere” or “percentOfRowsWhere” it would be: { "stat": "countWhere", "params": { "value": "categoryName" } }

Properties

stat

string

Stat kind.Values must be one of the following:sum mean variance standardDeviation skewness kurtosis min p25 p50 p75 max nNulls precision count cumSum nodeCount rForeground rForegroundColor rForegroundX uniqueValues valueCount countWhere percentOfRowsWhere

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

Theme color palette applied to the chart.Values must be one of the following:Horus Osiris Re Blues Greens Oranges Purples Reds Viridis Magma Plasma Red-Blue Blue-Orange Red-Grey Red-Yellow-Blue Red-Yellow-Green graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

Aggregation method to apply to the column. Only for values with AGGREGATED_COLUMN kind.Values must be one of the following:SUM AVG VARIANCE STDEV MIN P25 P50 P75 MAX MODE UNIQUE_VALUES LIST LIST_UNIQUE CONCATENATE COUNT ELEMENT_COUNT ELEMENT_MIN ELEMENT_MAX ELEMENT_SUM ELEMENT_AVG ELEMENT_VARIANCE ELEMENT_STDEV

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Bar Chart"

required

Bar Chart. Bar Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

barPaddings

object

Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.

Properties

inner

number

Inner padding between bars.

outer

number

Outer padding for bars.

chartDescription

string

Chart description.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

foregroundColor

string

Chart markers foregroundColor.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Box Plot Chart"

required

Box Plot Chart. Box Plot Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

boxPlotStat

string

required

Defines the metrics to be drawn in BoxPlot charts.Values must be one of the following:

quartiles
quartiles+IQR
quartiles+min/max
mean+standardDeviation

chartDescription

string

Chart description.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

foregroundColor

string

Chart markers foregroundColor.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Bubble Chart"

required

Bubble Chart. Bubble Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

foregroundColor

string

Chart markers foregroundColor.

hideLegendSizeTitle

boolean

Hides chart size legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendSizeTitle

string

Chart size legend title.

nodesSize

[number, object]

Nodes size in scatterplot charts. Can define a fixed value or a min & max value in px to map nodes size.

Options

number
object

{_}

number

number.

opacity

number

Nodes opacity in scatterplot charts.

scatterplotMetrics

object

Metrics shown in scatterplot charts. Defines if regression line, RSquared or Pearson coefficient metrics are displayed.

Properties

showRegressionLine

boolean

Whether to show a regression line.

showRSquared

boolean

Whether to show RSquared metric.

showPearson

boolean

Whether to show Pearson coefficient metric.

size

object

required

Slot value that maps bubble size in scatterplot charts. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

sizeSelection

[array, array]

Selection applied to the column that maps bubble size in scatterplot charts. It can be an array with the categories selected in categorical columns, or an array with the range of the selection for quantitative or date columns.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

Fields in tooltip. A list of fields to show in tooltip for Scatterplot charts.

Array items

Item

string

Each item in array.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

selectedChart

string

default:"Bubble Colored Chart"

required

Bubble Colored Chart. Bubble Colored Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date.

aggregation

string

colorCategories

array[string]

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

hideLegendColorTitle

boolean

Hides chart color legend title.

hideLegendSizeTitle

boolean

Hides chart size legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

legendSizeTitle

string

Chart size legend title.

nodesSize

[number, object]

Nodes size in scatterplot charts. Can define a fixed value or a min & max value in px to map nodes size.

Options

number
object

{_}

number

number.

opacity

number

Nodes opacity in scatterplot charts.

scatterplotMetrics

object

Metrics shown in scatterplot charts. Defines if regression line, RSquared or Pearson coefficient metrics are displayed.

Properties

showRegressionLine

boolean

Whether to show a regression line.

showRSquared

boolean

Whether to show RSquared metric.

showPearson

boolean

Whether to show Pearson coefficient metric.

size

object

required

Slot value that maps bubble size in scatterplot charts. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

sizeSelection

[array, array]

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

Fields in tooltip. A list of fields to show in tooltip for Scatterplot charts.

Array items

Item

string

Each item in array.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

selectedChart

string

default:"Grouped Bar Chart"

required

Grouped Bar Chart. Grouped Bar Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

barPaddings

object

Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.

Properties

inner

number

Inner padding between bars.

outer

number

Outer padding for bars.

chartDescription

string

Chart description.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Heat Map Chart"

required

Heat Map Chart. Heat Map Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

cell

object

required

Slot value used to apply color to each cell in Heatmap charts. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

cellTitle

string

Color legend title in Heatmap charts.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationY

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationIsExactY

boolean

Defines if the discretization in the Y axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

discretizationUseQuantilesY

boolean

Defines if the discretization in the Y axis uses quantiles.

hideCellTitle

boolean

Hides chart color legend title in Heatmap charts.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

sortY

string

Chart sorting applied to chart in the y axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortYDirection

string

Chart sorting direction applied to chart in the y axis.Values must be one of the following:

ASC
DESC

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Line Chart"

required

Line Chart. Line Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

foregroundColor

string

Chart markers foregroundColor.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

lineDash

object

Line dash pattern. Configures the dash pattern for lines in line charts.

Properties

default

[null, array]

Default dash pattern for lines. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

custom

object

Custom dash pattern. Allows setting a specific dash pattern for the selected categories.

Pattern properties

[null, array]

The custom dash pattern for the selected category. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

lineMarkers

object

Line markers. Configures the markers for lines in line charts.

Properties

default

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

custom

object

Custom line markers. Allows setting a specific line marker for the selected categories.

Pattern properties

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

lineWidth

object

Line width settings. Specifies the width of the lines in line charts.

Properties

default

number

Default line width.

custom

object

Custom line width. Allows setting a specific line width for the selected categories.

Pattern properties

[number, null]

The custom line width for the selected category.

missingValues

string

Defines how to represent null values in line charts.Values must be one of the following:

interpolated
gap
zero

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zerosAsNulls

boolean

Defines if zero values should be represented as null in line charts.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Multiple Line Chart"

required

Multiple Line Chart. Multiple Line Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

lineDash

object

Line dash pattern. Configures the dash pattern for lines in line charts.

Properties

default

[null, array]

Default dash pattern for lines. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

custom

object

Custom dash pattern. Allows setting a specific dash pattern for the selected categories.

Pattern properties

[null, array]

The custom dash pattern for the selected category. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

lineMarkers

object

Line markers. Configures the markers for lines in line charts.

Properties

default

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

custom

object

Custom line markers. Allows setting a specific line marker for the selected categories.

Pattern properties

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

lineWidth

object

Line width settings. Specifies the width of the lines in line charts.

Properties

default

number

Default line width.

custom

object

Custom line width. Allows setting a specific line width for the selected categories.

Pattern properties

[number, null]

The custom line width for the selected category.

missingValues

string

Defines how to represent null values in line charts.Values must be one of the following:

interpolated
gap
zero

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zerosAsNulls

boolean

Defines if zero values should be represented as null in line charts.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Scatterplot Chart"

required

Scatterplot Chart. Scatterplot Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

foregroundColor

string

Chart markers foregroundColor.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

nodesSize

[number, object]

Nodes size in scatterplot charts. Can define a fixed value or a min & max value in px to map nodes size.

Options

number
object

{_}

number

number.

opacity

number

Nodes opacity in scatterplot charts.

scatterplotMetrics

object

Metrics shown in scatterplot charts. Defines if regression line, RSquared or Pearson coefficient metrics are displayed.

Properties

showRegressionLine

boolean

Whether to show a regression line.

showRSquared

boolean

Whether to show RSquared metric.

showPearson

boolean

Whether to show Pearson coefficient metric.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

Fields in tooltip. A list of fields to show in tooltip for Scatterplot charts.

Array items

Item

string

Each item in array.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

selectedChart

string

default:"Scatterplot Colored Chart"

required

Scatterplot Colored Chart. Scatterplot Colored Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date.

aggregation

string

colorCategories

array[string]

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

nodesSize

[number, object]

Nodes size in scatterplot charts. Can define a fixed value or a min & max value in px to map nodes size.

Options

number
object

{_}

number

number.

opacity

number

Nodes opacity in scatterplot charts.

scatterplotMetrics

object

Metrics shown in scatterplot charts. Defines if regression line, RSquared or Pearson coefficient metrics are displayed.

Properties

showRegressionLine

boolean

Whether to show a regression line.

showRSquared

boolean

Whether to show RSquared metric.

showPearson

boolean

Whether to show Pearson coefficient metric.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

Fields in tooltip. A list of fields to show in tooltip for Scatterplot charts.

Array items

Item

string

Each item in array.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type number or date.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

selectedChart

string

default:"Seasonal Decomposition Chart"

required

Seasonal Decomposition Chart. Seasonal Decomposition Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

discretizationX

[object, object, object]

required

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

seasonalityInterval

number

required

Seasonality interval for Seasonal Decomposition plot.

segmentExpanded

string

expanded segment in Seasonal Decomposition plot.

stat

object

required

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type date.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zerosAsNulls

boolean

Defines if zero values should be represented as null in line charts.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Segmented Area Chart"

required

Segmented Area Chart. Segmented Area Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Segmented Bar Chart"

required

Segmented Bar Chart. Segmented Bar Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

barPaddings

object

Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.

Properties

inner

number

Inner padding between bars.

outer

number

Outer padding for bars.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Segmented Line Chart"

required

Segmented Line Chart. Segmented Line Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

lineDash

object

Line dash pattern. Configures the dash pattern for lines in line charts.

Properties

default

[null, array]

Default dash pattern for lines. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

custom

object

Custom dash pattern. Allows setting a specific dash pattern for the selected categories.

Pattern properties

[null, array]

The custom dash pattern for the selected category. It is represented as an array of stroke and gap lengths.

Options

null
array

{_}

null

null.

lineMarkers

object

Line markers. Configures the markers for lines in line charts.

Properties

default

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

custom

object

Custom line markers. Allows setting a specific line marker for the selected categories.

Pattern properties

object

Line marker. Configures a line marker.

Properties

shape

string

The shape of the marker.Values must be one of the following:

circle
square
triangle

color

string

The color of the marker.

size

number

The area of the marker in pixels.

lineWidth

object

Line width settings. Specifies the width of the lines in line charts.

Properties

default

number

Default line width.

custom

object

Custom line width. Allows setting a specific line width for the selected categories.

Pattern properties

[number, null]

The custom line width for the selected category.

missingValues

string

Defines how to represent null values in line charts.Values must be one of the following:

interpolated
gap
zero

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zerosAsNulls

boolean

Defines if zero values should be represented as null in line charts.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Stacked Area Chart"

required

Stacked Area Chart. Stacked Area Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

stat

object

required

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Stacked Bar Chart"

required

Stacked Bar Chart. Stacked Bar Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

barPaddings

object

Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.

Properties

inner

number

Inner padding between bars.

outer

number

Outer padding for bars.

chartDescription

string

Chart description.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Stacked 100% Area Chart"

required

Stacked 100% Area Chart. Stacked 100% Area Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

chartDescription

string

Chart description.

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

interpolation

string

Interpolation method used for line or area chart.Values must be one of the following:linear monotone cardinal natural step step-before step-after

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

stat

object

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Stacked 100% Bar Chart"

required

Stacked 100% Bar Chart. Stacked 100% Bar Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

annotations

array[object]

Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.

Array items

align

string

Alignment of the annotation.Values must be one of the following:

start
center
end

label

string

Text of the comment.

shape

object

Annotations shape. Annotations shape configuration.

Properties

type

string

Annotation shape type.Values must be one of the following:

arrow

endpoint

string

Annotation endpoint type for arrow shape.Values must be one of the following:

line
solid
none

lineStyle

string

Annotation shape line style.Values must be one of the following:

solid
dashed

stroke

string

Annotation shape line color.

strokeDash

array[number]

Annotation shape line dash.

Array items

Item

number

Each item in array.

strokeWidth

number

Annotation shape line width.

number

Annotation shape endpoint position x for arrow shape.

number

Annotation shape endpoint position y for arrow shape.

style

object

Annotations style. Annotation label style configuration.

Properties

fill

string

Annotation label color.

fontSize

number

Annotation label font size in pixels.

fontStyle

string

Annotation label font style.Values must be one of the following:

bold
italic
normal

[object, object, object]

X axis value. X axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in X axis.

value

[number, string]

required

Annotation value in X axis.

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in X axis.

[object, object, object, object]

Y axis value. Y axis value where the annotation is placed.

Options

Value annotation placed over a value in the axis
Stat value annotation placed over a stat value in the axis
Stat annotation placed over a calculated stat in the axis
Value annotation placed relative to canvas dimensions

kind

string

required

Annotation kind.Values must be one of the following:

VALUE

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT_VALUE

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.

value

[number, string]

required

Annotation value in Y axis.

kind

string

required

Annotation kind.Values must be one of the following:

STAT

hideValue

boolean

Whether to hide the annotation value in the label.

stat

string

required

Annotation stat in Y axis.Values must be one of the following:max mean median min q1 q3

kind

string

required

Annotation kind.Values must be one of the following:

POSITION

value

number

required

Annotation position in Y axis.

barPaddings

object

Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.

Properties

inner

number

Inner padding between bars.

outer

number

Outer padding for bars.

chartDescription

string

Chart description.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

chartFooter

string

Chart footer text.

chartSize

[string, object]

Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.

Options

string
object

{_}

string

string.Values must be one of the following:

automatic

chartSubtitle

string

Chart subtitle.

chartTitle

string

Chart title.

color

object

required

Slot value used to map color in the chart. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or date.

aggregation

string

colorCategories

array[string]

required

Categories of the color variable.

Array items

Item

string

Each item in array.

discretizationColor

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationX

[object, object, object]

Discretization configuration for a slot (x, y or color). There is different kind of discretization configurations depending on column type:

For quantitative ones a single count defining the number of bins is enough
For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
For dates we need a date period & a count of periods.

Options

object
object
object

count

number

required

Number of bins in the axis.

count

number

required

Number of bins in the axis.

direction

string

required

Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.Values must be one of the following:

ASC
DESC

count

number

required

Number of time units that sets the size of the discretization.

period

string

required

isRecurrentPeriod

boolean

Defines if the period is a recurrent one (i.e. WEEK_DAY).

discretizationIsExactX

boolean

Defines if the discretization in the X axis uses a exact or pretty number of bins.

discretizationUseQuantilesX

boolean

Defines if the discretization in the X axis uses quantiles.

hideLegendColorTitle

boolean

Hides chart color legend title.

hideXTitle

boolean

Hides chart X axis title.

hideYTitle

boolean

Hides chart Y axis title.

labels

object

Chart value labels. Show & configure value labels in some charts.

Properties

column

string

Column for node labels in scatterplot charts.

config

object

Style configurations for value labels in bar charts. Set position & alignment configuration for value labels in bar charts.

Properties

position

string

Value labels position in bar charts.Values must be one of the following:

inside
outside

alignment

string

Value labels alignment in horizontal bar charts.Values must be one of the following:

left
middle
right

format

string

Format for value labels.

formatAbsolute

string

Format for absolute value labels.

formatCount

string

Format for value count labels.

formatPercentageChange

string

Format for percentage change labels.

margin

number

Margin between node labels in scatterplot charts.

show

boolean

Whether to show value labels.

showAbsolute

boolean

Whether to show absolute value labels.

showCount

boolean

Whether to show value count labels.

showPercentageChange

boolean

Whether to show percentage change labels.

showTotal

boolean

Whether to show total value labels in stacked bar charts.

stats

array[string]

Metrics to show as value labels in boxplot charts.

Array items

Item

string

Each item in array.

legendColorTitle

string

Chart color legend title.

sortColor

string

Sorting applied to categories of the color variable (segmentsColumn).Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection

string

Sorting direction applied to categories of the color variable (segmentsColumn).Values must be one of the following:

ASC
DESC

sortColorMode

string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.Values must be one of the following:

SORT
CUSTOM

sortX

string

Chart sorting applied to chart in the x axis.Values must be one of the following:XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection

string

Chart sorting direction applied to chart in the x axis.Values must be one of the following:

ASC
DESC

stat

object

required

Properties

stat

string

params

object

Stat parameters.

Properties

value

string

Value for the stat parameter.

theme

string

default:"graphext"

required

Theme applied to the chart.Values must be one of the following:graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette

string

themeMode

string

default:"dark"

Theme mode applied to the chart.Values must be one of the following:

dark
light

Defines if tooltip is enabled.

object

required

Slot value represented in the x axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean, number or date, as well as listIndex.

aggregation

string

xAxisConfig

object

X Axis config options. Configuration options specific to X axis, including base axis properties and label display controls.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

labelsMode

string

Axis labels orientation mode. Controls how axis labels are oriented. auto (rotates only when needed), rotate (always rotated), or none (never rotated).Values must be one of the following:

auto
rotate
none

labelsRotation

number

Labels rotation in degrees.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

xTitle

string

Chart X axis title.

object

required

Slot value represented in the y axis. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts variables of type category, boolean or number, as well as nodeCount or a metric.

aggregation

string

yAxisConfig

object

Y Axis config options. Configuration options specific to Y axis, including base axis properties.

Properties

hideGrid

boolean

Whether to hide grid lines in the axe or not.

includeZero

boolean

Whether to include zero in the axe or not.

isLogarithmic

boolean

Whether to use a logarithmic scale.

labelsFormat

string

Axis labels numeric format.

labelsMaxWidth

number

Maximum width in pixels for axis labels before truncating with ellipsis.

ticks

object

Axis ticks configuration. An object for axis tick configuration.

Properties

count

[number, string, object]

Ticks count. Equivalent to Vega axes tickCount prop.

Options

number
string
object

{_}

number

number.

{_}

string

string.Values must be one of the following:millisecond second minute hour day week month year

interval

string

required

Interval unit.Values must be one of the following:millisecond second minute hour day week month year

step

number

required

Step.

values

array[['string', 'number']]

Ticks values. Equivalent to Vega axes values prop.

Array items

Item

[string, number]

Each item in array.

yTitle

string

Chart Y axis title.

zoomX

[array, array]

Selection applied to chart in the x axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

zoomY

[array, array]

Selection applied to chart in the y axis. The chart will be zoom in over this selection.

Options

array
array

{_}

array[number]

array.

Array items

Item

number

Each item in array.

selectedChart

string

default:"Table Chart"

required

Table Chart. Table Chart.

elements

array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Array items

kind

string

Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART

text

string

The text shown for this insight element.

layout

object

Properties

integer

Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:

-1 ≤ x ≤ 11

integer

Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:

0 ≤ y ≤ 11

integer

The width of the element (in increments of 1).Values must be in the following range:

1 ≤ w ≤ 12

integer

The height of the element (in increments of 1).Values must be in the following range:

1 ≤ h ≤ 9

column

string

Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.

insightThemeMode

string

Theme mode applied to the whole insight.Values must be one of the following:

dark
light

isAutoMode

boolean

Defines if the cross-filters mode is set to auto.

ignoreNulls

boolean

Defines if the cross-filters and significant variables should ignore null values.

layout

string

Insight default layout.Values must be one of the following:

plot
all

layoutElements

array[string]

Insight default layout elements.

Array items

Item

string

Each item in array.Values must be one of the following:

title
description
filters

relative

boolean

required

Defines if the cross-filters mode is set to relative.

replayDisabled

[string, boolean]

default:"false"

Indicates if the insight can replay its original state or not.Values must be one of the following:

drillDown
directSelectionInGraph
nonPersistedColumn
True
False

selection

string

A filter query. See Advanced query filters for more information.

title

string

required

Title of the insight.

chartDirection

string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.Values must be one of the following:

horizontal
vertical

selectedRows

integer

Total number of selected rows in the dataset.Values must be in the following range:

0 ≤ selectedRows < inf

tableColumnWidths

object

Width of the columns in the table. Each object represents a column in the table and its corresponding width settings. For example: { "COLUMN-column1": 300 } Will set the width of the ‘column1’ to 300 pixels.

Item properties

Items

number

One or more additional parameters.

tableDiscretizations

object

Discretizations for columns used in group by in the summary table. Each object represents a dataset column and its corresponding discretization settings. For example:

{
"COLUMN-column1": { nBins: 10 }
}

Will try to discretize the ‘column1’ in 10 bins.

Item properties

Items

object

One or more additional parameters. Configuration for the selected column.

Properties

count

integer

Number of bins to discretize the column.Values must be in the following range:

0 ≤ count < inf

period

string

Period to discretize the column.Values must be one of the following:MILLISECOND SECOND MINUTE HOUR YEAR_DAY MONTH_DAY WEEK_DAY WEEK WEEK_OF_YEAR MONTH QUARTER YEAR

isRecurrentPeriod

boolean

Defines if the period is recurrent.

tableDiscretizationsIsExact

object

Defines if the discretization for columns used in group by in the summary table uses exact or pretty number of bins. Each object represents a dataset column and its corresponding configuration to use exact or pretty number of bins. For example:

{
"COLUMN-column1": true
}

Will try to discretize the ‘column1’ using an exact number of bins.

Item properties

Items

boolean

One or more additional parameters.

tableDiscretizationsUseQuantiles

object

Defines if the discretization for columns used in group by in the summary table uses quantiles. Each object represents a dataset column and its corresponding configuration to use quantiles. For example:

{
"COLUMN-column1": true
}

Will try to discretize the ‘column1’ using quantiles.

Item properties

Items

boolean

One or more additional parameters.

tableFirstIndex

integer

The index of the first row shown in the table.Values must be in the following range:

0 ≤ tableFirstIndex < inf

tableFormats

array[object]

Format for the numeric values in the table. Each object represents a column in the dataset and its corresponding format settings. We use the Python format specification mini-language to specify the format. For example:

{ "COLUMN-column1": ",.2f" }

Will format the ‘column1’ with two decimal places (e.g., 1,234.56).

Array items

Item

object

Each item in array. Configuration for the selected column.

Item properties

Items

string

One or more additional parameters.

tableHideIndexRow

boolean

Whether to hide the index row in the table.

tableRows

array[object]

Variables to group by to generate a summary table. If provided, tableValues should also be defined to specify the desired aggregation for each value.

Array items

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts any variables from dataset.

aggregation

string

aggregationParams

object

Parameters for the aggregation method. Only for values with AGGREGATED_COLUMN kind. For example, for the aggregation ‘COUNT_WHERE’, the parameter should include the category to count. { "value": "category1" }

Properties

value

string

Value for the aggregation method.

isOrdinal

boolean

Whether the column is ordinal.

label

string

Custom name for the column.

isCustomLabel

boolean

Whether the label is custom. If true, the label will be show without any transformation. If false, the label may be transformed.

hideSubtitle

boolean

Whether to hide the column subtitle (e.g., Value Count).

semanticType

string

Semantic type of the column.Values must be one of the following:list boolean category currency date number sex text url list[boolean] list[date] list[number] list[url] list[category]

type

string

Type of the column.Values must be one of the following:categorical quantitative date text id url

tableRowsPerPage

integer

How many rows per page are shown in the table.Values must be in the following range:

1 ≤ tableRowsPerPage ≤ 100

tableSorting

object

Sorting criteria for a table. Defines a column to sort the table with a specific sorting direction.

Properties

direction

string

Sorting direction applied to the table.Values must be one of the following:

ASC
DESC

column

string

Id of the table column to sort the table by.

tableStyles

array[object]

Custom styles for the table. Each item represents a column in the dataset and its corresponding style settings. For example:

[
{
"slotValueId": "COLUMN-column1",
"query": "FUZZY('positive')",
"style": {
"property": "graphextPill",
"value": "#FF0000"
}
}
]

Will apply a custom pill style with red color to the cells that match the query.

Array items

slotValueId

string

Slot value id.

query

string

Custom graphext query to apply the style. Each cell will be evaluated with the query, and if it returns true, the style will be applied.

categoryColors

array[string]

Categories for cell coloring. Each item in the array represents a category in the column that will be used to color the cells in the table.

Array items

Item

string

Each item in array.

style

object

Style configuration. Each style is an object with property and value fields.

Properties

property

string

Style property to customize each cell:

backgroundColor: will change the background color
color: will change the text color
graphextPill: will apply a custom pill style.

Values must be one of the following:

backgroundColor
color
graphextPill

value

string

Color in hexadecimal format (e.g., #FF0000).

tableTotals

object

Totals to show as a footer in the table. Each object represents a column in the dataset and the totals to show for the selected column For example:

{
"column1": ["sum", "mean", "variance"]
}

Will show the sum, mean and variance of the column1 (if column1 is shown in the table).

Item properties

Items

array[string]

One or more additional parameters. Totals to show for the selected column.

Array items

Item

string

Each item in array.Values must be one of the following:sum mean variance standardDeviation skewness kurtosis min p25 p50 p75 max nNulls precision count mode median uniqueValues

tableValues

array

required

Aggregations if tableRows is provided, basic columns if not. If tableRows is defined, tableValues will be the definition of desired aggregations. Each object represents a column in the dataset and its aggregation. Those aggregations will reduce all the values of the column to a single value, applying the selected aggregation method If tableRows is not defined, tableValues will represent the columns to show in the table.

Array items

Item

object

The value for a slot, defined by its kind & its name with some extra column props. SlotValueData could be of kind column, aggregated column, listIndex, nodeCount or metric.

Properties

kind

string

The kind of then slot value.Values must be one of the following:

AGGREGATED_COLUMN
COLUMN
LIST_INDEX
NODE_COUNT
METRIC

name

string

The name of the slot value. Accepts any variables from dataset, as well as nodeCount or a metric.

aggregation

string

aggregationParams

object

Properties

value

string

Value for the aggregation method.

isOrdinal

boolean

Whether the column is ordinal.

label

string

Custom name for the column.

isCustomLabel

boolean

Whether the label is custom. If true, the label will be show without any transformation. If false, the label may be transformed.

hideSubtitle

boolean

Whether to hide the column subtitle (e.g., Value Count).

semanticType

string

type

string

Type of the column.Values must be one of the following:categorical quantitative date text id url

Prepare

Report

Analyse

Usage

Inputs & Outputs

Configuration

Prepare

Report

Analyse

​Usage

​Inputs & Outputs

​Configuration

Usage

Inputs & Outputs

Configuration