@splunk/visualizations 28.7.0 → 28.8.0

package/docs-llm/scatter/options.md

@@ -6,63 +6,63 @@ Source: `@splunk/visualization-schemas/scatterOptionsSchema`
 
 | 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". |
-| `category` | array<string \| number> \| string | `> primary \| seriesByIndex(2)` | 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 | — | Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. |
-| `legendTruncation` | string \| string | `ellipsisEnd` | Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis. |
-| `markerSize` | number \| string | `4` | Specify, in pixels, the size of each scatter marker. |
-| `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 colors used for a series. For example, ["#FF0000", "#0000FF", "#008000"]. |
+| `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 \| 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. |
-| `splitByLayout` | string \| string | `off` | Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category. |
-| `trellisBackgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF. |
-| `trellisColumns` | number \| string | `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. |
-| `trellisMinColumnWidth` | number \| string | `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. |
-| `trellisPageCount` | number \| string | `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. |
-| `trellisRowHeight` | number \| string | `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. |
-| `trellisSharedScale` | boolean \| string | `true` | Specify whether all visualizations will share the same scale in the trellis container. |
-| `trellisSortBy` | string \| 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. |
-| `trellisSortOrder` | string \| string | `ascending` | Specify the sort order for the individual visualizations in the trellis container. This setting applies to the sort method specified in trellisSortBy. |
-| `trellisSplitBy` | string \| 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> \| 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 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 or hide the x-axis line. |
-| `xAxisMajorTickInterval` | string \| number \| string | `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 \| 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 number for the range of the visible x-axis. |
-| `xAxisMin` | string \| number \| string | `auto` | Specify the minimum number for the range of the visible x-axis. |
-| `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 show or 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 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 or hide the y-axis line. |
-| `yAxisMajorTickInterval` | string \| number \| string | `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 \| 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 number for the range of the visible y-axis. |
-| `yAxisMin` | string \| number \| string | `auto` | Specify the minimum number for the range of the visible y-axis. |
-| `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 show or hide the title of the y-axis. |
-| `yField` | string \| string | `> y \| getField()` | Specify the field that should be mapped to the y-axis. |
+| `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/single-value/options.md

@@ -6,44 +6,44 @@ Source: `@splunk/visualization-schemas/singleValueOptionsSchema`
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `align` | string \| string | `center` | Specify how to align the center content. |
-| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may 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". |
-| `majorColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the major value.  You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `majorFontSize` | number \| string | — | Specify the font size (px) for the major value. By default the major value font size is calculated dynamically based on the available space. |
-| `majorValue` | string \| number \| string | `> sparklineValues\|lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
-| `majorValueDisplay` | string \| number \| string | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
-| `majorValueField` | string \| string | `> majorValue \| getField()` | The field name of major value. |
-| `numberPrecision` | number \| string | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. |
-| `shouldAbbreviateMajorValue` | boolean \| string | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldAbbreviateTrendValue` | boolean \| string | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldSparklineAcceptNullData` | boolean \| string | `true` | Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0. |
-| `shouldUseThousandSeparators` | boolean \| string | `true` | Specify whether numeric values use commas as thousandths separators. |
-| `showSparklineAreaGraph` | boolean \| string | `false` | Specify whether to show the sparkline as an area graph rather than a line. |
-| `showSparklineTooltip` | boolean \| string | `false` | Show a tooltip to display values on the sparkline. |
-| `sparklineAreaColor` | string \| string | `> sparklineStrokeColor` | Specify the color for the sparkline area fill. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The graph area will have an opacity of 20% and will blend with the background color. |
-| `sparklineDisplay` | string \| string | `below` | Specify how to display a sparkline. |
-| `sparklineHighlightDots` | number \| string | `0` | Specify the number of markers, or dots, to display at the top of a sparkline area graph. |
-| `sparklineHighlightSegments` | number \| string | `0` | Specify the number of segments to be highlighted at the top of a sparkline area graph. |
-| `sparklineNullValueDisplay` | string \| string | `gaps` | Specify the handling of null values for sparkline. "gaps" shows breaks in the line (default), "zero" treats null as 0, "connect" connects points across nulls. |
-| `sparklineStrokeColor` | string \| string | `> themes.defaultSparklineStrokeColor` | Specify the color for the sparkline stroke. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `sparklineValues` | array<string \| number> \| string | `> primary\|seriesByPrioritizedTypes("number", "string", "time")` | List of numerical values to display on a sparkline. If the values are string type, the sparkline will not be shown. |
-| `splitByLayout` | string \| string | `off` | Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category. |
-| `trellisBackgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF. |
-| `trellisColumns` | number \| string | — | 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. |
-| `trellisMinColumnWidth` | number \| string | `100` | 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. |
-| `trellisPageCount` | number \| string | `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. |
-| `trellisRowHeight` | number \| string | `70` | 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. |
-| `trellisSortBy` | string \| string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. |
-| `trellisSortOrder` | string \| string | `ascending` | Specify the sort order for the individual visualizations in the trellis container. This setting applies to the sort method specified in trellisSortBy. |
-| `trellisSplitBy` | string \| 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. |
-| `trendColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `trendDisplay` | string \| string | `absolute` | Specify how to display the trend value. |
-| `trendFontSize` | number \| string | — | Specify the font size (px) for the trend value. By default the trend value font size is calculated dynamically based on the available space. |
-| `trendValue` | number \| string | `> sparklineValues\|delta(-2)` | The trend value to display in the visualization. |
-| `underLabel` | string \| string | — | Specify the text that appears below the major value. |
-| `underLabelColor` | string \| string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value color. |
-| `underLabelFontSize` | number \| string | `12` | Specify the font size (px) for the under label text. |
-| `unit` | string \| string | — | Specify text to show next to the major value. |
-| `unitPosition` | string \| string | `after` | Specify whether the unit text should appear before or after the major value. |
+| `align` | string | `center` | Specify how to align the center content. Allowed values: `left`, `center`, `right` |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may 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]+)?\\$` |
+| `majorColor` | string | `> themes.defaultFontColor` | Specify the color for the major value.  You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `majorFontSize` | number | — | Specify the font size (px) for the major value. By default the major value font size is calculated dynamically based on the available space. |
+| `majorValue` | string \| number | `> sparklineValues\|lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
+| `majorValueDisplay` | string \| number | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
+| `majorValueField` | string | `> majorValue \| getField()` | The field name of major value. |
+| `numberPrecision` | number | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. Range: min 0, max 20 |
+| `shouldAbbreviateMajorValue` | boolean | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldAbbreviateTrendValue` | boolean | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldSparklineAcceptNullData` | boolean | `true` | Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0. |
+| `shouldUseThousandSeparators` | boolean | `true` | Specify whether numeric values use commas as thousandths separators. |
+| `showSparklineAreaGraph` | boolean | `false` | Specify whether to show the sparkline as an area graph rather than a line. |
+| `showSparklineTooltip` | boolean | `false` | Show a tooltip to display values on the sparkline. |
+| `sparklineAreaColor` | string | `> sparklineStrokeColor` | Specify the color for the sparkline area fill. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The graph area will have an opacity of 20% and will blend with the background 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]+)?\\$` |
+| `sparklineDisplay` | string | `below` | Specify how to display a sparkline. Allowed values: `before`, `after`, `below`, `off` |
+| `sparklineHighlightDots` | number | `0` | Specify the number of markers, or dots, to display at the top of a sparkline area graph. |
+| `sparklineHighlightSegments` | number | `0` | Specify the number of segments to be highlighted at the top of a sparkline area graph. |
+| `sparklineNullValueDisplay` | string | `gaps` | Specify the handling of null values for sparkline. "gaps" shows breaks in the line (default), "zero" treats null as 0, "connect" connects points across nulls. Allowed values: `gaps`, `zero`, `connect` |
+| `sparklineStrokeColor` | string | `> themes.defaultSparklineStrokeColor` | Specify the color for the sparkline stroke. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `sparklineValues` | array<string \| number> | `> primary\|seriesByPrioritizedTypes("number", "string", "time")` | List of numerical values to display on a sparkline. If the values are string type, the sparkline will not be shown. Items: string \| number |
+| `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 | — | 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 | `100` | 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 | `70` | 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 |
+| `trellisSortBy` | string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. Allowed values: `result`, `name`, `value`, `trend` |
+| `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. |
+| `trendColor` | string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `trendDisplay` | string | `absolute` | Specify how to display the trend value. Allowed values: `percent`, `absolute`, `off` |
+| `trendFontSize` | number | — | Specify the font size (px) for the trend value. By default the trend value font size is calculated dynamically based on the available space. |
+| `trendValue` | number | `> sparklineValues\|delta(-2)` | The trend value to display in the visualization. |
+| `underLabel` | string | — | Specify the text that appears below the major value. |
+| `underLabelColor` | string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value 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]+)?\\$` |
+| `underLabelFontSize` | number | `12` | Specify the font size (px) for the under label text. |
+| `unit` | string | — | Specify text to show next to the major value. |
+| `unitPosition` | string | `after` | Specify whether the unit text should appear before or after the major value. Allowed values: `before`, `after` |
 
 _Auto-generated; do not edit by hand._

package/docs-llm/single-value-icon/options.md

@@ -6,38 +6,38 @@ Source: `@splunk/visualization-schemas/singleValueIconOptionsSchema`
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `align` | string \| string | `center` | Specify how to align the center content. |
-| `backgroundColor` | string \| string | `transparent` | Specify the color for the background. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. |
-| `icon` | string \| string | `default` | Specify an icon. |
-| `iconColor` | string \| string | `null` | Specify the color for the icon. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `iconOpacity` | number \| string | `1` | Specify the opacity for the icon using a number between 0 and 1 (inclusive). |
-| `iconPosition` | string \| string | `before` | Specify where to display the icon in relation to the major value. |
-| `majorColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the major value.  You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `majorFontSize` | number \| string | — | Specify the font size (px) for the major value. By default the major value font size is calculated dynamically based on the available space. |
-| `majorValue` | string \| number \| string | `> primary\|seriesByPrioritizedTypes("number", "string", "time")\|lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
-| `majorValueDisplay` | string \| number \| string | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
-| `majorValueField` | string \| string | `> majorValue \| getField()` | The field name of major value. |
-| `numberPrecision` | number \| string | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. |
-| `shouldAbbreviateMajorValue` | boolean \| string | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldAbbreviateTrendValue` | boolean \| string | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldUseThousandSeparators` | boolean \| string | `true` | Specify whether numeric values use commas as thousandths separators. |
-| `showValue` | boolean \| string | `true` | Specify whether to enable or disable the value and trend indicator displays. |
-| `splitByLayout` | string \| string | `off` | Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category. |
-| `trellisBackgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF. |
-| `trellisColumns` | number \| string | — | 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. |
-| `trellisMinColumnWidth` | number \| string | `100` | 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. |
-| `trellisPageCount` | number \| string | `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. |
-| `trellisRowHeight` | number \| string | `70` | 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. |
-| `trellisSortBy` | string \| string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. |
-| `trellisSortOrder` | string \| string | `ascending` | Specify the sort order for the individual visualizations in the trellis container. This setting applies to the sort method specified in trellisSortBy. |
-| `trellisSplitBy` | string \| 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. |
-| `trendColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `trendDisplay` | string \| string | `absolute` | Specify whether the trend value is displayed as a percentage or an absolute count. |
-| `trendFontSize` | number \| string | — | Specify the font size (px) for the trend value. By default the trend value font size is calculated dynamically based on the available space. |
-| `trendValue` | number \| string | `> primary\|seriesByPrioritizedTypes("number", "string", "time")\|delta(-2)` | The trend value to display in the visualization. |
-| `underLabel` | string \| string | — | Specify the text that appears below the major value. |
-| `underLabelColor` | string \| string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value color. |
-| `unit` | string \| string | — | Specify text to show next to the major value. |
-| `unitPosition` | string \| string | `after` | Specify whether the unit text should appear before or after the major value. |
+| `align` | string | `center` | Specify how to align the center content. Allowed values: `left`, `center`, `right` |
+| `backgroundColor` | string | `transparent` | Specify the color for the background. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. 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]+)?\\$` |
+| `icon` | string | `default` | Specify an icon. |
+| `iconColor` | string | `null` | Specify the color for the icon. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `iconOpacity` | number | `1` | Specify the opacity for the icon using a number between 0 and 1 (inclusive). |
+| `iconPosition` | string | `before` | Specify where to display the icon in relation to the major value. |
+| `majorColor` | string | `> themes.defaultFontColor` | Specify the color for the major value.  You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `majorFontSize` | number | — | Specify the font size (px) for the major value. By default the major value font size is calculated dynamically based on the available space. |
+| `majorValue` | string \| number | `> primary\|seriesByPrioritizedTypes("number", "string", "time")\|lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
+| `majorValueDisplay` | string \| number | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
+| `majorValueField` | string | `> majorValue \| getField()` | The field name of major value. |
+| `numberPrecision` | number | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. Range: min 0, max 20 |
+| `shouldAbbreviateMajorValue` | boolean | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldAbbreviateTrendValue` | boolean | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldUseThousandSeparators` | boolean | `true` | Specify whether numeric values use commas as thousandths separators. |
+| `showValue` | boolean | `true` | Specify whether to enable or disable the value and trend indicator displays. |
+| `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 | — | 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 | `100` | 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 | `70` | 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 |
+| `trellisSortBy` | string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. Allowed values: `result`, `name`, `value`, `trend` |
+| `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. |
+| `trendColor` | string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `trendDisplay` | string | `absolute` | Specify whether the trend value is displayed as a percentage or an absolute count. Allowed values: `off`, `percent`, `absolute` |
+| `trendFontSize` | number | — | Specify the font size (px) for the trend value. By default the trend value font size is calculated dynamically based on the available space. |
+| `trendValue` | number | `> primary\|seriesByPrioritizedTypes("number", "string", "time")\|delta(-2)` | The trend value to display in the visualization. |
+| `underLabel` | string | — | Specify the text that appears below the major value. |
+| `underLabelColor` | string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value 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]+)?\\$` |
+| `unit` | string | — | Specify text to show next to the major value. |
+| `unitPosition` | string | `after` | Specify whether the unit text should appear before or after the major value. Allowed values: `before`, `after` |
 
 _Auto-generated; do not edit by hand._

package/docs-llm/single-value-radial/options.md

@@ -6,36 +6,36 @@ Source: `@splunk/visualization-schemas/singleValueRadialOptionsSchema`
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color for the background. The hex value format should be “#ffffff”. The default for enterprise light is "#ffffff". The default for enterprise dark is "#000000". The default for prisma dark is "#0b0c0e". |
-| `gaugeRanges` | array<object> \| string | `> majorColorEditorConfig` | Specify the overall range of the gauge as a series of continuous, color-coded subranges. For example, [{"to": 20, "value": "#4BEBA8"}, {"from": 20, "to": 50, "value": "#D41F1F"}, {"from": 50, "value": "#F4DF7A"}]. Must be unbounded, open ranges. Ranges are bound by a separate minValue/maxValue option. Only configured if isGaugeOn is true. |
-| `isGaugeOn` | boolean \| string | `false` | Specify if gauge is on. |
-| `majorColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the major value. You may use a dataSource to apply the color. The hex value format should be “#ffffff”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `majorValue` | string \| number \| string | `> primary \| seriesByPrioritizedTypes("number", "string", "time") \| lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
-| `majorValueDisplay` | string \| number \| string | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
-| `majorValueField` | string \| string | `> majorValue \| getField()` | Specify the field that should be mapped to the major value. |
-| `maxValue` | number \| string | `100` | Specify the value the radial fills up to. |
-| `minValue` | number \| string | `0` | Specify the min value of the radial. |
-| `numberPrecision` | number \| string | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. |
-| `radialBackgroundColor` | string \| string | `> themes.defaultRadialBackgroundColor` | Specify the color for the radial background. The hex value format should be “#ffffff”. The default for enterprise light is "rgba(0, 0, 0, 0.1)". The default for enterprise dark is "rgba(255, 255, 255, 0.15)". The default for prisma dark is "rgba(255, 255, 255, 0.15)". |
-| `radialStrokeColor` | string \| string | `> majorColor` | Specify the color for the radial. You may use a dataSource to apply the color. The hex value format should be “#ffffff”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `shouldAbbreviateMajorValue` | boolean \| string | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldAbbreviateTrendValue` | boolean \| string | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
-| `shouldUseThousandSeparators` | boolean \| string | `true` | Specify whether numeric values use commas as thousandths separators. |
-| `splitByLayout` | string \| string | `off` | Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category. |
-| `trellisBackgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF. |
-| `trellisColumns` | number \| string | — | 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. |
-| `trellisMinColumnWidth` | number \| string | `120` | 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. |
-| `trellisPageCount` | number \| string | `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. |
-| `trellisRowHeight` | number \| string | `100` | 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. |
-| `trellisSortBy` | string \| string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. |
-| `trellisSortOrder` | string \| string | `ascending` | Specify the sort order for the individual visualizations in the trellis container. This setting applies to the sort method specified in trellisSortBy. |
-| `trellisSplitBy` | string \| 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. |
-| `trendColor` | string \| string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". |
-| `trendDisplay` | string \| string | `absolute` | Specify how to display the trend value. |
-| `trendValue` | number \| string | `> primary \| seriesByPrioritizedTypes("number", "string", "time") \| delta(-2)` | Specify the dataSource applied to the trend value. |
-| `underLabel` | string \| string | — | Specify the text that appears below the major value. |
-| `underLabelColor` | string \| string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value color. |
-| `unit` | string \| string | — | Specify text to show next to the major value. |
-| `unitPosition` | string \| string | `after` | Specify whether the unit text should appear before or after the major value. |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. The hex value format should be “#ffffff”. 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]+)?\\$` |
+| `gaugeRanges` | array<object> | `> majorColorEditorConfig` | Specify the overall range of the gauge as a series of continuous, color-coded subranges. For example, [{"to": 20, "value": "#4BEBA8"}, {"from": 20, "to": 50, "value": "#D41F1F"}, {"from": 50, "value": "#F4DF7A"}]. Must be unbounded, open ranges. Ranges are bound by a separate minValue/maxValue option. Only configured if isGaugeOn is true. Items: object |
+| `isGaugeOn` | boolean | `false` | Specify if gauge is on. |
+| `majorColor` | string | `> themes.defaultFontColor` | Specify the color for the major value. You may use a dataSource to apply the color. The hex value format should be “#ffffff”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `majorValue` | string \| number | `> primary \| seriesByPrioritizedTypes("number", "string", "time") \| lastPoint()` | The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified. |
+| `majorValueDisplay` | string \| number | `> majorValue` | The formatted version of majorValue displayed in the visualization. |
+| `majorValueField` | string | `> majorValue \| getField()` | Specify the field that should be mapped to the major value. |
+| `maxValue` | number | `100` | Specify the value the radial fills up to. |
+| `minValue` | number | `0` | Specify the min value of the radial. |
+| `numberPrecision` | number | `0` | Specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. Values can range from 0 to 20. Range: min 0, max 20 |
+| `radialBackgroundColor` | string | `> themes.defaultRadialBackgroundColor` | Specify the color for the radial background. The hex value format should be “#ffffff”. The default for enterprise light is "rgba(0, 0, 0, 0.1)". The default for enterprise dark is "rgba(255, 255, 255, 0.15)". The default for prisma dark is "rgba(255, 255, 255, 0.15)". 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]+)?\\$` |
+| `radialStrokeColor` | string | `> majorColor` | Specify the color for the radial. You may use a dataSource to apply the color. The hex value format should be “#ffffff”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `shouldAbbreviateMajorValue` | boolean | `false` | Specify whether to abbreviate the major value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldAbbreviateTrendValue` | boolean | `false` | Specify whether to abbreviate the trend value to 2 decimal points. A magnitude unit will be displayed. |
+| `shouldUseThousandSeparators` | boolean | `true` | Specify whether numeric values use commas as thousandths separators. |
+| `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 | — | 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 | `120` | 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 | `100` | 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 |
+| `trellisSortBy` | string | `result` | Specify the sort method for the individual visualizations in the trellis container. Use result to sort by search result order, name to sort alphabetically by visualization label, value to sort by the major value, or trend to sort by the trend value. Allowed values: `result`, `name`, `value`, `trend` |
+| `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. |
+| `trendColor` | string | `> themes.defaultFontColor` | Specify the color for the trend value. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)". 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]+)?\\$` |
+| `trendDisplay` | string | `absolute` | Specify how to display the trend value. Allowed values: `percent`, `absolute`, `off` |
+| `trendValue` | number | `> primary \| seriesByPrioritizedTypes("number", "string", "time") \| delta(-2)` | Specify the dataSource applied to the trend value. |
+| `underLabel` | string | — | Specify the text that appears below the major value. |
+| `underLabelColor` | string | `> majorColor` | Specify the color for the under label text. You may use a dataSource to apply the color. The hex value format should be “#FFFFFF”. By default it follows the major value 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]+)?\\$` |
+| `unit` | string | — | Specify text to show next to the major value. |
+| `unitPosition` | string | `after` | Specify whether the unit text should appear before or after the major value. Allowed values: `before`, `after` |
 
 _Auto-generated; do not edit by hand._

package/docs-llm/table/options.md

@@ -6,20 +6,21 @@ Source: `@splunk/visualization-schemas/tableOptionsSchema`
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color for the background. You might use a data source 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". |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. You might use a data source 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]+)?\\$` |
 | `columnFormat` | object | — | Lets you format an individual column in a table. Specify a column in a table as a field, followed by a property. For more information, see the Column Format Align - Left example on the Examples page. |
-| `count` | number \| string | `10` | Specify the maximum number of rows to display. |
-| `font` | string \| string | `proportional` | Specify the font style to use for table content. |
-| `fontSize` | string \| string | `default` | Specify the font size to use for table content. Font sizes range from extra small (10px) to large (16px) with the default being 14px. |
-| `headers` | array<string> \| string | `> table \| getField()` | Specify an array of headers to display on the table. Though these can be statically listed, it's best to use the dynamic default, as it will return the fields of your search. |
-| `headerVisibility` | string \| string | `inline` | Specify how to display the table header row. |
-| `paginateDataSourceKey` | string \| string | `primary` | Specify the data source key for pagination and sorting. |
-| `showColumnAsExpandedJson` | string \| array<string> \| string | — | Specify row expansion content as stringified JSON. Provide either a DSL expression that resolves to an array of stringified JSON values, or a static array of stringified JSON values. Each item is rendered in the matching expanded row with JSONTree. |
-| `showFooterPercentages` | boolean \| string | `false` | Specify whether to show a row at the bottom of the table that displays percentage values for applicable columns. |
-| `showFooterTotals` | boolean \| string | `false` | Specify whether to show a row at the bottom of the table that displays total values for applicable columns. |
-| `showInternalFields` | boolean \| string | `true` | Specify whether to show internal fields that start with an underscore. The _time field will still be shown if false. |
-| `showRowNumbers` | boolean \| string | `false` | Show row numbers in the first column. |
-| `table` | array<array<string \| number \| array<string \| number>>> \| string | `> primary` | Two dimensional array of data to be displayed in the table. |
+| `count` | number | `10` | Specify the maximum number of rows to display. |
+| `dynamicHeight` | boolean | `false` | In view mode, allow the table to grow or shrink to fit the data. Ignored in edit mode. |
+| `font` | string | `proportional` | Specify the font style to use for table content. Allowed values: `proportional`, `monospace` |
+| `fontSize` | string | `default` | Specify the font size to use for table content. Font sizes range from extra small (10px) to large (16px) with the default being 14px. Allowed values: `extraSmall`, `small`, `default`, `large` |
+| `headers` | array<string> | `> table \| getField()` | Specify an array of headers to display on the table. Though these can be statically listed, it's best to use the dynamic default, as it will return the fields of your search. Items: string |
+| `headerVisibility` | string | `inline` | Specify how to display the table header row. Allowed values: `none`, `fixed`, `inline` |
+| `paginateDataSourceKey` | string | `primary` | Specify the data source key for pagination and sorting. |
+| `showColumnAsExpandedJson` | string \| array<string> | — | Specify row expansion content as stringified JSON. Provide either a DSL expression that resolves to an array of stringified JSON values, or a static array of stringified JSON values. Each item is rendered in the matching expanded row with JSONTree. Items: string |
+| `showFooterPercentages` | boolean | `false` | Specify whether to show a row at the bottom of the table that displays percentage values for applicable columns. |
+| `showFooterTotals` | boolean | `false` | Specify whether to show a row at the bottom of the table that displays total values for applicable columns. |
+| `showInternalFields` | boolean | `true` | Specify whether to show internal fields that start with an underscore. The _time field will still be shown if false. |
+| `showRowNumbers` | boolean | `false` | Show row numbers in the first column. |
+| `table` | array<array<string \| number \| array<string \| number>>> | `> primary` | Two dimensional array of data to be displayed in the table. Items: array<string \| number \| array<string \| number>> |
 | `tableFormat` | object | — | Lets you set global options for a table. |
 
 _Auto-generated; do not edit by hand._

package/docs-llm/timeline/options.md

@@ -6,22 +6,22 @@ Source: `@splunk/visualization-schemas/timelineOptionsSchema`
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `additionalTooltipFields` | array<string> \| 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. |
-| `backgroundColor` | string \| string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may use a data source 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". |
-| `category` | array<string \| number> \| string | `> primary\| seriesByName("category")` | Specify the data source to apply series categories. This will color events in distinct categories. |
-| `categoryField` | string \| string | `> category \| getField()` | Specify the field that should be mapped to the y-axis. |
-| `dataColors` | string \| array<string> \| string | — | Specify the colors to use for events. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, “> primary \| seriesByName("count") \| rangeValue(lowToHigh)”. By default, the dataColors option is not defined and seriesColors is used for categorical coloring. |
-| `duration` | array<string \| number> \| string | `> primary \| seriesByPrioritizedTypes("number", "time")` | Specify the data source to apply duration to events. This will display events over a length of time as a bar rather than a circle. |
-| `durationField` | string \| string | `> duration \| getField()` | Specify the field that should be mapped to the x-axis. |
-| `durationUnit` | string \| string | `milliseconds` | Specify the unit of the values in the duration data source used to apply duration to events. |
-| `legendDisplay` | string \| string | `off` | Specify the location of the legend on the panel. |
-| `legendTruncation` | string \| string | `ellipsisEnd` | Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis. |
-| `resultLimit` | number \| string | `10000` | Specify the maximum number of events to render on the timeline. Adjust the value to improve performance. |
-| `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"]. |
-| `x` | array<string \| number> \| string | `> primary \| seriesByType("time")` | Specify the data source 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 \| seriesByPrioritizedTypes("string", "number")` | Specify the data source applied to the y-axis. |
-| `yAxisLabelWidth` | number \| string | `100` | Specify the width, in pixels, for y-axis labels. |
-| `yField` | string \| string | `> y \| getField()` | Specify the field that should be mapped to the y-axis. |
+| `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 |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may use a data source 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]+)?\\$` |
+| `category` | array<string \| number> | `> primary\| seriesByName("category")` | Specify the data source to apply series categories. This will color events in distinct categories. Items: string \| number |
+| `categoryField` | string | `> category \| getField()` | Specify the field that should be mapped to the y-axis. |
+| `dataColors` | string \| array<string> | — | Specify the colors to use for events. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, “> primary \| seriesByName("count") \| rangeValue(lowToHigh)”. By default, the dataColors option is not defined and seriesColors is used for categorical coloring. Items: string |
+| `duration` | array<string \| number> | `> primary \| seriesByPrioritizedTypes("number", "time")` | Specify the data source to apply duration to events. This will display events over a length of time as a bar rather than a circle. Items: string \| number |
+| `durationField` | string | `> duration \| getField()` | Specify the field that should be mapped to the x-axis. |
+| `durationUnit` | string | `milliseconds` | Specify the unit of the values in the duration data source used to apply duration to events. Allowed values: `milliseconds`, `seconds`, `minutes`, `hours` |
+| `legendDisplay` | string | `off` | Specify the location of the legend on the panel. Allowed values: `right`, `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` |
+| `resultLimit` | number | `10000` | Specify the maximum number of events to render on the timeline. Adjust the value to improve performance. |
+| `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 |
+| `x` | array<string \| number> | `> primary \| seriesByType("time")` | Specify the data source applied to the x-axis. Items: string \| number |
+| `xField` | string | `> x \| getField()` | Specify the field that should be mapped to the x-axis. |
+| `y` | array<string \| number> | `> primary \| seriesByPrioritizedTypes("string", "number")` | Specify the data source applied to the y-axis. Items: string \| number |
+| `yAxisLabelWidth` | number | `100` | Specify the width, in pixels, for y-axis labels. |
+| `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/treemap/examples-json.md

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

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

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

package/docs-llm/treemap/options.md

@@ -0,0 +1,26 @@
+# Treemap Visualization Options
+
+**Component Reference:** Treemap or @splunk/visualizations/treemap
+
+Source: `@splunk/visualization-schemas/treemapOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `additionalTooltipFields` | array<string> | `[]` | Specify additional fields to display in the tooltip for each node. Items: string |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color for the background. You may 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]+)?\\$` |
+| `dataColors` | string \| array<string> | — | Specify the colors to use for treemap nodes. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, "> primary \| seriesByName("population") \| rangeValue(colorRangeConfig)". By default, the dataColors option is not defined and seriesColors is used for categorical coloring. Items: string |
+| `dataColorValues` | array<number \| string> | `> primary \| seriesByType('number')` | Specify the array of values used for dynamic treemap coloring. Items: number \| string |
+| `legendDisplay` | string | `off` | Specify the location of the legend on the panel. Allowed values: `bottom`, `off` |
+| `nodeIds` | array<string> | `> primary \| seriesByType("string")` | Specify the array of node IDs in the hierarchy. Items: string |
+| `nodeLabels` | array<string> | `> primary \| seriesByType("string")` | Specify the array of display labels for treemap nodes. Items: string |
+| `parent` | array<string> | — | Specify the array of parent node names in the hierarchy. Items: string |
+| `resultLimit` | number | `10000` | Specify the maximum number of treemap data points rendered. |
+| `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 root categories. For example, ["#FF0000", "#0000FF", "#008000"]. Items: string |
+| `showChildValues` | boolean | `true` | Specify whether to display values for child and leaf nodes. |
+| `showParentValues` | boolean | `true` | Specify whether to display the values of each parent node. This only applies when showSubdivisions is true. |
+| `showSubdivisions` | boolean | `true` | Specify whether to display nested subdivisions inside parent nodes. |
+| `showTooltip` | boolean | `false` | Specify whether to display the tooltip when hovering over nodes. |
+| `sumFromLeafNodes` | boolean | `false` | Specify whether parent values are calculated from leaf children instead of using provided parent values. |
+| `value` | array<number> | `> primary \| seriesByType('number')` | Specify the numeric field used to determine the size (area) of each treemap node. Items: number |
+
+_Auto-generated; do not edit by hand._