> ## 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_text_insight

> Create a new insight using only plain text. 

## Usage

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

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="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.

      ```stan theme={null}
      create_text_insight(, {
          "param": value,
          ...
      })
      ```
    </Tab>
  </Tabs>
</Accordion>

## 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"`).

<Accordion title="Inputs" icon="right-to-bracket" />

<Accordion title="Outputs" icon="right-from-bracket" />

## 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)`.

<Accordion title="Parameters" defaultOpen="true" icon="sliders">
  <ParamField path="title" type="string" required>
    Title of the insight.
  </ParamField>

  <ParamField path="elements" type="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.

    <Accordion title="Array items">
      <ParamField path="kind" type="string">
        Specify the type of element.

        Values must be one of the following:

        `TITLE` `DESCRIPTION` `CHART` `GRAPH` `STATS` `LEGEND` `LEGEND_COLOR_SCALE` `TABLE_CHART`
      </ParamField>

      <ParamField path="text" type="string">
        The text shown for this insight element.
      </ParamField>

      <ParamField path="hidden" type="boolean">
        Element visibility.
      </ParamField>

      <ParamField path="layout" type="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.

        <Accordion title="Properties">
          <ParamField path="x" type="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:

            ```javascript theme={null}
            -1 ≤ x ≤ 11
            ```
          </ParamField>

          <ParamField path="y" type="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:

            ```javascript theme={null}
            0 ≤ y ≤ 11
            ```
          </ParamField>

          <ParamField path="w" type="integer">
            The width of the element (in increments of 1).

            Values must be in the following range:

            ```javascript theme={null}
            0 ≤ w ≤ 12
            ```
          </ParamField>

          <ParamField path="h" type="integer">
            The height of the element (in increments of 1).

            Values must be in the following range:

            ```javascript theme={null}
            0 ≤ h ≤ 9
            ```
          </ParamField>
        </Accordion>
      </ParamField>

      <ParamField path="column" type="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.
      </ParamField>
    </Accordion>
  </ParamField>
</Accordion>