> ## Documentation Index
> Fetch the complete documentation index at: https://docs.graphext.com/llms.txt
> Use this file to discover all available pages before exploring further.
# create_compare_insight
> Create a new insight from the Compare section.
## 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.
```stan theme={null}
create_compare_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)`.
Title of the insight.
Columns from which the insight is created.
Each item in array.
Columns that will not be used to create the insight.
Each item in array.
Theme mode applied to the whole insight.
Values must be one of the following:
* `dark`
* `light`
Sets the correlation graph as expanded.
If true, the insight will contain an expanded chart in order to show the maximum number of categories possible.
Useful to choose the ordering kind of the columns, by difference or by similarity.
Values must be one of the following:
* `differentFirst`
* `similarFirst`
Indicates if the insight can replay its original state or not.
Values must be one of the following:
* `drillDown`
* `directSelectionInGraph`
* `nonPersistedColumn`
* `True`
* `False`
Sets the visualization type.
In relative and absolute modes the comparing segments will be rendered as charts, but in tabular mode a table is shown.
Values must be one of the following:
* `relative`
* `absolute`
* `tabular`
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.
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.
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:
```javascript theme={null}
-1 ≤ x ≤ 11
```
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:
```javascript theme={null}
0 ≤ y ≤ 11
```
The width of the element (in increments of 1).
Values must be in the following range:
```javascript theme={null}
0 ≤ w ≤ 12
```
The height of the element (in increments of 1).
Values must be in the following range:
```javascript theme={null}
0 ≤ h ≤ 9
```
Name of the column containing the data to be used in this insight element.
*Required* if the element is of type CHART or STATS.
Array of segments to use in the insight.
Defines some behavior in the UI for this comparing segment.
Values must be one of the following:
* `VALUES`
* `RANGE`
* `EVERYTHING`
* `SELECTION`
Specify if the comparing segment column was used in the relevance analysis or not.
Main column from which the insight is created.
Selection Values.
In categorical and text columns, a selection of single values can be made and this type is useful to do that.
Each item in array.
Selection Range.
This type is useful for quantitative columns, in which a selection of values in range can be made.
Each item in array.