@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/area/options.md

@@ -0,0 +1,97 @@
+# Area Visualization Options
+
+**Component Reference:** Area or @splunk/visualizations/area
+
+Source: `@splunk/visualization-schemas/areaOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `acceleratedRender` | boolean | `false` | Specify whether to enable canvas rendering to render large datasets more efficiently. This mode improves initial render time and interaction responsiveness for large time-series datasets. |
+| `additionalTooltipFields` | array<string> | `[]` | Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default. Items: string |
+| `annotationColor` | array<string> | — | Specify the annotation colors. For example, [“#FF0000”, “#0000FF", “#008000”]. You can use a data source or a hexadecimal code to apply the color. Items: string |
+| `annotationLabel` | array<string> | — | Specify a list of labels to use for annotations. For example, [“Sales”, “Revenue”, “Orders”]. You might use a data source to apply the labels. Items: string |
+| `annotationX` | array<string \| number> | — | Specify a data source field to apply to the event annotation on the x-axis. Items: string \| number |
+| `areaOpacity` | number | `0.75` | Specify the opacity of the area chart. Values can range from 0 (transparent) to 1 (opaque). The fill opacity is calculated by applying areaOpacity squared. |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color to use for the background. You can use a data source or hexadecimal code to apply the color. 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]+)?\\$` |
+| `dataValuesDisplay` | string | `off` | Specify the labels to display. Enter "all" to show labels for all data points, "off" to show no labels, or "minmax" to show high and low values. Allowed values: `off`, `all`, `minmax` |
+| `legendDisplay` | string | — | Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. You must select the Standard legend mode to make this change. Allowed values: `right`, `left`, `top`, `bottom`, `off` |
+| `legendLabels` | array<string> | — | Specify a list of labels to populate the legend in advance. For example, ["percent", "count"]. Items: string |
+| `legendMode` | string | `standard` | Specify visual and behavioral settings for the tooltip and legend. "seriesCompare" is useful when comparing series. Allowed values: `standard`, `seriesCompare` |
+| `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` |
+| `lineDashStyle` | string | `solid` | Specify a dash style for all overlay field lines. Allowed values: `solid`, `shortDash`, `shortDot`, `shortDashDot`, `shortDashDotDot`, `dot`, `dash`, `longDash`, `dashDot`, `longDashDot`, `longDashDotDot` |
+| `lineDashStylesByField` | object | — | Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.<br />        Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",<br />        "longDash", "dashDot", "longDashDot", "longDashDotDot". |
+| `lineWidth` | number | `2` | Specify the line width (px) for overlay field lines. |
+| `nullValueDisplay` | string | `gaps` | Specify the handling of null values for area and line charts . Allowed values: `gaps`, `zero`, `connect` |
+| `overlayFields` | array<string> \| string | — | Specify one or more fields to differentiate on the chart and display as chart overlays. Items: string |
+| `resultLimit` | number | `50000` | Specify the number of data points to render 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 to use in a series. For example, ["#FF0000", "#0000FF", "#008000"]. Items: string |
+| `seriesColorsByField` | object | — | Specify the colors to use for specific fields in a series. For example, {“count”: “#008000”, “percent”: “#FFA500”}. |
+| `showIndependentYRanges` | boolean | `false` | Specify whether split series charts have independent y-ranges. |
+| `showLines` | boolean | `true` | Specify whether to show lines in area charts. |
+| `showLineSmoothing` | boolean | `false` | Specify whether lines are straight or smoothed using curves. Only supported in accelerated render mode. |
+| `showOverlayY2Axis` | boolean | `false` | Enable a second y-axis for chart overlays. All overlay fields will map to a second y-axis. |
+| `showRoundedY2AxisLabels` | boolean | `true` | Specify whether to round second y-axis values to the nearest integer. |
+| `showSplitSeries` | boolean | `false` | Specify whether to split a multi-series chart into separate charts that are stacked from top to bottom; use one chart for each series. |
+| `showXMajorGridLines` | boolean | `false` | Specify whether to show major grid lines on the x-axis. |
+| `showY2AxisWithZero` | boolean | `false` | Specify whether to include zero in the second y-axis range. |
+| `showY2MajorGridLines` | boolean | `false` | Specify whether to show major grid lines on the second y-axis. |
+| `showY2MinorGridLines` | boolean | `false` | Specify whether to show minor grid lines on the second y-axis. |
+| `showYAxisExtendedRange` | boolean | `true` | Specify whether to extend the y-axis to include whole major tick marks. |
+| `showYAxisWithZero` | boolean | `false` | Specify whether to include zero in the y-axis range. |
+| `showYMajorGridLines` | boolean | `true` | Specify whether to show major grid lines on the y-axis. |
+| `showYMinorGridLines` | boolean | `false` | Specify whether to show minor grid lines 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` |
+| `stackMode` | string | `auto` | Specify stack mode. Allowed values: `auto`, `stacked`, `stacked100` |
+| `stepPosition` | string | `off` | Specify stepped interpolation position for area series in accelerated render mode. Valid values: "off", "before", "after". Allowed values: `off`, `before`, `after` |
+| `stepPositionsByField` | object | — | Specify stepped interpolation position for each field in accelerated render mode. For example, {"count": "before", "percent": "off"}.<br />        Valid values: "off", "before", "after". |
+| `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 data source to apply to the x-axis. Items: string \| number |
+| `xAxisLabelRotation` | number | `0` | Specify the rotation of the x-axis label in degrees. Allowed values: `-90`, `-45`, `0`, `45`, `90` |
+| `xAxisLabelVisibility` | string | `auto` | Specify whether to show labels on the x-axis. Allowed values: `auto`, `show`, `hide` |
+| `xAxisLineVisibility` | string | `hide` | Specify whether to show the x-axis line. Allowed values: `hide`, `show` |
+| `xAxisMajorTickSize` | number | `6` | Specify the size (px) of major tick marks on the x-axis. |
+| `xAxisMajorTickVisibility` | string | `auto` | Specify whether to show major tick marks on the x-axis. Allowed values: `auto`, `show`, `hide` |
+| `xAxisMaxLabelParts` | number | `3` | Specify the maximum number of time-parts for a tick label. The 3 possible parts are year, month, and time. Values can range from 1 to 3. Range: min 1, max 3 |
+| `xAxisTitleText` | string | — | Specify the title of the x-axis. |
+| `xAxisTitleVisibility` | string | `show` | Specify whether to show the title of the x-axis. Allowed values: `hide`, `show` |
+| `xField` | string | `> x \| getField()` | Specify the field to map to the x-axis. |
+| `y` | array<string \| number> | `> primary \| frameBySeriesIndexRange(1)` | Specify the data source to apply to the y-axis. Items: string \| number |
+| `y2` | array<string \| number> | — | Specify the data source to apply to the second y-axis Items: string \| number |
+| `y2AxisAbbreviation` | string | `auto` | Specify whether to abbreviate large second y-axis values with the closest International System of Units (SI) prefix. Allowed values: `auto`, `off` |
+| `y2AxisLabelVisibility` | string | `auto` | Specify whether to show labels on the second y-axis. Allowed values: `auto`, `show`, `hide` |
+| `y2AxisLineVisibility` | string | `hide` | Specify whether to show the second y-axis line. Allowed values: `hide`, `show` |
+| `y2AxisMajorTickInterval` | string \| number | `auto` | Specify the spacing unit between major tick marks along the numeric second y-axis. |
+| `y2AxisMajorTickSize` | number | `6` | Specify the size (px) of major tick marks on the second y-axis. |
+| `y2AxisMajorTickVisibility` | string | `auto` | Specify whether to show major tick marks on the second y-axis. Allowed values: `auto`, `show`, `hide` |
+| `y2AxisMax` | string \| number | `auto` | Specify the largest value for the visible second y-axis range. |
+| `y2AxisMin` | string \| number | `auto` | Specify the smallest value for the visible second y-axis range. |
+| `y2AxisMinorTickSize` | number | `6` | Specify the size (px) of minor tick marks on the second y-axis. |
+| `y2AxisMinorTickVisibility` | string | `auto` | Specify whether to show minor tick marks on the second y-axis. Allowed values: `auto`, `show`, `hide` |
+| `y2AxisScale` | string | `linear` | Specify the type of scale that applies to a numerical second y-axis. Allowed values: `linear`, `log` |
+| `y2AxisTitleText` | string | — | Specify the title of the second y-axis. |
+| `y2AxisTitleVisibility` | string | `show` | Specify whether to show the title of the second y-axis. Allowed values: `hide`, `show` |
+| `y2Fields` | array<string> \| string | `> y2 \| getField()` | Specify one or more fields to map to the second y-axis. Items: string |
+| `yAxisAbbreviation` | string | `auto` | Specify whether to abbreviate large y-axis values with the closest International System of Units (SI) prefix. Allowed values: `auto`, `off` |
+| `yAxisLabelVisibility` | string | `auto` | Specify whether to show labels on the y-axis. Allowed values: `auto`, `show`, `hide` |
+| `yAxisLineVisibility` | string | `hide` | Specify whether to show the y-axis line. Allowed values: `hide`, `show` |
+| `yAxisMajorTickInterval` | string \| number | `auto` | Specify the spacing unit between major tick marks along the numeric y-axis. |
+| `yAxisMajorTickSize` | number | `6` | Specify the size (px) of major tick marks on the y-axis. |
+| `yAxisMajorTickVisibility` | string | `auto` | Specify whether to show major tick marks on the y-axis. Allowed values: `auto`, `show`, `hide` |
+| `yAxisMax` | string \| number | `auto` | Specify the largest value for the visible y-axis range. |
+| `yAxisMin` | string \| number | `auto` | Specify the smallest value for the visible y-axis range. |
+| `yAxisMinorTickSize` | number | `6` | Specify the size (px) of minor tick marks on the y-axis. |
+| `yAxisMinorTickVisibility` | string | `auto` | Specify whether to show 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 the title of the y-axis. Allowed values: `hide`, `show` |
+| `yFields` | string | `> y \| getField()` | Specify the field to map to the y-axis. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/area/overview.md

@@ -0,0 +1,27 @@
+# Area Visualization Guide
+
+**Component Reference:** Area or @splunk/visualizations/Area
+
+## Overview
+
+An area chart shows the progression of numeric values with respect to another variable, such as time, as a shaded portion. An area chart works well for continuous data values. The benefit of an area chart is that you can display accumulated values of multiple data series, such as groups of data that overlap, or stacked area charts that layer on top of each other. You can also show stacked area charts as a percentage of a total area.
+
+## Details
+
+- **Category:** Trends
+- **Visualization Type:** splunk.area
+
+## Tips
+
+- Use a zero baseline (position the chart on the x-axis) with an area chart.
+- Highlight groups of data with color to make comparisons easier.
+- Order groups of data to emphasize their significance.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Single Series | Use an area chart to show the progression of a single series over time. | single |
+| Multi Series | Use a multi-series area chart to compare the progression of multiple series over time. Do not overlay more than two time series to prevent data from being obscured. | multi |
+| Stacked Series | Use stacked area charts to represent multiple data series. Stacked areas should only be used if all chart values are either positive or negative. Position the data series of central importance directly on the x-axis in order to best see its development over time. | stacked |
+| Stacked 100% Series | Use stacked 100% area charts to represent multiple data series combined together to show how the partial amounts add up to a whole. | stacked100 |