Usage The following shows how the step can be used in a recipe.
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, ... }) 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, ... }) 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").
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).
Area Chart Bar Chart Box Plot Chart Bubble Chart Bubble Colored Chart Grouped Bar Chart Heat Map Chart Line Chart Multiple Line Chart Scatterplot Chart Scatterplot Colored Chart Seasonal Decomposition Chart Segmented Area Chart Segmented Bar Chart Segmented Line Chart Stacked Area Chart Stacked Bar Chart Stacked 100% Area Chart Stacked 100% Bar Chart Table Chart selectedChart
string
default: "Area Chart"
required
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
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 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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Area Chart"
required
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
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 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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Bar Chart"
required
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Bars paddings in Bar charts.
Defines the inner & outer paddings for bars in Bar charts.
Inner padding between bars.
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:
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart sorting applied to chart in the x axis.
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Chart sorting direction applied to chart in the x axis.
Values must be one of the following:
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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Box Plot Chart"
required
Box Plot Chart.
Box Plot Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Defines the metrics to be drawn in BoxPlot charts.
Values must be one of the following:
quartilesquartiles+IQRquartiles+min/maxmean+standardDeviation 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:
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart sorting applied to chart in the x axis.
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Chart sorting direction applied to chart in the x axis.
Values must be one of the following:
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Bubble Chart"
required
Bubble Chart.
Bubble Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Chart markers foregroundColor.
Hides chart size legend title.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Nodes size in scatterplot charts.
Can define a fixed value or a min & max value in px to map nodes size.
Minimum size value in px.
Maximum size value in px.
Nodes opacity in scatterplot charts.
Metrics shown in scatterplot charts.
Defines if regression line, RSquared or Pearson coefficient metrics are displayed.
Whether to show a regression line.
Whether to show RSquared metric.
Whether to show Pearson coefficient metric.
Slot value that maps bubble size in scatterplot charts.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
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.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Fields in tooltip.
A list of fields to show in tooltip for Scatterplot charts.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
selectedChart
string
default: "Bubble Colored Chart"
required
Bubble Colored Chart.
Bubble Colored Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Slot value used to map color in the chart.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date.
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
Categories of the color variable.
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Hides chart color legend title.
Hides chart size legend title.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart color legend title.
Nodes size in scatterplot charts.
Can define a fixed value or a min & max value in px to map nodes size.
Minimum size value in px.
Maximum size value in px.
Nodes opacity in scatterplot charts.
Metrics shown in scatterplot charts.
Defines if regression line, RSquared or Pearson coefficient metrics are displayed.
Whether to show a regression line.
Whether to show RSquared metric.
Whether to show Pearson coefficient metric.
Slot value that maps bubble size in scatterplot charts.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
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.
Sorting applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Sorting direction applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.
Values must be one of the following:
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Fields in tooltip.
A list of fields to show in tooltip for Scatterplot charts.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
selectedChart
string
default: "Grouped Bar Chart"
required
Grouped Bar Chart.
Grouped Bar Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Bars paddings in Bar charts.
Defines the inner & outer paddings for bars in Bar charts.
Inner padding between bars.
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:
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Slot value used to map color in the chart.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or date.
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
Categories of the color variable.
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Hides chart color legend title.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart color legend title.
Sorting applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Sorting direction applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.
Values must be one of the following:
Chart sorting applied to chart in the x axis.
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Chart sorting direction applied to chart in the x axis.
Values must be one of the following:
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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Heat Map Chart"
required
Heat Map Chart.
Heat Map Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Slot value used to apply color to each cell in Heatmap charts.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Color legend title in Heatmap charts.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
Defines if the discretization in the Y axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
discretizationUseQuantilesY
Defines if the discretization in the Y axis uses quantiles.
Hides chart color legend title in Heatmap charts.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart sorting applied to chart in the x axis.
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Chart sorting direction applied to chart in the x axis.
Values must be one of the following:
Chart sorting applied to chart in the y axis.
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Chart sorting direction applied to chart in the y axis.
Values must be one of the following:
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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Line Chart"
required
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
Interpolation method used for line or area chart.
Values must be one of the following:
linear monotone cardinal natural step step-before step-after
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Line dash pattern.
Configures the dash pattern for lines in line charts.
Default dash pattern for lines.
It is represented as an array of stroke and gap lengths.
Custom dash pattern.
Allows setting a specific dash pattern for the selected categories.
The custom dash pattern for the selected category.
It is represented as an array of stroke and gap lengths.
Line markers.
Configures the markers for lines in line charts.
Line marker.
Configures a line marker.
The shape of the marker.
Values must be one of the following:
The area of the marker in pixels.
Custom line markers.
Allows setting a specific line marker for the selected categories.
Line marker.
Configures a line marker.
The shape of the marker.
Values must be one of the following:
The area of the marker in pixels.
Line width settings.
Specifies the width of the lines in line charts.
Custom line width.
Allows setting a specific line width for the selected categories.
The custom line width for the selected category.
Defines how to represent null values in line charts.
Values must be one of the following:
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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Defines if zero values should be represented as null in line charts.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Multiple Line Chart"
required
Multiple Line Chart.
Multiple Line Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Slot value used to map color in the chart.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or date.
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
Categories of the color variable.
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Defines if the discretization in the X axis uses a exact or pretty number of bins.
discretizationUseQuantilesX
Defines if the discretization in the X axis uses quantiles.
Hides chart color legend title.
Hides chart X axis title.
Hides chart Y axis title.
Interpolation method used for line or area chart.
Values must be one of the following:
linear monotone cardinal natural step step-before step-after
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart color legend title.
Line dash pattern.
Configures the dash pattern for lines in line charts.
Default dash pattern for lines.
It is represented as an array of stroke and gap lengths.
Custom dash pattern.
Allows setting a specific dash pattern for the selected categories.
The custom dash pattern for the selected category.
It is represented as an array of stroke and gap lengths.
Line markers.
Configures the markers for lines in line charts.
Line marker.
Configures a line marker.
The shape of the marker.
Values must be one of the following:
The area of the marker in pixels.
Custom line markers.
Allows setting a specific line marker for the selected categories.
Line marker.
Configures a line marker.
The shape of the marker.
Values must be one of the following:
The area of the marker in pixels.
Line width settings.
Specifies the width of the lines in line charts.
Custom line width.
Allows setting a specific line width for the selected categories.
The custom line width for the selected category.
Defines how to represent null values in line charts.
Values must be one of the following:
Sorting applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Sorting direction applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.
Values must be one of the following:
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" } }
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
Stat parameters.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date, as well as listIndex.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean or number, as well as nodeCount or a metric.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Defines if zero values should be represented as null in line charts.
Selection applied to chart in the x axis.
The chart will be zoom in over this selection.
Selection applied to chart in the y axis.
The chart will be zoom in over this selection.
selectedChart
string
default: "Scatterplot Chart"
required
Scatterplot Chart.
Scatterplot Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Chart markers foregroundColor.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Nodes size in scatterplot charts.
Can define a fixed value or a min & max value in px to map nodes size.
Minimum size value in px.
Maximum size value in px.
Nodes opacity in scatterplot charts.
Metrics shown in scatterplot charts.
Defines if regression line, RSquared or Pearson coefficient metrics are displayed.
Whether to show a regression line.
Whether to show RSquared metric.
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Fields in tooltip.
A list of fields to show in tooltip for Scatterplot charts.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
selectedChart
string
default: "Scatterplot Colored Chart"
required
Scatterplot Colored Chart.
Scatterplot Colored Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
Slot value used to map color in the chart.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type category, boolean, number or date.
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
Categories of the color variable.
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
Number of time units that sets the size of the discretization.
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
Defines if the period is a recurrent one (i.e. WEEK_DAY).
Hides chart color legend title.
Hides chart X axis title.
Hides chart Y axis title.
Chart value labels.
Show & configure value labels in some charts.
Column for node labels in scatterplot charts.
Style configurations for value labels in bar charts.
Set position & alignment configuration for value labels in bar charts.
Value labels position in bar charts.
Values must be one of the following:
Value labels alignment in horizontal bar charts.
Values must be one of the following:
Format for absolute value labels.
Format for value count labels.
Format for percentage change labels.
Margin between node labels in scatterplot charts.
Whether to show value labels.
Whether to show absolute value labels.
Whether to show value count labels.
Whether to show percentage change labels.
Whether to show total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart color legend title.
Nodes size in scatterplot charts.
Can define a fixed value or a min & max value in px to map nodes size.
Minimum size value in px.
Maximum size value in px.
Nodes opacity in scatterplot charts.
Metrics shown in scatterplot charts.
Defines if regression line, RSquared or Pearson coefficient metrics are displayed.
Whether to show a regression line.
Whether to show RSquared metric.
Whether to show Pearson coefficient metric.
Sorting applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM
Sorting direction applied to categories of the color variable (segmentsColumn).
Values must be one of the following:
Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.
Values must be one of the following:
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
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
Theme mode applied to the chart.
Values must be one of the following:
Defines if tooltip is enabled.
Fields in tooltip.
A list of fields to show in tooltip for Scatterplot charts.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
X Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
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:
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
The kind of then slot value.
Values must be one of the following:
AGGREGATED_COLUMNCOLUMNLIST_INDEXNODE_COUNTMETRIC The name of the slot value.
Accepts variables of type number or date.
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
Y Axis config options.
Configuration options specific to Y axis, including base axis properties.
Whether to hide grid lines in the axe or not.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Axis labels numeric format.
Maximum width in pixels for axis labels before truncating with ellipsis.
Axis ticks configuration.
An object for axis tick configuration.
Ticks count.
Equivalent to Vega axes tickCount prop.
string.
Values must be one of the following:
millisecond second minute hour day week month year
Interval unit.
Values must be one of the following:
millisecond second minute hour day week month year
values
array[['string', 'number']]
Ticks values.
Equivalent to Vega axes values prop.
selectedChart
string
default: "Seasonal Decomposition Chart"
required
Seasonal Decomposition Chart.
Seasonal Decomposition Chart.
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.
Specify the type of element.
Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
The text shown for this insight element.
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.
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:
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:
The width of the element (in increments of 1).
Values must be in the following range:
The height of the element (in increments of 1).
Values must be in the following range:
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.
Theme mode applied to the whole insight.
Values must be one of the following:
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
Insight default layout.
Values must be one of the following:
Insight default layout elements.
Each item in array.
Values must be one of the following:
titledescriptionfilters 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:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Alignment of the annotation.
Values must be one of the following:
Annotations shape.
Annotations shape configuration.
Annotation shape type.
Values must be one of the following:
Annotation endpoint type for arrow shape.
Values must be one of the following:
Annotation shape line style.
Values must be one of the following:
Annotation shape line color.
Annotation shape line dash.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Annotations style.
Annotation label style configuration.
Annotation label font size in pixels.
Annotation label font style.
Values must be one of the following:
X axis value.
X axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in X axis.
Annotation value in X axis.
Annotation kind.
Values must be one of the following:
Annotation position in X axis.
y
[object, object, object, object]
Y axis value.
Y axis value where the annotation is placed.
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 Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Annotation value in Y axis.
Annotation kind.
Values must be one of the following:
Whether to hide the annotation value in the label.
Annotation stat in Y axis.
Values must be one of the following:
max mean median min q1 q3
Annotation kind.
Values must be one of the following:
Annotation position in Y axis.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
string.
Values must be one of the following:
string.
Values must be one of the following:
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.
Number of bins in the axis.
Number of bins in the axis.
Number of bins in the axis.
Get top (DESC) or bottom (ASC) categories for categorical variables in the axis.
Values must be one of the following:
