@splunk/visualizations 28.6.0 → 28.7.0

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

@@ -0,0 +1,49 @@
+# Single Value Visualization Options
+
+**Component Reference:** Single Value or @splunk/visualizations/singleValue
+
+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. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/single-value/overview.md

@@ -0,0 +1,23 @@
+# Single Value Visualization Guide
+
+**Component Reference:** Single Value or @splunk/visualizations/SingleValue
+
+## Overview
+
+A single value is used to show a discrete metric and its corresponding context. Its corresponding context can include the recent change in value (trend) and change over a period of time (sparkline).
+
+## Details
+
+- **Visualization Type:** splunk.singlevalue
+
+## Tips
+
+- Use a single value to showcase important individual metrics on your dashboard.
+- Use coloring options to further communicate the meaning of the value.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Coloring By Range Value | Dynamically color your single value powered by the trend value using sequential colors to communicate overall status. You may also color the sparkline using the same context. | colorByRangeValue |
+| Coloring By Match Value | Use color to highlight a specific value or status when the data matches that exact value. | colorByMatchValue |