@splunk/visualizations 28.5.3 → 28.7.0

package/docs-llm/bubble/options.md

@@ -0,0 +1,62 @@
+# Bubble Visualization Options
+
+**Component Reference:** Bubble or @splunk/visualizations/bubble
+
+Source: `@splunk/visualization-schemas/bubbleOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the chart background by using a hexadecimal code. For example, #0000FF. |
+| `bubbleSizeMax` | number \| string | `50` | Specify, in pixels, the maximum size of each bubble. |
+| `bubbleSizeMethod` | string \| string | `area` | Specify how bubble size is measured. |
+| `bubbleSizeMin` | number \| string | `10` | Specify, in pixels, the minimum size of each bubble. |
+| `category` | array<string \| number> \| string | — | Specify a sequence of dataSource events to be plotted on the chart. |
+| `categoryField` | string \| string | `> category \| getField()` | Specify the field that should be mapped to the series categories. |
+| `legendDisplay` | string \| string | `right` | Specify the location of the legend on the panel. |
+| `legendTruncation` | string \| string | `ellipsisEnd` | Specify where to use ellipsis to replace legend labels that overflow the layout. |
+| `resultLimit` | number \| string | `50000` | Specify the number of data points rendered in a chart. |
+| `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 hexadecimal color codes for the bubble order from largest to smallest. For example, ["#FF0000", "#0000FF", "#008000"]. |
+| `seriesColorsByField` | object | — | Specify the colors to use for specific categories, or series names, derived from distinct values in the selected category field. For example, {"user1": "#008000", "user2": "#FFA500"}. |
+| `showRoundedXAxisLabels` | boolean \| string | `false` | Specify whether to round x-axis values to the nearest integer. |
+| `showXAxisExtendedRange` | boolean \| string | `true` | Specify whether the x-axis should be extended to snap to whole major tick marks. |
+| `showXAxisWithZero` | boolean \| string | `false` | Specify whether the x-axis range includes zero. |
+| `showXMinorGridLines` | boolean \| string | `false` | Specify whether minor grid lines are visible on the x-axis. |
+| `showYAxisExtendedRange` | boolean \| string | `true` | Specify whether the y-axis should be extended to snap to whole major tick marks. |
+| `showYAxisWithZero` | boolean \| string | `false` | Specify whether the y-axis range includes zero. |
+| `showYMajorGridLines` | boolean \| string | `true` | Specify whether major grid lines are visible on the y-axis. |
+| `showYMinorGridLines` | boolean \| string | `false` | Specify whether minor grid lines are visible on the y-axis. |
+| `size` | array<number> \| string | `> primary \| seriesByIndex(2)` | Specify the dataSource events that are represented by the 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. |
+| `xAxisAbbreviation` | string \| string | `off` | Specify whether to abbreviate large x-axis values with the closest International System of Units (SI) prefix. |
+| `xAxisLabelRotation` | number \| string | `0` | Specify the rotation of the x-axis labels in degrees. |
+| `xAxisLabelVisibility` | string \| string | `auto` | Specify whether to show or hide labels on the x-axis. |
+| `xAxisLineVisibility` | string \| string | `hide` | Specify whether to show the x-axis line. |
+| `xAxisMajorTickInterval` | string \| number \| string | `auto` | Specify the spacing interval between major tick marks along the x-axis. By default, the spacing value is automatically calculated based on the scale of the related axis. |
+| `xAxisMajorTickSize` | number \| string | `6` | Specify the size, in pixels, of major tick marks on the x-axis. |
+| `xAxisMajorTickVisibility` | string \| string | `auto` | Specify whether to show or hide major tick marks on the x-axis. |
+| `xAxisMax` | string \| number \| string | `auto` | Specify the maximum value for the visible x-axis range. |
+| `xAxisMin` | string \| number \| string | `auto` | Specify the minimum value for the visible x-axis range. |
+| `xAxisMinorTickSize` | number \| string | `6` | Specify the size, in pixels, of minor tick marks on the x-axis. |
+| `xAxisMinorTickVisibility` | string \| string | `auto` | Specify whether to show or hide minor tick marks on the x-axis . |
+| `xAxisScale` | string \| string | `linear` | Specify the type of scale that applies to a numerical x-axis. |
+| `xAxisTitleText` | string \| string | — | Specify the title of the x-axis. |
+| `xAxisTitleVisibility` | string \| string | `show` | Specify whether to hide the title of 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. |
+| `yAxisAbbreviation` | string \| string | `auto` | Specify whether to abbreviate large y-axis values with the closest International System of Units (SI) prefix. |
+| `yAxisLabelVisibility` | string \| string | `auto` | Specify whether to show or hide labels on the y-axis. |
+| `yAxisLineVisibility` | string \| string | `hide` | Specify whether to show the y-axis line. |
+| `yAxisMajorTickInterval` | string \| number \| string | `auto` | Specify the spacing interval between major tick marks along the y-axis. By default, the spacing value is automatically calculated based on the scale of the related axis. |
+| `yAxisMajorTickSize` | number \| string | `6` | Specify the size, in pixels, of major tick marks on the y-axis. |
+| `yAxisMajorTickVisibility` | string \| string | `auto` | Specify whether to show or hide major tick marks on the y-axis. |
+| `yAxisMax` | string \| number \| string | `auto` | Specify the maximum value for the visible y-axis range. |
+| `yAxisMin` | string \| number \| string | `auto` | Specify the minimum value for the visible y-axis range. |
+| `yAxisMinorTickSize` | number \| string | `6` | Specify the size, in pixels, of minor tick marks on the y-axis. |
+| `yAxisMinorTickVisibility` | string \| string | `auto` | Specify whether to show or hide minor tick marks on the y-axis. |
+| `yAxisScale` | string \| string | `linear` | Specify the type of scale that applies to a numerical y-axis. |
+| `yAxisTitleText` | string \| string | — | Specify the title of the y-axis. |
+| `yAxisTitleVisibility` | string \| string | `show` | Specify whether to hide the title of 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/bubble/overview.md

@@ -0,0 +1,26 @@
+# Bubble Visualization Guide
+
+**Component Reference:** Bubble or @splunk/visualizations/Bubble
+
+## Overview
+
+Bubble charts are good for finding a correlation between three or four dimensions of data. The first two dimensions are visualized as coordinates, the third as size, and the fourth as color.
+
+## Details
+
+- **Category:** Correlation
+- **Visualization Type:** splunk.bubble
+
+## Tips
+
+- Bubble charts use numerical data on the x-axis.
+- Use color to further exaggerate the difference in bubble size or to add a fourth dimension, such as categories.
+- Each additional field is used as another dimension.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Single Series | Use a basic bubble chart to visualize three dimensions. | single |
+| Multi Categories | Use a fourth dimension in a bubble chart to compare more than one category with series colors. | multi |
+| Two-Dimensional Gridlines | Consider adjusting the grid to better communicate the correlation in the data. | twoDimensionalGridlines |

package/docs-llm/choropleth-svg/examples-json.md

@@ -0,0 +1,397 @@
+# ChoroplethSVG Examples
+
+**Visualization Reference:** undefined
+
+## Loaded as a literal SVG
+
+- **Key:** Literal Svg Example
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "foo"
+          }
+        ],
+        "columns": [
+          [
+            1
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Loaded as a SVG data URI
+
+- **Key:** Data Urisvg Example
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "foo"
+          }
+        ],
+        "columns": [
+          [
+            1
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Remote SVG Example
+
+- **Key:** Remote Svg Example
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "foo"
+          }
+        ],
+        "columns": [
+          [
+            1
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Set the background color
+
+- **Key:** Background Color Example
+
+```json
+{
+  "context": {},
+  "options": {
+    "backgroundColor": "#00FFFF"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "foo"
+          }
+        ],
+        "columns": [
+          [
+            1
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Specify match color values for individual region fill colors using areaIds
+
+- **Key:** Area Id Match Color
+
+```json
+{
+  "context": {
+    "matches": [
+      {
+        "match": "ATX-270-B",
+        "value": "#FF7152"
+      },
+      {
+        "match": "N-224",
+        "value": "#FC9850"
+      },
+      {
+        "match": "VM-203",
+        "value": "#4BEBA8"
+      },
+      {
+        "match": "RF-380",
+        "value": "#F4DF7A"
+      }
+    ]
+  },
+  "options": {
+    "areaIds": "> primary|seriesByIndex(0)",
+    "areaValues": "> primary|seriesByIndex(1)",
+    "areaColors": "> areaIds|matchValue(matches)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "buildings"
+          },
+          {
+            "name": "values"
+          }
+        ],
+        "columns": [
+          [
+            "ATX-270-B",
+            "N-224",
+            "VM-203",
+            "RF-380"
+          ],
+          [
+            10000,
+            55000,
+            90000,
+            75000
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Specify range values for individual region fill colors
+
+- **Key:** Color Ranges Example
+
+```json
+{
+  "context": {
+    "areaColorThresholds": [
+      {
+        "from": 100000,
+        "value": "#4BEBA8"
+      },
+      {
+        "from": 50000,
+        "to": 100000,
+        "value": "#F4DF7A"
+      },
+      {
+        "from": 1000,
+        "to": 50000,
+        "value": "#FC9850"
+      },
+      {
+        "to": 1000,
+        "value": "#FF7152"
+      }
+    ]
+  },
+  "options": {
+    "areaIds": "> primary | seriesByIndex(0)",
+    "areaValues": "> primary | seriesByIndex(1)",
+    "areaColors": "> areaValues | rangeValue(areaColorThresholds)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "buildings"
+          },
+          {
+            "name": "values"
+          }
+        ],
+        "columns": [
+          [
+            "ATX-270-B",
+            "N-224",
+            "VM-203",
+            "RF-380"
+          ],
+          [
+            10000,
+            55000,
+            90000,
+            75000
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Specify multiple formatting configs for each individual region fill colors
+
+- **Key:** Multiple Color Ranges Example
+
+```json
+{
+  "context": {
+    "areaColorsConfig": {
+      "nameField": "buildings",
+      "valueField": "values",
+      "formatters": {
+        "ATX-270-B": {
+          "type": "matchValue",
+          "config": [
+            {
+              "match": 10000,
+              "value": "#00FF00"
+            },
+            {
+              "match": 20000,
+              "value": "#FF0000"
+            }
+          ]
+        },
+        "N-224": {
+          "type": "gradient",
+          "config": {
+            "colors": [
+              "#FF7152",
+              "#FFEBA8"
+            ]
+          }
+        },
+        "VM-203": {
+          "type": "rangeValue",
+          "config": [
+            {
+              "from": 80000,
+              "value": "#4B4BFF"
+            },
+            {
+              "to": 20000,
+              "value": "#FF0000"
+            }
+          ]
+        },
+        "RF-380": {
+          "type": "rangeValue",
+          "config": [
+            {
+              "from": 80000,
+              "value": "#4BEBA8"
+            },
+            {
+              "from": 60000,
+              "to": 80000,
+              "value": "#F4DF7A"
+            },
+            {
+              "from": 20000,
+              "to": 60000,
+              "value": "#FC9850"
+            },
+            {
+              "to": 20000,
+              "value": "#FF0000"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "options": {
+    "areaIds": "> primary | seriesByIndex(0)",
+    "areaValues": "> primary | seriesByIndex(1)",
+    "areaColors": "> primary | multiFormat(areaColorsConfig)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "buildings"
+          },
+          {
+            "name": "values"
+          }
+        ],
+        "columns": [
+          [
+            "ATX-270-B",
+            "N-224",
+            "VM-203",
+            "RF-380"
+          ],
+          [
+            10000,
+            55000,
+            90000,
+            75000
+          ]
+        ]
+      }
+    }
+  }
+}
+```
+
+## Specify linear gradient for individual region fill colors
+
+- **Key:** Color Gradient Example
+
+```json
+{
+  "context": {
+    "areaColorGradient": {
+      "colors": [
+        "#FF7152",
+        "#4BEBA8"
+      ]
+    }
+  },
+  "options": {
+    "areaIds": "> primary | seriesByIndex(0)",
+    "areaValues": "> primary | seriesByIndex(1)",
+    "areaColors": "> areaValues | gradient(areaColorGradient)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "buildings"
+          },
+          {
+            "name": "values"
+          }
+        ],
+        "columns": [
+          [
+            "ATX-270-B",
+            "N-224",
+            "VM-203",
+            "RF-380"
+          ],
+          [
+            10000,
+            55000,
+            90000,
+            75000
+          ]
+        ]
+      }
+    }
+  }
+}
+```