relative
boolean
required

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

selectedChart
string
required

Useful to choose the chart kind to display in the UI.

Values must be one of the following:

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 Table Summary Chart

title
string
required

Title of the insight.

x
object

The value for a slot, defined by its kind & its name. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

y
object

The value for a slot, defined by its kind & its name. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

annotations
array[object]

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

barPaddings
object

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

boxPlotStat
string

Defines the metrics to be drawn in BoxPlot charts.

Values must be one of the following:

  • quartiles
  • quartiles+IQR
  • quartiles+min/max
  • mean+standardDeviation
cell
object

The value for a slot, defined by its kind & its name. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

cellTitle
string

Color legend title in Heatmap charts.

chartDescription
string

Chart description.

chartDirection
string

Defines the direction in which the chart is drawn. Defines if Bar or BoxPlot charts will be drawn horizontally or vertically.

Values must be one of the following:

  • horizontal
  • vertical

Chart footer text.

chartSize
object

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

chartSubtitle
string

Chart subtitle.

chartTitle
string

Chart title.

color
object

The value for a slot, defined by its kind & its name. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

colorCategories
array[string]

Categories of the color variable.

discretizationColor
[object, object, object]

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

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

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

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

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

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

Defines if the discretization in the X axis uses quantiles.

discretizationUseQuantilesY
boolean

Defines if the discretization in the Y axis uses quantiles.

elements
array[object]

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

filterMode
boolean

Defines if the categories must filter or not. If “true”, the categories of the categoricalColumn will act as filters.

foregroundColor
string

Chart markers foregroundColor.

hideCellTitle
boolean

Hides chart color legend title in Heatmap charts.

hideLegendColorTitle
boolean

Hides chart color legend title.

hideLegendSizeTitle
boolean

Hides chart size legend title.

hideXTitle
boolean

Hides chart X axis title.

hideYTitle
boolean

Hides chart Y axis title.

insightThemeMode
string

Theme mode applied to the whole insight.

Values must be one of the following:

  • dark
  • light
isAutoMode
boolean

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

ignoreNulls
boolean

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

interpolation
string

Interpolation method used for line or area chart.

Values must be one of the following:

linear monotone cardinal natural step step-before step-after

labels
object

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

legendColorTitle
string

Chart color legend title.

legendSizeTitle
string

Chart size legend title.

lineDash
object

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

lineMarkers
object

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

lineWidth
object

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

missingValues
string

Defines how to represent null values in line charts.

Values must be one of the following:

  • interpolated
  • gap
  • zero
nodesSize
[number, object]

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

opacity
number

Nodes opacity in scatterplot charts.

replayDisabled
[string, boolean]

Indicates if the insight can replay its original state or not.

Values must be one of the following:

  • drillDown
  • directSelectionInGraph
  • nonPersistedColumn
  • True
  • False
scatterplotMetrics
object

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

seasonalityInterval
number

Seasonality interval for Seasonal Decomposition plot.

segmentExpanded
string

expanded segment in Seasonal Decomposition plot.

selection
string

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

size
object

The value for a slot, defined by its kind & its name. SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.

sizeSelection
[array, array]

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

sortColor
string

Sorting applied to categories of the color variable (segmentsColumn).

Values must be one of the following:

XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortColorDirection
string

Sorting direction applied to categories of the color variable (segmentsColumn).

Values must be one of the following:

  • ASC
  • DESC
sortColorMode
string

Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.

Values must be one of the following:

  • SORT
  • CUSTOM
sortX
string

Chart sorting applied to chart in the x axis.

Values must be one of the following:

XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortXDirection
string

Chart sorting direction applied to chart in the x axis.

Values must be one of the following:

  • ASC
  • DESC
sortY
string

Chart sorting applied to chart in the y axis.

Values must be one of the following:

XAXIS YAXIS YAXIS_SEGMENT SELECTION ORDINAL ALPHANUM

sortYDirection
string

Chart sorting direction applied to chart in the y axis.

Values must be one of the following:

  • ASC
  • DESC
stat
string

Stat kind.

Values must be one of the following:

sum mean variance standardDeviation skewness kurtosis min p25 p50 p75 max nNulls precision count cumSum nodeCount rForeground rForegroundColor rForegroundX uniqueValues valueCount

tableFirstIndex
integer

The index of the first row shown in the table.

Values must be in the following range:

0 ≤ tableFirstIndex < inf
tableRowsPerPage
integer

How many rows per page are shown in the table.

Values must be in the following range:

1 ≤ tableRowsPerPage ≤ 100
tableHideIndexRow
boolean

Whether to hide the index row in the table.

tableColumns
array[object]

Columns shown in the table.

tableValues
array[object]

Definition of desired aggregations. Each object represents a column in the dataset and its aggregation. Those aggregations will reduce all the values of the column to a single value, applying the selected aggregation method.

tableSorting
object

Sorting criteria for a table. Defines a column to sort the table with a specific sorting direction.

tableTotals
object

Totals to show as a footer in the table. Each object represents a column in the dataset and the totals to show for the selected column For example:

{
"column1": ["sum", "mean", "variance"]
}

Will show the sum, mean and variance of the column1 (if column1 is shown in the table).

tableDiscretizations
object

Discretizations for columns used in group by in the summary table. Each object represents a dataset column and its corresponding discretization settings. For example:

{
"COLUMN-column1": { nBins: 10 }
}

Will try to discretize the ‘column1’ in 10 bins.

tableDiscretizationsUseQuantiles
object

Defines if the discretization for columns used in group by in the summary table uses quantiles. Each object represents a dataset column and its corresponding configuration to use quantiles. For example:

{
"COLUMN-column1": true
}

Will try to discretize the ‘column1’ using quantiles.

tableFormats
array[object]

Format for the numeric values in the table. Each object represents a column in the dataset and its corresponding format settings. We use the Python format specification mini-language to specify the format. For example:

{ "COLUMN-column1": ",.2f" }

Will format the ‘column1’ with two decimal places (e.g., 1,234.56).

tableStyles
array[object]

Custom styles for the table. Each item represents a column in the dataset and its corresponding style settings. For example:

[
{
"slotValueId": "COLUMN-column1",
"query": "FUZZY('positive')",
"style": {
"property": "graphextPill",
"value": "#FF0000"
}
}
]

Will apply a custom pill style with red color to the cells that match the query.

selectedRows
integer

Total number of selected rows in the dataset.

Values must be in the following range:

0 ≤ selectedRows < inf
theme
string
default: "graphext"

Theme applied to the chart.

Values must be one of the following:

graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute vox

themeColorPalette
string

Theme color palette applied to the chart when the theme is graphext.

Values must be one of the following:

  • Horus
  • Osiris
  • Re
themeMode
string
default: "dark"

Theme mode applied to the chart.

Values must be one of the following:

  • dark
  • light
tooltip
boolean

Defines if tooltip is enabled.

tooltipFields
array[string]

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

xAxisConfig
object

Axis config options. X or Y axes config options.

xDomain
[array, array]

Chart X scale domain for Scatterplot charts. Scatterplot charts need to define axes scales domain.

xTitle
string

Chart X axis title.

yAxisConfig
object

Axis config options. X or Y axes config options.

yDomain
[array, array]

Chart Y scale domain for Scatterplot charts. Scatterplot charts need to define axes scales domain.

yTitle
string

Chart Y axis title.

zerosAsNulls
boolean

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

zoomX
[array, array]

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

zoomY
[array, array]

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