create_graph_insight
Create a new insight from the Graph 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.
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
Title of the insight.
Indicates if the insight can replay its original state or not.
Values must be one of the following:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse
Column used to color the UI.
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.
Defines if the cross-filters mode is set to relative.
A filter query. See Advanced query filters for more information.
The order in which a variable’s categories are displayed. An object configuring for each column a method determining the order of its categories.
Item properties
Item properties
Order of the categories in a specific column.
Values must be one of the following:
BACKGROUNDFOREGROUNDUPLIFTTFIDFORDINAL
Configure categories to hide in the filter view of categorical variables. Categories less frequent than the configured threshold will not appear in the UI.
Properties
Properties
A list of threshold configurations. A categorical column can have two kinds of thresholds determining whether specific categories will be hidden from its view in the UI: a minimum number of rows in the current selection below which a category will be hidden, or a minimum number of rows in the whole dataset (everything).
The thresholds parameter should be a list containing 1 or 2 objects: the configuration of a selection
threshold, and/or the configuration of a threshold for everything.
Options
Options
array.
Array items
Array items
Configure categories to be discarded (hidden) in terms of their occurrence in the whole dataset.
Categories with a number (or percentage) of rows in the whole dataset less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
array.
Array items
Array items
Configure categories to be discarded (hidden) in terms of their occurrence in the whole dataset.
Categories with a number (or percentage) of rows in the whole dataset less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
array.
Array items
Array items
Configure categories to be discarded (hidden) in terms of their occurrence in the current selection.
Categories with a number (or percentage) of rows in the current selection less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
array.
Array items
Array items
Configure categories to be discarded (hidden) in terms of their occurrence in the whole dataset.
Categories with a number (or percentage) of rows in the whole dataset less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
Configure categories to be discarded (hidden) in terms of their occurrence in the current selection.
Categories with a number (or percentage) of rows in the current selection less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
array.
Array items
Array items
Configure categories to be discarded (hidden) in terms of their occurrence in the current selection.
Categories with a number (or percentage) of rows in the current selection less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
Configure categories to be discarded (hidden) in terms of their occurrence in the whole dataset.
Categories with a number (or percentage) of rows in the whole dataset less than value will be discarded (hidden from the variable’s filter view).
Properties
Properties
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
Whether to interpret the threshold value as an absolute (count) or percentage of rows.
Values must be one of the following:
ABSOLUTEPERCENTAGE
Categories less frequent than this value will be discarded (hidden).
Flag for internal usage identifying non-user configurations.
Label of the graph chart.
Column used for the node sizes in the UI.
Visual representation mode of the insight’s columns. For each column select whether to show it as a list or bar chart. By default, all column representations are “barChart”.
Item properties
Item properties
One or more additional parameters.
Values must be one of the following:
barChartlist
Examples
Examples
{"country": "list", "vote intention": "list", "cluster": "barChart"}
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_CHART
The text shown for this insight element.
Element visibility.
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.