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

# configure_color_palette

> Configures the base global color palettes to use when coloring categorical or quantitative columns. 

Sets the global color palettes used across the project for different column types. You can configure separate palettes for categorical columns, sequential single-hue (numeric with one direction), sequential multi-hue (numeric with gradient), and diverging (numeric with a center point). If not configured, Graphext uses its default palettes.

This is a UI configuration step that affects how the project is displayed in Graphext. It applies to the dataset referenced in its inputs. If your recipe produces multiple datasets (e.g. a filtered dataset that is then passed to create\_project alongside the original), you need to add separate configure steps for each dataset you want to configure.

## Usage

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

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="Example 1">
      Use Osiris, Greens, Magma & Red-Yellow-Green palettes.

      ```stan theme={null}
      configure_color_palette({
          "categorical": "Osiris",
          "sequentialSingleHue": "Greens",
          "sequentialMultiHue": "Magma",
          "diverging": "Red-Yellow-Green"
      })
      ```
    </Tab>

    <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}
      configure_color_palette(, {
          "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="categorical" type="string">
    Categorical palette.

    Values must be one of the following:

    * `Horus`
    * `Osiris`
    * `Re`
  </ParamField>

  <ParamField path="sequentialSingleHue" type="string">
    Sequential Single-Hue palette.

    Values must be one of the following:

    * `Blues`
    * `Greens`
    * `Oranges`
    * `Purples`
    * `Reds`
  </ParamField>

  <ParamField path="sequentialMultiHue" type="string">
    Sequential Multi-Hue palette.

    Values must be one of the following:

    * `Viridis`
    * `Magma`
    * `Plasma`
  </ParamField>

  <ParamField path="diverging" type="string">
    Diverging palette.

    Values must be one of the following:

    * `Red-Blue`
    * `Red-Yellow-Green`
  </ParamField>
</Accordion>