@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/map/options.md

@@ -0,0 +1,22 @@
+# Map Visualization Options
+
+**Component Reference:** Map or @splunk/visualizations/map
+
+Source: `@splunk/visualization-schemas/mapOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify a color for the background. You might 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]+)?\\$` |
+| `baseLayerTileServer` | string | — | Specify the URL for the set of tiles that make up the base map. |
+| `baseLayerTileServerType` | string | — | Specify the type of tile set for the base map. Allowed values: `vector`, `raster` |
+| `center` | array<number> | — | Specify the center of the map in coordinates, in the form of [latitude, longitude]. If you don’t provide coordinates, the map automatically centers, based on available location data. If there is no available location data, the center of the map defaults to [37.7749, -122.4194]. Items: number |
+| `icon` | string | `` | Specify the url for an svg to display an icon inside bubbles for map. This applies to layers where type: "bubble". |
+| `layers` | array<object> | `[{"type":"bubble","latitude":"> primary \| seriesByName(\\"latitude\\")","longitude":"> primary \| seriesByName(\\"longitude\\")","seriesColors":["#7B56DB","#009CEB","#00CDAF","#DD9900","#FF677B","#CB2196","#813193","#0051B5","#008C80","#99B100","#FFA476","#FF6ACE","#AE8CFF","#00689D","#00490A","#465D00","#9D6300","#F6540B","#FF969E","#E47BFE"],"dataValues":"> primary \| seriesByType(\\"number\\")","dataColors":"","bubbleSize":"> primary \| frameWithoutSeriesNames(\\"geobin\\", \\"latitude\\", \\"longitude\\") \| frameBySeriesTypes(\\"number\\")","additionalTooltipFields":[],"resultLimit":1000},{"type":"marker","latitude":"> primary \| seriesByName(\\"latitude\\")","longitude":"> primary \| seriesByName(\\"longitude\\")","seriesColors":["#7B56DB","#009CEB","#00CDAF","#DD9900","#FF677B","#CB2196","#813193","#0051B5","#008C80","#99B100","#FFA476","#FF6ACE","#AE8CFF","#00689D","#00490A","#465D00","#9D6300","#F6540B","#FF969E","#E47BFE"],"dataValues":"> primary \| seriesByType(\\"number\\")","dataColors":"","additionalTooltipFields":[],"resultLimit":1000},{"type":"choropleth","areaIds":"> primary \| seriesByType(\\"string\\")","areaValues":"> primary \| seriesByType(\\"number\\")","dataColors":"> areaValues \| gradient()","additionalTooltipFields":[],"resultLimit":1000,"choroplethEmptyAreaColor":"> themes.defaultChoroplethEmptyAreaColor","choroplethStrokeColor":"transparent","choroplethOpacity":0.8}]` | Specify the optional data visualization layers over the base map. If empty, only the base map appears. Items: object |
+| `scaleUnit` | string | `metric` | Specify the scale unit to use. Allowed values: `metric`, `imperial` |
+| `showBaseLayer` | boolean | `true` | Specify if showing the base map. |
+| `showCoordinates` | boolean | `true` | Specify whether to display coordinates (latitude and longitude) in the tooltip. |
+| `showScale` | boolean | `true` | Specify whether to display the scale on the bottom left. |
+| `showZoomControls` | boolean | `true` | Specify whether to display the control panel of zoom on the top left. |
+| `zoom` | number | — | Specify the zoom level of the map. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/map/overview.md

@@ -0,0 +1,32 @@
+# Map Visualization Guide
+
+**Component Reference:** Map or @splunk/visualizations/Map
+
+## Overview
+
+A map is used to show geospatial data.
+
+## Details
+
+- **Category:** Spatial
+- **Visualization Type:** splunk.map
+
+## Tips
+
+- Map cooperative gesture is enabled -- scroll-to-zoom requires using the control (Windows) or command (Mac) key while scrolling to zoom the map. On touch devices, panning requires using two fingers.
+- Use bubble layers to visualize count distributions across geographic locations.
+- Use marker layers to identify specific locations.
+- Use choropleth layers to visualize relationships between elements in certain locations or areas
+- Add color to distinguish specific categories or associated statuses.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Bubble: Single Series | Use a bubble layer with Splunk’s geostats command to show distribution across various locations, where bubble size correlates to count. | basicbubbletype |
+| Bubble: Multi Series | Use a bubble layer with Splunk’s geostats command to show distribution of multiple series across various locations. Locations with data from multiple series will display as a pie chart. | bubbletypeseriescolors |
+| Marker: Single Series | Use a marker layer to define specific locations with latitude and longitude points. | basicmarkertype |
+| Marker: Multi Series | Use a marker layer with dynamic coloring to define specific, categorized locations with latitude and longitude points. Each color should correspond to a defined category or status. | markertypedatacolors |
+| Choropleth | Use a choropleth layer with dynamic coloring to define relationships between geographic locations. The default colors will display a gradient from the configured area values. | basicchoroplethtype |
+| Choropleth: Source World | Use a choropleth layer with world source geojson option to define relationships between geographic locations in the world. The default colors will display a gradient from the configured area values. | choroplethtypeworld |
+| Choropleth: Source US | Use a choropleth layer with US source geojson option to define relationships between geographic locations in the US. The default colors will display a gradient from the configured area values. | choroplethtypeus |

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

@@ -0,0 +1,63 @@
+# Markdown Examples
+
+**Visualization Reference:** undefined
+
+## Basic Markdown
+
+- **Key:** Basic
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```
+
+## Font Family - Comic Sans MS
+
+- **Key:** Font Family
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```
+
+## Font Size - extraLarge
+
+- **Key:** Extra Large
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```
+
+## Font Size - custom
+
+- **Key:** Custom Font
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```
+
+## Rotation - 180 degrees
+
+- **Key:** Rotation
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {}
+}
+```

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

@@ -0,0 +1,98 @@
+# Markdown Examples
+
+**Component Reference:** Markdown or @splunk/visualizations/Markdown
+
+## Basic Markdown
+
+- **Key:** Basic
+
+```jsx
+import React from 'react';
+import Markdown from '@splunk/visualizations/Markdown';
+
+export default () => (
+    <Markdown
+        options={{
+            markdown:
+                "# Heading level 1\n## Heading level 2\n### Heading level 3\n**bold text**\n*italic text*\n\n[link here](http://example.com/)\n> quote\n\nhorizontal line:\n___\n`small code section`\n```\n// large code section\nimport React from 'react';\nimport Markdown from '@splunk/visualizations/Markdown';\n```\n- first bullet item\n- second bullet item\n1. first item\n2. second item",
+        }}
+    />
+);
+```
+
+## Font Family - Comic Sans MS
+
+- **Key:** Font Family
+
+```jsx
+import React from 'react';
+import Markdown from '@splunk/visualizations/Markdown';
+
+export default () => (
+    <Markdown
+        options={{
+            markdown:
+                "# Heading level 1\n## Heading level 2\n### Heading level 3\n**bold text**\n*italic text*\n\n[link here](http://example.com/)\n> quote\n\nhorizontal line:\n___\n`small code section`\n```\n// large code section\nimport React from 'react';\nimport Markdown from '@splunk/visualizations/Markdown';\n```\n- first bullet item\n- second bullet item\n1. first item\n2. second item",
+            fontFamily: 'Comic Sans MS',
+        }}
+    />
+);
+```
+
+## Font Size - extraLarge
+
+- **Key:** Extra Large
+
+```jsx
+import React from 'react';
+import Markdown from '@splunk/visualizations/Markdown';
+
+export default () => (
+    <Markdown
+        options={{
+            markdown:
+                "# Heading level 1\n## Heading level 2\n### Heading level 3\n**bold text**\n*italic text*\n\n[link here](http://example.com/)\n> quote\n\nhorizontal line:\n___\n`small code section`\n```\n// large code section\nimport React from 'react';\nimport Markdown from '@splunk/visualizations/Markdown';\n```\n- first bullet item\n- second bullet item\n1. first item\n2. second item",
+            fontSize: 'extraLarge',
+        }}
+    />
+);
+```
+
+## Font Size - custom
+
+- **Key:** Custom Font
+
+```jsx
+import React from 'react';
+import Markdown from '@splunk/visualizations/Markdown';
+
+export default () => (
+    <Markdown
+        options={{
+            markdown:
+                "# Heading level 1\n## Heading level 2\n### Heading level 3\n**bold text**\n*italic text*\n\n[link here](http://example.com/)\n> quote\n\nhorizontal line:\n___\n`small code section`\n```\n// large code section\nimport React from 'react';\nimport Markdown from '@splunk/visualizations/Markdown';\n```\n- first bullet item\n- second bullet item\n1. first item\n2. second item",
+            fontSize: 'custom',
+            customFontSize: 30,
+        }}
+    />
+);
+```
+
+## Rotation - 180 degrees
+
+- **Key:** Rotation
+
+```jsx
+import React from 'react';
+import Markdown from '@splunk/visualizations/Markdown';
+
+export default () => (
+    <Markdown
+        options={{
+            markdown:
+                "# Heading level 1\n## Heading level 2\n### Heading level 3\n**bold text**\n*italic text*\n\n[link here](http://example.com/)\n> quote\n\nhorizontal line:\n___\n`small code section`\n```\n// large code section\nimport React from 'react';\nimport Markdown from '@splunk/visualizations/Markdown';\n```\n- first bullet item\n- second bullet item\n1. first item\n2. second item",
+            rotation: 180,
+        }}
+    />
+);
+```

package/docs-llm/markdown/options.md

@@ -0,0 +1,17 @@
+# Markdown Visualization Options
+
+**Component Reference:** Markdown or @splunk/visualizations/markdown
+
+Source: `@splunk/visualization-schemas/markdownOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string | `transparent` | Specify the background color using a Hex code such as "#FF0000". 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]+)?\\$` |
+| `customFontSize` | number | `14` | Specify the font size (in pixels) you would like to use for unformatted text when `fontSize` is set to `custom`. Header elements are calculated with the following formula: h1 = 2 × `customFontSize`, h2 = 1.5 × `customFontSize`, h3 = 1.25 × `customFontSize` |
+| `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 Platform Sans` | Specify the font family you would like to use for markdown content, such as "Comic Sans MS". Note: the font needs to be available to your end user. Allowed values: `Splunk Platform Sans`, `Splunk Data Sans`, `Splunk Platform Mono`, `Arial`, `Helvetica`, `Times New Roman`, `Comic Sans MS` |
+| `fontSize` | string | `default` | Specify the font size you would like to use for markdown content. Font sizes range from extra small (10px for unformatted text) to extra large (18px for unformatted text) with the default being 14px for unformatted text. Allowed values: `extraSmall`, `small`, `default`, `large`, `extraLarge`, `custom` |
+| `markdown` | string | — | Add text using basic markdown syntax. |
+| `rotation` | number | `0` | Specify the angle of rotation of the markdown content in degrees. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/markdown/overview.md

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

package/docs-llm/marker-gauge/examples-json.md

@@ -0,0 +1,436 @@
+# Marker Gauge Examples
+
+**Visualization Reference:** undefined
+
+## Basic Marker Gauge
+
+- **Key:** Basic
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Background Color - Light Blue
+
+- **Key:** Background Color
+
+```json
+{
+  "context": {},
+  "options": {
+    "backgroundColor": "#ADD8E6"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Gauge Ranges: negative 10 to 40 - Cyan
+
+- **Key:** Ranges Single Step
+
+```json
+{
+  "context": {},
+  "options": {
+    "gaugeRanges": [
+      {
+        "from": -10,
+        "to": 40,
+        "value": "#00FFFF"
+      }
+    ]
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Gauge Ranges: 0 to 10 - Cyan, 10 to 20 - Orange, 20 to 30 - Green, 30 to 40 - Light Blue
+
+- **Key:** Ranges Multiple Step
+
+```json
+{
+  "context": {},
+  "options": {
+    "gaugeRanges": [
+      {
+        "from": 0,
+        "to": 10,
+        "value": "#00FFFF"
+      },
+      {
+        "from": 10,
+        "to": 20,
+        "value": "#FFA500"
+      },
+      {
+        "from": 20,
+        "to": 30,
+        "value": "#008000"
+      },
+      {
+        "from": 30,
+        "to": 40,
+        "value": "#ADD8E6"
+      }
+    ]
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Label Display - Percentage
+
+- **Key:** Percentage Range
+
+```json
+{
+  "context": {},
+  "options": {
+    "labelDisplay": "percentage"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Label Display - Off
+
+- **Key:** No Labels
+
+```json
+{
+  "context": {},
+  "options": {
+    "labelDisplay": "off"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Major Tick Interval - 10
+
+- **Key:** Major Unit
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorTickInterval": 10
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Orientation - Horizontal
+
+- **Key:** Horizontal
+
+```json
+{
+  "context": {},
+  "options": {
+    "orientation": "horizontal"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Value Display - Percentage
+
+- **Key:** Percentage Value
+
+```json
+{
+  "context": {},
+  "options": {
+    "valueDisplay": "percentage"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Value Display - Off
+
+- **Key:** No Value
+
+```json
+{
+  "context": {},
+  "options": {
+    "valueDisplay": "off"
+  },
+  "dataSources": {
+    "primary": {
+      "requestParams": {
+        "offset": 0,
+        "count": 20
+      },
+      "data": {
+        "fields": [
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "20"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      }
+    }
+  }
+}
+```
+
+## Trellis
+
+- **Key:** Trellis
+
+```json
+{
+  "context": {},
+  "options": {
+    "splitByLayout": "trellis",
+    "trellisSplitBy": "component"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "component",
+            "groupby_rank": "0"
+          },
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "Database",
+            "API",
+            "Cache",
+            "Queue",
+            "Frontend",
+            "Backend"
+          ],
+          [
+            "78",
+            "65",
+            "82",
+            "91",
+            "73",
+            "88"
+          ]
+        ]
+      },
+      "meta": {}
+    }
+  }
+}
+```