# Treemap Visualization Options

**Component Reference:** Treemap or @splunk/visualizations/treemap

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

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `additionalTooltipFields` | array<string> | `[]` | Specify additional fields to display in the tooltip for each node. Items: string |
| `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]+)?\\$` |
| `dataColors` | string \| array<string> | — | Specify the colors to use for treemap nodes. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, "> primary \| seriesByName("population") \| rangeValue(colorRangeConfig)". By default, the dataColors option is not defined and seriesColors is used for categorical coloring. Items: string |
| `dataColorValues` | array<number \| string> | `> primary \| seriesByType('number')` | Specify the array of values used for dynamic treemap coloring. Items: number \| string |
| `legendDisplay` | string | `off` | Specify the location of the legend on the panel. Allowed values: `bottom`, `off` |
| `nodeIds` | array<string> | `> primary \| seriesByType("string")` | Specify the array of node IDs in the hierarchy. Items: string |
| `nodeLabels` | array<string> | `> primary \| seriesByType("string")` | Specify the array of display labels for treemap nodes. Items: string |
| `parent` | array<string> | — | Specify the array of parent node names in the hierarchy. Items: string |
| `resultLimit` | number | `10000` | Specify the maximum number of treemap 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 root categories. For example, ["#FF0000", "#0000FF", "#008000"]. Items: string |
| `showChildValues` | boolean | `true` | Specify whether to display values for child and leaf nodes. |
| `showParentValues` | boolean | `true` | Specify whether to display the values of each parent node. This only applies when showSubdivisions is true. |
| `showSubdivisions` | boolean | `true` | Specify whether to display nested subdivisions inside parent nodes. |
| `showTooltip` | boolean | `false` | Specify whether to display the tooltip when hovering over nodes. |
| `sumFromLeafNodes` | boolean | `false` | Specify whether parent values are calculated from leaf children instead of using provided parent values. |
| `value` | array<number> | `> primary \| seriesByType('number')` | Specify the numeric field used to determine the size (area) of each treemap node. Items: number |

_Auto-generated; do not edit by hand._
