@splunk/visualizations 28.5.3 → 28.7.0

package/docs-llm/process-tree/options.md

@@ -0,0 +1,32 @@
+# Process Tree Visualization Options
+
+**Component Reference:** Process Tree or @splunk/visualizations/processTree
+
+Source: `@splunk/visualization-schemas/processTreeOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color for the background. |
+| `disableExpansionPerNode` | array<string> \| string \| string | `[]` | Specify per-node expansion behavior aligned with nodeSource rows. Use 'disable' to prevent collapsing/expanding that node; 'enable' or null allows expansion. Provide an array, or use a string DSL expression that resolves to an array. |
+| `fieldsToShowAsChip` | array<string> \| string \| string | `[]` | Specify treeNodeLabelFields names whose values should be rendered as chips. Array values render as comma-separated text inside a single chip. Provide an array, or use a string DSL expression that resolves to an array. |
+| `filterButtonColors` | array<string> \| string \| string | `[]` | Specify optional colors for connection filter buttons (for example #FF0000). Provide an array, or use a string DSL expression that resolves to an array. |
+| `filterButtonFields` | array<string> \| string \| string | `[]` | Specify nodeSource field names used by connection filter buttons. Provide an array, or use a string DSL expression that resolves to an array. |
+| `filterButtonMatchValues` | array<string> \| string \| string | `[]` | Specify match values used by connection filter buttons. Provide an array, or use a string DSL expression that resolves to an array. |
+| `filterButtonNames` | array<string> \| string \| string | `[]` | Specify display names for connection filter buttons. Provide an array, or use a string DSL expression that resolves to an array. Falls back to filterButtonMatchValues when omitted. |
+| `filteredNodeField` | string \| string | — | Specify node field name used to classify which nodes render in the right panel and are excluded from the left tree. |
+| `filteredNodeValues` | array<string> \| string \| string | — | Specify field value(s) used with filteredNodeField to classify which nodes render in the right panel. Provide an array, or use a string DSL expression that resolves to an array. |
+| `highlightColor` | string \| string | `rgba(129, 51, 74, 0.82)` | Specify the background color used for the highlighted node row. |
+| `highlightedNodeId` | string \| string | `` | Specify a node id to highlight in the process tree. |
+| `highlightIcon` | string \| string | `` | Specify an optional built-in icon to render for the highlighted node. Supported values are fire, rectangleDashed, cube, servers, and container. |
+| `highlightIconColor` | string \| string | `` | Specify an optional color override for the highlighted node icon. |
+| `linkValues` | array<number \| string> \| string | `[]` | Specify link values for each link row. |
+| `networkNodeColors` | array<string> \| string \| string | `[]` | Specify optional network node indicator colors aligned with nodeSource rows. These colors apply only to right-side network nodes and the process-side circle indicators for those networks. Provide an array, or use a string DSL expression that resolves to an array. |
+| `nodeColors` | array<string> \| string \| string | `[]` | Specify optional node row background colors aligned with nodeSource rows. These colors can fill process tree rows and right-side network rows unless the node is highlighted. Use networkNodeColors to color network indicators. Provide an array, or use a string DSL expression that resolves to an array. |
+| `nodeIcons` | array<string> \| string \| string | `[]` | Specify optional node icons aligned with nodeSource rows. Supported built-in values are fire, rectangleDashed, cube, servers, and container. Provide an array, or use a string DSL expression that resolves to an array. |
+| `nodeId` | array<string> \| string | `> nodeSource \| seriesByName("node_id")` | Specify node ids for node metadata lookup when using a secondary node datasource. |
+| `showFieldName` | boolean \| string | `false` | Specify whether tree node labels render as field=value. When false, only the field value is shown. |
+| `source` | array<string> \| string | `> primary \| frameBySeriesTypes("string") \| seriesByIndex(0)` | Specify the source node id for each link row. |
+| `target` | array<string> \| string | `> primary \| frameBySeriesTypes("string") \| seriesByIndex(1)` | Specify the target node id for each link row. |
+| `treeNodeLabelFields` | array<string> \| string \| string | `[]` | Specify nodeSource field names to render in each tree node label, joined by spaces. Array values render as comma-separated text. Empty or null values are skipped. Provide an array, or use a string DSL expression that resolves to an array. |
+
+_Auto-generated; do not edit by hand._