@splunk/visualizations 28.6.0 → 28.7.0

package/docs-llm/punchcard/options.md

@@ -0,0 +1,33 @@
+# Punchcard Visualization Options
+
+**Component Reference:** Punchcard or @splunk/visualizations/punchcard
+
+Source: `@splunk/visualization-schemas/punchcardOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the background. The default for enterprise light is "#ffffff". The default for enterprise dark is "#000000". The default for prisma dark is "#0b0c0e". |
+| `bubbleColor` | string \| array<unknown> \| string | `> size \| gradient(bubbleColorConfig)` | Specify the coloring method used for the bubbles when the colorMode “dynamic” is specified. For example “> size \| gradient(bubbleColorConfig)". |
+| `bubbleLabelDisplay` | string \| string | `all` | Specify whether all bubble labels, the max value bubble labels, or none of the bubble labels should be displayed. |
+| `bubbleRadiusMax` | number \| string | `15` | Specify the max radius (in pixels) of the bubbles when showDynamicBubbleSize option is false. Greater than 0. |
+| `bubbleRadiusMin` | number \| string | `1` | Specify the min radius (in pixels) of the bubbles when showDynamicBubbleSize option is false. Greater than 0. |
+| `bubbleRowScale` | string \| string | `global` | Specify how bubbles are scaled relative to other rows. |
+| `bubbleSizeMax` | number \| string | `1` | Specify the max percentage (in decimal format) of space a bubble should take up within a cell when showDynamicBubbleSize option is true. The number specified must be between 0 and 1. |
+| `bubbleSizeMethod` | string \| string | `area` | Specify whether bubble area or diameter corresponds to the size value. |
+| `bubbleSizeMin` | number \| string | `0.25` | Specify the min percentage (in decimal format) of space a bubble should take up within a cell when showDynamicBubbleSize option is true. The number specified must be between 0 and 1. |
+| `category` | array<string \| number> \| string | `> primary \| seriesByIndex(3)` | Specify the dataSource to apply series categories. |
+| `categoryField` | string \| string | `> category \| getField()` | Specify the field that should be mapped to the series categories. |
+| `colorMode` | string \| string | `dynamic` | Specify the coloring method used for the bubbles. |
+| `legendDisplay` | string \| string | `right` | Specify the location of the legend on the panel. |
+| `seriesColors` | array<string> \| 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". |
+| `showDefaultSort` | boolean \| string | `false` | Specify whether axes should be sorted based on order of time, digits and strings. |
+| `showDynamicBubbleSize` | boolean \| string | `true` | Specify whether the bubble size should be dynamic or fixed. |
+| `showMaxValuePulsation` | boolean \| string | `true` | Specify whether the max value bubble should pulsate. |
+| `size` | array<number> \| string | `> primary \| seriesByIndex(2)` | Specify the dataSource to apply bubble size in the chart. |
+| `sizeField` | string \| string | `> size \| getField()` | Specify the field that should be mapped to the bubble size in the chart. |
+| `x` | array<string \| number> \| string | `> primary \| seriesByIndex(0)` | Specify the dataSource applied to the x-axis. |
+| `xField` | string \| string | `> x \| getField()` | Specify the field that should be mapped to the x-axis. |
+| `y` | array<string \| number> \| string | `> primary \| seriesByIndex(1)` | Specify the dataSource applied to the y-axis. |
+| `yField` | string \| string | `> y \| getField()` | Specify the field that should be mapped to the y-axis. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/punchcard/overview.md

@@ -0,0 +1,5 @@
+# Punchcard Visualization Guide
+
+**Component Reference:** Punchcard or @splunk/visualizations/Punchcard
+
+_Overview content not available for this visualization._

package/docs-llm/pure-rich-text/options.md

@@ -0,0 +1,28 @@
+# Pure Rich Text Visualization Options
+
+**Component Reference:** Pure Rich Text or @splunk/visualizations/pureRichText
+
+Source: `@splunk/visualization-schemas/pureRichTextOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string | `transparent` | Specify the background color using a Hex code such as "#FF0000" or "transparent". 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]+)?\\$` |
+| `bold` | boolean | `false` | Apply bold font weight to all text by default. |
+| `border` | object | — | Border configuration for the rich text container. |
+| `customFontSize` | number | `14` | Specify the custom font size in pixels when fontSize is set to "custom". Valid range is 1-200. Range: min 1, max 200 |
+| `fontColor` | string | `> themes.defaultFontColor` | Specify the text color using Hex codes or RGBA values, such as "#FF0000" or "rgba(25,12,13,0.1)". The default for enterprise light is "#3c444d". The default for enterprise dark is "#FFFFFF". The default for prisma dark is "rgba(255, 255, 255, 0.7)". 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]+)?\\$` |
+| `fontFamily` | string | `Splunk Data Sans` | Specify the font family for rich text content, such as "Arial" or "Times New Roman". Note: the font needs to be available to your end user. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^Splunk Data Sans$\|^Splunk Platform Sans Mono$\|^Arial$\|^Helvetica$\|^Times New Roman$\|^Comic Sans MS$\|^Georgia$\|^Verdana$\|^Courier New$` |
+| `fontSize` | string | `default` | Specify the base font size preset. Font sizes range from extra small (10px) to extra large (20px) with the default being 14px. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^extraSmall$\|^small$\|^default$\|^large$\|^extraLarge$\|^custom$` |
+| `highlightColor` | string | `transparent` | Specify the highlight/background color for selected text using Hex codes or RGBA values. 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]+)?\\$` |
+| `horizontalAlignment` | string | `left` | Specify the horizontal text alignment. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^left$\|^center$\|^right$\|^justify$` |
+| `italic` | boolean | `false` | Apply italic font style to all text by default. |
+| `lineHeight` | number \| string | `1.5` | Specify the line height as a number (e.g., 1.5 means 150% of font size) or string value. |
+| `link` | string | `` | Specify a URL to make the entire rich text content a clickable link. |
+| `listType` | string | `` | Specify the default list type for the content. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^$\|^unordered$\|^ordered$` |
+| `padding` | number \| array<unknown> | `8` | Padding in pixels. Can be a single number (all sides), array of 2 (vertical, horizontal), or array of 4 (top, right, bottom, left). |
+| `richTextContent` | string | `<p></p>` | HTML content for the rich text editor. Inline styles should only include differences from default text styles. |
+| `strikethrough` | boolean | `false` | Apply strikethrough text decoration to all text by default. |
+| `underline` | boolean | `false` | Apply underline text decoration to all text by default. |
+| `verticalAlign` | string | `top` | Specify the vertical alignment of content within the container. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^top$\|^middle$\|^bottom$` |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/rectangle/examples-json.md

@@ -0,0 +1,5 @@
+# Rectangle Examples
+
+**Visualization Reference:** undefined
+
+_No code examples available for this visualization._

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

@@ -0,0 +1,5 @@
+# Rectangle Examples
+
+**Component Reference:** Rectangle or @splunk/visualizations/Rectangle
+
+_No code examples available for this visualization._

package/docs-llm/rectangle/options.md

@@ -0,0 +1,19 @@
+# Rectangle Visualization Options
+
+**Component Reference:** Rectangle or @splunk/visualizations/rectangle
+
+Source: `@splunk/visualization-schemas/rectangleOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `fillColor` | string \| string | `> themes.defaultFillColor` | Specify the fill color. You may use a dataSource to apply the color. The hex value format should be "#FFFFFF". The default for enterprise light mode is "#C3CBD4". The default for enterprise dark mode is "#31373E". The default for prisma dark mode is "#0B0C0E". |
+| `fillOpacity` | number \| string | `1` | Specify the opacity of the fill. Choose a number in the range of 0 - 1 (inclusive). You can also express the value as a percentage. For example, "0.80" in source or "80%" in UI. |
+| `rx` | number \| string | `0` | Specify the curvature of the horizontal corner (or border) radius with an integer or a percent greater than or equal to zero. |
+| `ry` | number \| string | `> rx` | Specify the curvature of the vertical corner (or border) radius with an integer or a percent greater than or equal to zero. |
+| `strokeColor` | string \| string | `> themes.defaultStrokeColor` | Specify the stroke color. You may use a dataSource to apply the color. The hex value format should be "#FFFFFF". The default for enterprise light mode is "#3C444D". The default for enterprise dark mode is "#C3CBD4". The default for prisma dark mode is "#ACACAD". |
+| `strokeDashStyle` | number \| string | `0` | Specify the size, in pixels, of dashes and spaces used to create a custom stitched outline. The value you specify applies to both the dashes and the spaces between them. |
+| `strokeJoinStyle` | string \| string | `miter` | Specifies the shape to be used at the corners of paths when they are joined. |
+| `strokeOpacity` | number \| string | `1` | Specify the opacity of the stroke. Choose a number in the range of 0 - 1 (inclusive). You can also express the value as a percentage. For example, "0.80" in source or "80%" in UI. |
+| `strokeWidth` | number \| string | `1` | Specify the width of the stroke, in pixels. The minimum value is 0. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/rectangle/overview.md

@@ -0,0 +1,5 @@
+# Rectangle Visualization Guide
+
+**Component Reference:** Rectangle or @splunk/visualizations/Rectangle
+
+_Overview content not available for this visualization._

package/docs-llm/rich-text/examples-json.md

@@ -0,0 +1,96 @@
+# RichText Examples
+
+**Visualization Reference:** undefined
+
+## Basic Rich Text
+
+- **Key:** Basic
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```
+
+## Font Family - Times New Roman
+
+- **Key:** Font Family
+
+```json
+{
+  "context": {},
+  "options": {
+    "richTextContent": "<p>This text uses Times New Roman.</p>",
+    "fontFamily": "Times New Roman"
+  },
+  "dataSources": {}
+}
+```
+
+## Font Size - extraLarge
+
+- **Key:** Extra Large
+
+```json
+{
+  "context": {},
+  "options": {
+    "richTextContent": "<p>Extra large text.</p>",
+    "fontSize": "extraLarge"
+  },
+  "dataSources": {}
+}
+```
+
+## Font Size - custom (30px)
+
+- **Key:** Custom Font
+
+```json
+{
+  "context": {},
+  "options": {
+    "richTextContent": "<p>Custom 30px text.</p>",
+    "fontSize": "custom",
+    "customFontSize": 30
+  },
+  "dataSources": {}
+}
+```
+
+## Lists
+
+- **Key:** Lists
+
+```json
+{
+  "context": {},
+  "options": {
+    "richTextContent": "<ul><li>First bullet item</li><li>Second bullet item</li></ul><ol><li>First numbered item</li><li>Second numbered item</li></ol>"
+  },
+  "dataSources": {}
+}
+```
+
+## Border and Padding
+
+- **Key:** Border
+
+```json
+{
+  "context": {},
+  "options": {
+    "richTextContent": "<p>Text with a border and padding.</p>",
+    "border": {
+      "color": "#4287f5",
+      "width": 2,
+      "style": "solid",
+      "radius": 8
+    },
+    "padding": 16
+  },
+  "dataSources": {}
+}
+```

package/docs-llm/rich-text/examples-react.md

@@ -0,0 +1,119 @@
+# RichText Examples
+
+**Component Reference:** RichText or @splunk/visualizations/RichText
+
+## Basic Rich Text
+
+- **Key:** Basic
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={120}
+        options={{
+            richTextContent:
+                '<p><strong>Bold text</strong>, <em>italic text</em>, and <u>underlined text</u>.</p><p>A second paragraph with <a href="http://example.com/">a link</a>.</p>',
+        }}
+    />
+);
+```
+
+## Font Family - Times New Roman
+
+- **Key:** Font Family
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={80}
+        options={{
+            richTextContent: '<p>This text uses Times New Roman.</p>',
+            fontFamily: 'Times New Roman',
+        }}
+    />
+);
+```
+
+## Font Size - extraLarge
+
+- **Key:** Extra Large
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={80}
+        options={{
+            richTextContent: '<p>Extra large text.</p>',
+            fontSize: 'extraLarge',
+        }}
+    />
+);
+```
+
+## Font Size - custom (30px)
+
+- **Key:** Custom Font
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={80}
+        options={{
+            richTextContent: '<p>Custom 30px text.</p>',
+            fontSize: 'custom',
+            customFontSize: 30,
+        }}
+    />
+);
+```
+
+## Lists
+
+- **Key:** Lists
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={140}
+        options={{
+            richTextContent:
+                '<ul><li>First bullet item</li><li>Second bullet item</li></ul><ol><li>First numbered item</li><li>Second numbered item</li></ol>',
+        }}
+    />
+);
+```
+
+## Border and Padding
+
+- **Key:** Border
+
+```jsx
+import React from 'react';
+import RichText from '@splunk/visualizations/RichText';
+
+export default () => (
+    <RichText
+        height={80}
+        options={{
+            richTextContent: '<p>Text with a border and padding.</p>',
+            border: { color: '#4287f5', width: 2, style: 'solid', radius: 8 },
+            padding: 16,
+        }}
+    />
+);
+```

package/docs-llm/rich-text/options.md

@@ -0,0 +1,28 @@
+# Rich Text Visualization Options
+
+**Component Reference:** Rich Text or @splunk/visualizations/richText
+
+Source: `@splunk/visualization-schemas/richTextOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string | `transparent` | Specify the background color using a Hex code such as "#FF0000" or "transparent". 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]+)?\\$` |
+| `bold` | boolean | `false` | Apply bold font weight to all text by default. |
+| `border` | object | — | Border configuration for the rich text container. |
+| `customFontSize` | number | `14` | Specify the custom font size in pixels when fontSize is set to "custom". Valid range is 1-200. Range: min 1, max 200 |
+| `fontColor` | string | `> themes.defaultFontColor` | Specify the text color using Hex codes or RGBA values, such as "#FF0000" or "rgba(25,12,13,0.1)". The default for enterprise light is "#3c444d". The default for enterprise dark is "#FFFFFF". The default for prisma dark is "rgba(255, 255, 255, 0.7)". 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]+)?\\$` |
+| `fontFamily` | string | `Splunk Data Sans` | Specify the font family for rich text content, such as "Arial" or "Times New Roman". Note: the font needs to be available to your end user. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^Splunk Data Sans$\|^Splunk Platform Sans Mono$\|^Arial$\|^Helvetica$\|^Times New Roman$\|^Comic Sans MS$\|^Georgia$\|^Verdana$\|^Courier New$` |
+| `fontSize` | string | `default` | Specify the base font size preset. Font sizes range from extra small (10px) to extra large (20px) with the default being 14px. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^extraSmall$\|^small$\|^default$\|^large$\|^extraLarge$\|^custom$` |
+| `highlightColor` | string | `transparent` | Specify the highlight/background color for selected text using Hex codes or RGBA values. 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]+)?\\$` |
+| `horizontalAlignment` | string | `left` | Specify the horizontal text alignment. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^left$\|^center$\|^right$\|^justify$` |
+| `italic` | boolean | `false` | Apply italic font style to all text by default. |
+| `lineHeight` | number \| string | `1.5` | Specify the line height as a number (e.g., 1.5 means 150% of font size) or string value. |
+| `link` | string | `` | Specify a URL to make the entire rich text content a clickable link. |
+| `listType` | string | `` | Specify the default list type for the content. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^$\|^unordered$\|^ordered$` |
+| `padding` | number \| array<unknown> | `8` | Padding in pixels. Can be a single number (all sides), array of 2 (vertical, horizontal), or array of 4 (top, right, bottom, left). |
+| `richTextContent` | string | `<p></p>` | HTML content for the rich text editor. Inline styles should only include differences from default text styles. |
+| `strikethrough` | boolean | `false` | Apply strikethrough text decoration to all text by default. |
+| `underline` | boolean | `false` | Apply underline text decoration to all text by default. |
+| `verticalAlign` | string | `top` | Specify the vertical alignment of content within the container. Pattern: `\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$\|^top$\|^middle$\|^bottom$` |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/rich-text/overview.md

@@ -0,0 +1,5 @@
+# RichText Visualization Guide
+
+**Component Reference:** RichText or @splunk/visualizations/RichText
+
+_Overview content not available for this visualization._