Skip to main content

​
Usage

The following shows how the step can be used in a recipe.

Examples

  • Signature
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.
create_graph_insight(, {
    "param": value,
    ...
})

​
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").

​
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

​
title
string
required
Title of the insight.
​
replayDisabled
[string, boolean]
default:"false"
Indicates if the insight can replay its original state or not.Values must be one of the following:
  • drillDown
  • directSelectionInGraph
  • nonPersistedColumn
  • True
  • False
​
colorColumn
[string, null]
Column used to color the UI.
​
insightThemeMode
string
Theme mode applied to the whole insight.Values must be one of the following:
  • dark
  • light
​
isAutoMode
boolean
Defines if the cross-filters mode is set to auto.
​
ignoreNulls
boolean
Defines if the cross-filters and significant variables should ignore null values.
​
relative
boolean
Defines if the cross-filters mode is set to relative.
​
selection
string
A filter query. See Advanced query filters for more information.
​
categoricalColumnsOrdering
object
The order in which a variable’s categories are displayed. An object configuring for each column a method determining the order of its categories.
​
Items
string
Order of the categories in a specific column.Values must be one of the following:
  • BACKGROUND
  • FOREGROUND
  • UPLIFT
  • TFIDF
  • ORDINAL
​
categoricalColumnsThreshold
object
Configure categories to hide in the filter view of categorical variables. Categories less frequent than the configured threshold will not appear in the UI.
​
thresholds
[array, array, array, array]
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.
  • array
  • array
  • array
  • array
​
{_}
array
array.
​
Item 0
object
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).
​
target
string
default:"EVERYTHING"
Whether to apply the threshold to the current selection of rows or all rows in the dataset.
​
reference
string
Whether to interpret the threshold value as an absolute (count) or percentage of rows.Values must be one of the following:
  • ABSOLUTE
  • PERCENTAGE
​
value
number
Categories less frequent than this value will be discarded (hidden).
​
isDefault
boolean
default:"false"
Flag for internal usage identifying non-user configurations.
​
label
string
required
Label of the graph chart.
​
sizeColumn
[string, null]
Column used for the node sizes in the UI.
​
columnViewModes
object
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”.
​
Items
string
One or more additional parameters.Values must be one of the following:
  • barChart
  • list
  • {"country": "list", "vote intention": "list", "cluster": "barChart"}
​
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.
​
kind
string
Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
​
text
string
The text shown for this insight element.
​
hidden
boolean
Element visibility.
​
layout
object
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.
​
x
integer
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:
-1 ≤ x ≤ 11
​
y
integer
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:
0 ≤ y ≤ 11
​
w
integer
The width of the element (in increments of 1).Values must be in the following range:
0 ≤ w ≤ 12
​
h
integer
The height of the element (in increments of 1).Values must be in the following range:
0 ≤ h ≤ 9
​
column
string
Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.
⌘I