@splunk/visualizations 28.6.0 → 28.8.0

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

@@ -0,0 +1,43 @@
+# Single Value Icon Visualization Options
+
+**Component Reference:** Single Value Icon or @splunk/visualizations/singleValueIcon
+
+Source: `@splunk/visualization-schemas/singleValueIconOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `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-icon/overview.md

@@ -0,0 +1,5 @@
+# Single Value Icon Visualization Guide
+
+**Component Reference:** Single Value Icon or @splunk/visualizations/SingleValueIcon
+
+_Overview content not available for this visualization._