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.
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.
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.
Chart size.
Chart width & height if customized, undefined if in “Fit to screen” mode.
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.
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.
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.
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.
