# Sankey Visualization Options

**Component Reference:** Sankey or @splunk/visualizations/sankey

Source: `@splunk/visualization-schemas/sankeyOptionsSchema`

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may use a dataSource to apply the color. The default for enterprise light is "#ffffff". The default for enterprise dark is "#000000". The default for prisma dark is "#0b0c0e". Pattern: `^#(?:[0-9a-fA-F]{3,4}\|[0-9a-fA-F]{6}\|[0-9a-fA-F]{8})$\|^transparent$\|^rgb\\(\\s*(\\d{1,3}),\\s*(\\d{1,3}),\\s*(\\d{1,3})\\)$\|^rgba\\(\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d*(?:\\.\\d+)?)\\)$\|\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$` |
| `colorMode` | string | `categorical` | Specify the coloring method used for the links. When set to "categorical" the nodes and links will be colored based on the "seriesColors". When set to "dynamic" the links will be colored based on the dynamic string assigned to "linkColors". Allowed values: `categorical`, `dynamic` |
| `labelDisplay` | string | `off` | Specify whether to display the values and/or percentages of the nodes. Values are abbreviated to two decimal points, and a magnitude unit will be displayed. Percentages are calculated using the maximum node value as 100%. For very small nodes (with height < 24px) the values/percentage display is automatically turned off. Allowed values: `values`, `valuesAndPercentage`, `percentage`, `off` |
| `linkColors` | array<string> | `> linkValues \| rangeValue(linkColorRangeConfig)` | Specify the coloring method used for the links when the colorMode “dynamic” is specified. Items: string |
| `linkOpacity` | number | `0.5` | Specify the opacity of the links. Choose a number in the range of 0 - 1 (inclusive). |
| `linkValues` | string | `> primary \| seriesByType('number')` | Specify the dataSource to apply link width. |
| `resultLimit` | number | `1000` | Specify the maximum length of link data points rendered. |
| `seriesColors` | array<string> | `["#7B56DB","#009CEB","#00CDAF","#DD9900","#FF677B","#CB2196","#813193","#0051B5","#008C80","#99B100","#FFA476","#FF6ACE","#AE8CFF","#00689D","#00490A","#465D00","#9D6300","#F6540B","#FF969E","#E47BFE"]` | Specify the colors used for a series. For example, ["#FF0000", "#0000FF", "#008000"]. Items: string |
| `unit` | string | — | Specify text to show on the left of the value in the node label when "labelDisplay" is set to either "values" or "valuesAndPercentage" |

_Auto-generated; do not edit by hand._
