create_plot_insight
Create a new insight from the Plot section.
Usage
The following shows how the step can be used in a recipe.Examples
Examples
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.
Inputs & Outputs
The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced
by name e.g. "churn-clf").
Inputs
Inputs
Outputs
Outputs
Configuration
The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e.step(..., {"param": "value", ...}) -> (output).
Parameters
Parameters
Area Chart.
Area 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.
Array items
Array items
Specify the type of element.Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHARTThe 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.
Properties
Properties
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:
darklight
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:
plotall
Insight default layout elements.
Array items
Array items
Each item in array.Values must be one of the following:
titledescriptionfilters
Defines if the cross-filters mode is set to relative.
Indicates if the insight can replay its original state or not.Values must be one of the following:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse
A filter query.
See Advanced query filters for more information.
Title of the insight.
Comments that can be added to the chart.
Any text can be added as annotation at certain abscissa point.
Array items
Array items
Alignment of the annotation.Values must be one of the following:
startcenterend
Text of the comment.
Annotations shape.
Annotations shape configuration.
Properties
Properties
Annotation shape type.Values must be one of the following:
arrow
Annotation endpoint type for arrow shape.Values must be one of the following:
linesolidnone
Annotation shape line style.Values must be one of the following:
soliddashed
Annotation shape line color.
Annotation shape line width.
Annotation shape endpoint position x for arrow shape.
Annotation shape endpoint position y for arrow shape.
Chart description.
Chart footer text.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
Options
Options
string.Values must be one of the following:
automatic
Chart subtitle.
Chart title.
Discretization configuration for a slot (x, y or color).
There is different kind of discretization configurations depending on column type:
- For quantitative ones a single count defining the number of bins is enough
- For categorical ones we need the count of categories & its top (DESC) or bottom (ASC) direction
- For dates we need a date period & a count of periods.
Options
Options
Number of bins in the axis.
Defines if the discretization in the X axis uses a exact or pretty number of bins.
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-afterStat configuration.
For example, for a max stat it would be:
{ "stat": "max" }
For stats that require a param like “countWhere” or “percentOfRowsWhere” it would be:
{ "stat": "countWhere", "params": { "value": "categoryName" } }Properties
Properties
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 percentOfRowsWhereTheme applied to the chart.Values must be one of the following:
graphext dark excel fivethirtyeight ggplot2 googlecharts latimes powerbi quartz urbaninstitute voxTheme 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 voxTheme mode applied to the chart.Values must be one of the following:
darklight
Defines if tooltip is enabled.
Slot value represented in the x axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
Properties
Properties
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_STDEVX Axis config options.
Configuration options specific to X axis, including base axis properties and label display controls.
Properties
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 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:
autorotatenone
Labels rotation in degrees.
Axis ticks configuration.
An object for axis tick configuration.
Chart X axis title.
Slot value represented in the y axis.
SlotValues could be of kind column, aggregated column, listIndex, nodeCount or metric.
Properties
Properties
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_STDEVY Axis config options.
Configuration options specific to Y axis, including base axis properties.
Properties
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.
Chart Y axis title.