@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/scatter/options.md

@@ -0,0 +1,68 @@
+# Scatter Visualization Options
+
+**Component Reference:** Scatter or @splunk/visualizations/scatter
+
+Source: `@splunk/visualization-schemas/scatterOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | 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". 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]+)?\\$` |
+| `category` | array<string \| number> | `> primary \| seriesByIndex(2)` | Specify a sequence of dataSource events to be plotted on the chart. Items: string \| number |
+| `categoryField` | string | `> category \| getField()` | Specify the field that should be mapped to the series categories. |
+| `legendDisplay` | string | — | Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. Allowed values: `right`, `left`, `top`, `bottom`, `off` |
+| `legendTruncation` | string | `ellipsisEnd` | Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis. Allowed values: `ellipsisEnd`, `ellipsisMiddle`, `ellipsisStart`, `ellipsisOff` |
+| `markerSize` | number | `4` | Specify, in pixels, the size of each scatter marker. |
+| `resultLimit` | number | `50000` | Specify the number of data points rendered in a chart. |
+| `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 |
+| `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 | `false` | Specify whether to round x-axis values to the nearest integer. |
+| `showXAxisExtendedRange` | boolean | `true` | Specify whether the x-axis should be extended to snap to whole major tick marks. |
+| `showXAxisWithZero` | boolean | `false` | Specify whether the x-axis range includes zero. |
+| `showXMinorGridLines` | boolean | `false` | Specify whether minor grid lines are visible on the x-axis. |
+| `showYAxisExtendedRange` | boolean | `true` | Specify whether the y-axis should be extended to snap to whole major tick marks. |
+| `showYAxisWithZero` | boolean | `false` | Specify whether the y-axis range includes zero. |
+| `showYMajorGridLines` | boolean | `true` | Specify whether major grid lines are visible on the y-axis. |
+| `showYMinorGridLines` | boolean | `false` | Specify whether minor grid lines are visible on the y-axis. |
+| `splitByLayout` | string | `off` | Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category. Allowed values: `off`, `trellis` |
+| `trellisBackgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF. 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]+)?\\$` |
+| `trellisColumns` | number | `3` | Specify the number of visualizations to display in a given row of the trellis container. The remaining visualizations will wrap accordingly. If nothing is specified, it will be auto-set based on the trellisMinColumnWidth. The minimum value is 1. Range: min 1 |
+| `trellisMinColumnWidth` | number | `250` | Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1. Range: min 1 |
+| `trellisPageCount` | number | `20` | Specify the maximum number of visualizations to display in a single page in the trellis container. The remaining visualizations will paginate accordingly. The minimum value is 1. Range: min 1 |
+| `trellisRowHeight` | number | `180` | Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1. Range: min 1 |
+| `trellisSharedScale` | boolean | `true` | Specify whether all visualizations will share the same scale in the trellis container. |
+| `trellisSortBy` | string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, or name to sort alphabetically by visualization label. Allowed values: `result`, `name` |
+| `trellisSortOrder` | string | `ascending` | Specify the sort order for the individual visualizations in the trellis container. This setting applies to the sort method specified in trellisSortBy. Allowed values: `ascending`, `descending` |
+| `trellisSplitBy` | string | — | Specify the field name of the column with categories used, or “aggregations”, to split the data into individual visualizations for trellis display, if applicable. If a SPL `timechart` command is used, this may default to the SPL `by` clause field. If a SPL `chart` command is used, this may default to the first string field. |
+| `x` | array<string \| number> | `> primary \| seriesByIndex(0)` | Specify the dataSource applied to the x-axis. Items: string \| number |
+| `xAxisAbbreviation` | string | `off` | Specify whether to abbreviate large x-axis values with the closest SI prefix. Allowed values: `off`, `auto` |
+| `xAxisLabelRotation` | number | `0` | Specify the rotation of the x-axis labels in degrees. Allowed values: `-90`, `-45`, `0`, `45`, `90` |
+| `xAxisLabelVisibility` | string | `auto` | Specify whether to show or hide labels on the x-axis. Allowed values: `auto`, `show`, `hide` |
+| `xAxisLineVisibility` | string | `hide` | Specify whether to show or hide the x-axis line. Allowed values: `hide`, `show` |
+| `xAxisMajorTickInterval` | string \| number | `auto` | Specify the spacing interval at which to place major tick marks along the numeric x-axis. By default, this value is automatically calculated based on the scale of the related axis. |
+| `xAxisMajorTickSize` | number | `6` | Specify the size, in pixels, of major tick marks on the x-axis. |
+| `xAxisMajorTickVisibility` | string | `auto` | Specify whether to show or hide major tick marks on the x-axis. Allowed values: `auto`, `show`, `hide` |
+| `xAxisMax` | string \| number | `auto` | Specify the maximum number for the range of the visible x-axis. |
+| `xAxisMin` | string \| number | `auto` | Specify the minimum number for the range of the visible x-axis. |
+| `xAxisMinorTickSize` | number | `6` | Specify the size, in pixels, of minor tick marks on the x-axis. |
+| `xAxisMinorTickVisibility` | string | `auto` | Specify whether to show or hide minor tick marks on the x-axis . Allowed values: `auto`, `show`, `hide` |
+| `xAxisScale` | string | `linear` | Specify the type of scale that applies to a numerical x-axis. Allowed values: `linear`, `log` |
+| `xAxisTitleText` | string | — | Specify the title of the x-axis. |
+| `xAxisTitleVisibility` | string | `show` | Specify whether to show or hide the title of the x-axis. Allowed values: `hide`, `show` |
+| `xField` | string | `> x \| getField()` | Specify the field that should be mapped to the x-axis. |
+| `y` | array<string \| number> | `> primary \| seriesByIndex(1)` | Specify the dataSource applied to the y-axis. Items: string \| number |
+| `yAxisAbbreviation` | string | `auto` | Specify whether to abbreviate large y-axis values with the closest SI prefix. Allowed values: `off`, `auto` |
+| `yAxisLabelVisibility` | string | `auto` | Specify whether to show or hide labels on the y-axis. Allowed values: `auto`, `show`, `hide` |
+| `yAxisLineVisibility` | string | `hide` | Specify whether to show or hide the y-axis line. Allowed values: `hide`, `show` |
+| `yAxisMajorTickInterval` | string \| number | `auto` | Specify the spacing interval at which to place major tick marks along the numeric y-axis. By default, this value is automatically calculated based on the scale of the related axis. |
+| `yAxisMajorTickSize` | number | `6` | Specify the size, in pixels, of major tick marks on the y-axis. |
+| `yAxisMajorTickVisibility` | string | `auto` | Specify whether to show or hide major tick marks on the y-axis. Allowed values: `auto`, `show`, `hide` |
+| `yAxisMax` | string \| number | `auto` | Specify the maximum number for the range of the visible y-axis. |
+| `yAxisMin` | string \| number | `auto` | Specify the minimum number for the range of the visible y-axis. |
+| `yAxisMinorTickSize` | number | `6` | Specify the size, in pixels, of minor tick marks on the y-axis. |
+| `yAxisMinorTickVisibility` | string | `auto` | Specify whether to show or hide minor tick marks on the y-axis. Allowed values: `auto`, `show`, `hide` |
+| `yAxisScale` | string | `linear` | Specify the type of scale that applies to a numerical y-axis. Allowed values: `linear`, `log` |
+| `yAxisTitleText` | string | — | Specify the title of the y-axis. |
+| `yAxisTitleVisibility` | string | `show` | Specify whether to show or hide the title of the y-axis. Allowed values: `hide`, `show` |
+| `yField` | string | `> y \| getField()` | Specify the field that should be mapped to the y-axis. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/scatter/overview.md

@@ -0,0 +1,25 @@
+# Scatter Visualization Guide
+
+**Component Reference:** Scatter or @splunk/visualizations/Scatter
+
+## Overview
+
+Scatter charts plot points on a graph. They can be useful to show relationships between discrete data points. Data point distribution can show correlations across two dimensions.
+
+## Details
+
+- **Category:** Correlation
+- **Visualization Type:** splunk.scatter
+
+## Tips
+
+- Using more than seven colors in a scatter plot can confuse the user.
+- Use color to show categories or add a third dimension of data.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Single Series | Use a basic scatter chart to visualize two dimensions. | single |
+| Multi Categories | Use a third dimension in a scatter 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 |