relative
boolean
required

Sets the visualization type to absolute or 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

title
string
required

Title of the insight.

xColumn
string
required

Column represented in the x axis.

yColumn
string
required

Column represented in the y axis.

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 a BoxPlot chart.

Values must be one of the following:

  • quartiles
  • quartiles+IQR
  • quartiles+min/max
  • mean+standardDeviation
bucketSizeCount
number

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

bucketSizeInterval
string

Time unit to specify the bucket size.

Values must be one of the following:

MILLISECOND SECOND MINUTE HOUR DAY WEEK MONTH QUARTER YEAR

chartDescription
string

Chart description.

chartDirection
string

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

Values must be one of the following:

  • horizontal
  • vertical
chartFooter
string

Chart footer text.

chartSize
object

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

chartSubtitle
string

Chart subtitle.

chartTitle
string

Chart title.

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.

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
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.

nBinsX
number

Number of bins in the x axis.

nBinsXDirection
string

Get top (DESC) or bottom (ASC) categories for categorical variables in the x axis.

Values must be one of the following:

  • ASC
  • DESC
nBinsY
number

Number of bins in the y axis.

nBinsYDirection
string

Get top (DESC) or bottom (ASC) categories for categorical variables in the y axis.

Values must be one of the following:

  • ASC
  • DESC
opacity
number

Nodes opacity in scatterplot charts.

recurrentPeriod
string

Time unit to specify the period for Recurrent Patterns aggregation.

Values must be one of the following:

MILLISECOND SECOND MINUTE HOUR MONTH_DAY WEEK_DAY WEEK MONTH QUARTER YEAR

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
relativeCount
string

Sets the relativeCount mode.

Values must be one of the following:

  • none
  • relative
  • x
  • y
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.

segments
array[string]

Categories of the categorical column that are used to build the chart.

segmentsColumn
string

Categories are created from this column.

selection
string

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

size
[number, object]

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

sizeColumn
string

Column that maps bubble size in scatterplot charts.

sizeColumnSelection
[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.

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 valueCount

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.

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.