create_plot_insight
Create a new insight from the Plot section.
Defines if the cross-filters mode is set to relative.
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 of the insight.
The value for a slot, defined by its kind & its name. 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.
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
The value for a slot, defined by its kind & its name. 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.
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
Comments that can be added to the chart. Any text can be added as annotation at certain abscissa point.
Bars paddings in Bar charts. Defines the inner & outer paddings for bars in Bar charts.
Inner padding between bars.
Outer padding for bars.
Defines the metrics to be drawn in a BoxPlot chart.
Values must be one of the following:
quartilesquartiles+IQRquartiles+min/maxmean+standardDeviation
Chart description.
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:
horizontalvertical
Chart footer text.
Chart size. Chart width & height if customized, undefined if in “Fit to screen” mode.
Chart size width.
Chart size height.
Chart subtitle.
Chart title.
The value for a slot, defined by its kind & its name. 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.
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.
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.
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.
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.
Defines if the categories must filter or not. If “true”, the categories of the categoricalColumn will act as filters.
Chart markers foregroundColor.
Hides chart color legend title.
Hides chart size legend title.
Hides chart X axis title.
Hides chart Y axis title.
Theme mode applied to the whole insight.
Values must be one of the following:
darklight
Defines if the cross-filters mode is set to auto.
Defines if the cross-filters and significant variables should ignore null values.
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:
insideoutside
Value labels alignment in horizontal bar charts.
Values must be one of the following:
leftmiddleright
Format for value labels.
Format for absolute value labels.
Format for value count 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 total value labels in stacked bar charts.
Metrics to show as value labels in boxplot charts.
Chart color legend title.
Chart size 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:
circlesquaretriangle
The color of the marker.
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:
circlesquaretriangle
The color of the marker.
The area of the marker in pixels.
Line width settings. Specifies the width of the lines in line charts.
Default line width.
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:
interpolatedgapzero
Nodes size in scatterplot charts. Can define a fixed value or a min & max value in px to map nodes size.
Nodes opacity in scatterplot charts.
Indicates if the insight can replay its original state or not.
Values must be one of the following:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse
Sets the relativeCount mode.
Values must be one of the following:
nonerelativexy
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.
Seasonality interval for Seasonal Decomposition plot.
expanded segment in Seasonal Decomposition plot.
A filter query. See Advanced query filters for more information.
The value for a slot, defined by its kind & its name. 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.
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:
ASCDESC
Sorting mode applied to categories of the color variable (segmentsColumn). CUSTOM does not apply any sorting criteria.
Values must be one of the following:
SORTCUSTOM
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:
ASCDESC
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:
ASCDESC
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
The index of the first row shown in the table.
Values must be in the following range:
0 ≤ tableFirstIndex < inf
How many rows per page are shown in the table.
Values must be in the following range:
1 ≤ tableRowsPerPage ≤ 100
Whether to hide the index row in the table.
Columns shown in the table.
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.
Sorting criteria for a table. Defines a column to sort the table with a specific sorting direction.
Sorting direction applied to the table.
Values must be one of the following:
ASCDESC
Id of the table column to sort the table by.
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).
One or more additional parameters. Totals to show for the selected column.
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.
One or more additional parameters. Configuration for the selected column.
Number of bins to discretize the column.
Values must be in the following range:
0 ≤ nBins < inf
Total number of selected rows in the dataset.
Values must be in the following range:
0 ≤ selectedRows < inf
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 when the theme is graphext.
Values must be one of the following:
HorusOsirisRe
Theme mode applied to the chart.
Values must be one of the following:
darklight
Defines if tooltip is enabled.
Fields in tooltip. A list of fields to show in tooltip for Scatterplot charts.
Axis config options. X or Y axes config options.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Chart X scale domain for Scatterplot charts. Scatterplot charts need to define axes scales domain.
Chart X axis title.
Axis config options. X or Y axes config options.
Whether to include zero in the axe or not.
Whether to use a logarithmic scale.
Chart Y scale domain for Scatterplot charts. Scatterplot charts need to define axes scales domain.
Chart Y axis title.
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.
Was this page helpful?