@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/sankey/examples-react.md

@@ -0,0 +1,546 @@
+# Sankey Examples
+
+**Component Reference:** Sankey or @splunk/visualizations/Sankey
+
+## Basic Sankey
+
+- **Key:** Basic
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Background Color
+
+- **Key:** Background Color
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            backgroundColor: 'pink',
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Backward Links
+
+- **Key:** Backward Links
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        [
+                            'Oil',
+                            'Natural Gas',
+                            'Coal',
+                            'Coal',
+                            'Fossil Fuels',
+                            'Electricity',
+                            'Electricity',
+                            'Energy',
+                        ],
+                        [
+                            'Fossil Fuels',
+                            'Fossil Fuels',
+                            'Fossil Fuels',
+                            'Electricity',
+                            'Energy',
+                            'Energy',
+                            'Electricity',
+                            'Oil',
+                        ],
+                        [15, 20, 25, 25, 60, 25, 5, 2],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Specified Field for Link Values
+
+- **Key:** Specified Field
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            linkValues: '> primary | seriesByName("value2")',
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                        [1, 20, 3, 4, 50, 6],
+                    ],
+                    fields: ['source', 'target', 'value', 'value2'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Link Opacity
+
+- **Key:** Link Opacity
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            linkOpacity: 0.2,
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Series Colors
+
+- **Key:** Series Colors
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            seriesColors: ['#9980FF', '#45D4BA', '#FB865C', '#66AAF9', '#E85B79', '#88EE66', '#F0B000'],
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Link Colors
+
+- **Key:** Link Colors
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        context={{
+            linkColorRangeConfig: [
+                { to: 20, value: '#D41F1F' },
+                { from: 20, to: 40, value: '#D94E17' },
+                { from: 40, to: 60, value: '#CBA700' },
+                { from: 60, to: 80, value: '#669922' },
+                { from: 80, value: '#118832' },
+            ],
+        }}
+        options={{
+            colorMode: 'dynamic',
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Label Display
+
+- **Key:** Link Colors
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            labelDisplay: 'valuesAndPercentage',
+            width: 940,
+            height: 490,
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        [
+                            'Total Spending',
+                            'Total Spending',
+                            'Total Spending',
+                            'SCP',
+                            'SCP',
+                            'Security',
+                            'Security',
+                            'Security',
+                            'Observability',
+                            'Observability',
+                        ],
+                        [
+                            'SCP',
+                            'Security',
+                            'Observability',
+                            'SCP Policy Engine',
+                            'Service Control API',
+                            'IAM',
+                            'Firewall',
+                            'Encryption',
+                            'Logging',
+                            'Monitoring',
+                        ],
+                        [
+                            5000000, 8000000, 7000000, 3000000, 2000000, 4000000, 2500000, 1500000, 4000000,
+                            3000000,
+                        ],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Unit
+
+- **Key:** Unit
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            labelDisplay: 'valuesAndPercentage',
+            unit: '$',
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Limit Results
+
+- **Key:** Limit Results
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            resultLimit: 4,
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        ['Oil', 'Natural Gas', 'Coal', 'Coal', 'Fossil Fuels', 'Electricity'],
+                        ['Fossil Fuels', 'Fossil Fuels', 'Fossil Fuels', 'Electricity', 'Energy', 'Energy'],
+                        [15, 20, 25, 25, 60, 25],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```
+
+## Dense Data
+
+- **Key:** Dense Data
+
+```jsx
+import React from 'react';
+import Sankey from '@splunk/visualizations/Sankey';
+
+export default () => (
+    <Sankey
+        options={{
+            width: 900,
+            height: 600,
+        }}
+        dataSources={{
+            primary: {
+                data: {
+                    columns: [
+                        [
+                            'Advocacy and Education',
+                            'Advocacy and Education',
+                            'Advocacy and Education',
+                            'Advocacy and Education',
+                            'Advocacy and Education',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Contributions, Gifts & Grants',
+                            'Development and Relief Services',
+                            'Development and Relief Services',
+                            'Development and Relief Services',
+                            'Development and Relief Services',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Environmental Protection and Conservation',
+                            'Environmental Protection and Conservation',
+                            'Environmental Protection and Conservation',
+                            'Environmental Protection and Conservation',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Fundraising Events',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Government Grants',
+                            'Homeless Services',
+                            'Homeless Services',
+                            'Homeless Services',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Medical Research',
+                            'Medical Research',
+                            'Medical Research',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Multipurpose Human Service Organizations',
+                            'Multipurpose Human Service Organizations',
+                            'Multipurpose Human Service Organizations',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Museums',
+                            'Museums',
+                            'Museums',
+                            'Museums',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Other Revenue',
+                            'Performing Arts',
+                            'Performing Arts',
+                            'Performing Arts',
+                            'Performing Arts',
+                            'Performing Arts',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                            'Program Service Revenue',
+                        ],
+                        [
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Advocacy and Education',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Performing Arts',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Advocacy and Education',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Performing Arts',
+                            'Advocacy and Education',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Performing Arts',
+                            'Administrative Expenses',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Advocacy and Education',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Performing Arts',
+                            'Administrative Expenses',
+                            'Deficit',
+                            'Excess',
+                            'Fundraising Expenses',
+                            'Program Expenses',
+                            'Advocacy and Education',
+                            'Development and Relief Services',
+                            'Environmental Protection and Conservation',
+                            'Homeless Services',
+                            'Medical Research',
+                            'Multipurpose Human Service Organizations',
+                            'Museums',
+                            'Performing Arts',
+                        ],
+                        [
+                            86048287, 19527597, 180998707, 102847712, 551149431, 692368620, 5168026746,
+                            1348059493, 40397702, 3135201571, 596186305, 1134802008, 535612677, 380710374,
+                            234695006, 301119719, 303222132, 6844599994, 223176655, 12910749, 200278135,
+                            245605924, 1458686081, 35787203, 47996098, 24894387, 1489828, 1384896423,
+                            47373812, 74954150, 68126458, 97922898, 1995467819, 177851864, 36400813,
+                            452557152, 74042793, 289426307, 86150713, 8168643, 11849011, 5258340, 73010009,
+                            600149733, 143027122, 425457173, 681830799, 5923646137, 159174125, 86842537,
+                            93271044, 36180706, 1615801951, 360654482, 24558593, 457425006, 129388446,
+                            1765421094, 45225660, 138826432, 153235160, 7518524, 695777987, 208603344,
+                            824815361, 169700551, 135910859, 36234508, 140192511, 93937162, 1142671094,
+                            27444378, 156203421, 384935669, 11863706, 1777488301, 832724174, 273125661,
+                            600421167,
+                        ],
+                    ],
+                    fields: ['source', 'target', 'value'],
+                },
+            },
+        }}
+    />
+);
+```

package/docs-llm/sankey/options.md

@@ -0,0 +1,19 @@
+# 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._

package/docs-llm/sankey/overview.md

@@ -0,0 +1,24 @@
+# Sankey Visualization Guide
+
+**Component Reference:** Sankey or @splunk/visualizations/Sankey
+
+## Overview
+
+Sankey diagrams are used to depict flows from a set of elements to another. The features being connected in the visualization are called nodes and the connectors are called links. Sankeys are best used when you want to show a many-to-many mapping between two domains or multiple paths through a set of stages. The widths show proportionality to the amount in each link.
+
+## Details
+
+- **Category:** Flow
+- **Visualization Type:** splunk.sankey
+
+## Tips
+
+- Sankey diagrams work best when showcasing data that is flowing in a single direction.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Coloring Categorically By Node | Use node coloring to easily distinguish between various entities. | coloringCategoricallyByNode |
+| Coloring By Range Value | Use range value coloring to convey numeric thresholds associated with the link width values. | colorByRangeValue |
+| Backward Links | Enable backward links to show data that is flowing in the opposite direction. | backwardLinks |