@splunk/visualizations 28.5.3 → 28.7.0

package/docs-llm/line/options.md

@@ -0,0 +1,95 @@
+# Line Visualization Options
+
+**Component Reference:** Line or @splunk/visualizations/line
+
+Source: `@splunk/visualization-schemas/lineOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `acceleratedRender` | boolean \| string | `false` | Specify whether to enable canvas rendering to render large datasets more efficiently. This mode improves initial render time and interaction responsiveness for large time-series datasets. |
+| `additionalTooltipFields` | array<string> \| 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. |
+| `annotationColor` | array<string> \| string | — | Specify the annotation colors. You may use a dataSource to apply the color. For example, [“#FF0000”, “#0000FF", “#008000”]. |
+| `annotationLabel` | array<string> \| string | — | Specify a list of labels used for the annotations. You may use a dataSource to apply the labels. For example, [“houston, we have a problem”, “just close the jira”, “looking good now”]. |
+| `annotationX` | array<string \| number> \| string | — | Specify the dataSource field applied to the event annotation on the x-axis. |
+| `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". |
+| `dataValuesDisplay` | string \| string | `off` | Specify whether chart should display no labels, all labels, or only the min and max labels. |
+| `legendDisplay` | string \| string | — | Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. You must select the Standard legend mode to make this change. |
+| `legendLabels` | array<string> \| string | — | Specify a list of labels to pre-populate the legend. For example, ["percent", "count"]. |
+| `legendMode` | string \| string | `standard` | Specify visual and behavioral settings for the tooltip and legend. "seriesCompare" is useful when comparing series. |
+| `legendTruncation` | string \| string | `ellipsisEnd` | Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis. |
+| `lineDashStyle` | string \| string | `solid` | Specify a dash style for all line series in the chart. |
+| `lineDashStylesByField` | object | — | Specify a dash style to use for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.<br />        Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",<br />        "longDash", "dashDot", "longDashDot", "longDashDotDot". |
+| `lineWidth` | number \| string | `2` | Specify the line width (px), for all line series. |
+| `markerDisplay` | string \| string | `off` | Specify the marker display style for data points. |
+| `nullValueDisplay` | string \| string | `gaps` | Specify how area and line charts handle null values. |
+| `overlayFields` | array<string> \| string \| string | — | Specify field(s) that should be differentiated on the chart and displayed as chart overlays. |
+| `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"]. |
+| `seriesColorsByField` | object | — | Specify the colors used for specific fields in a series. For example, {“count”: “#008000”, “percent”: “#FFA500”}. |
+| `showIndependentYRanges` | boolean \| string | `false` | Specify whether split series charts have independent y-ranges. |
+| `showLineSmoothing` | boolean \| string | `false` | Specify whether lines are straight or smoothed using curves. |
+| `showOverlayY2Axis` | boolean \| string | `false` | Enable a y2-axis for chart overlays. All overlay fields will be mapped to a second y-axis. |
+| `showRoundedY2AxisLabels` | boolean \| string | `true` | Specify whether to round y2-axis values to the nearest integer. |
+| `showSplitSeries` | boolean \| string | `false` | Set to "true" to split a multi-series chart into separate charts that are stacked from top to bottom; one for each series. |
+| `showXMajorGridLines` | boolean \| string | `false` | Specify whether major grid lines are visible on the x-axis. |
+| `showY2AxisWithZero` | boolean \| string | `false` | Specify whether the y2-axis range includes zero. |
+| `showY2MajorGridLines` | boolean \| string | `false` | Specify whether major grid lines are visible on the y2-axis. |
+| `showY2MinorGridLines` | boolean \| string | `false` | Specify whether minor grid lines are visible on y2-axis. |
+| `showYAxisExtendedRange` | boolean \| string | `true` | Specify whether the y-axis should be extended to include 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. |
+| `stepPosition` | string \| string | `off` | Specify stepped interpolation position for all line series in accelerated render mode. Valid values: "off", "before", "after". |
+| `stepPositionsByField` | object | — | Specify stepped interpolation position for each field in accelerated render mode. For example, {"count": "before", "percent": "off"}.<br />        Valid values: "off", "before", "after". |
+| `trellisBackgroundColor` | string \| 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. |
+| `xAxisLabelRotation` | number \| string | `0` | Specify the rotation of the x-axis label 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. |
+| `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. |
+| `xAxisMaxLabelParts` | number \| string | `3` | Specify the maximum number of time-parts for a tick label. The 3 possible parts are year, month, and time. Values can range from 1 to 3. |
+| `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 \| frameBySeriesIndexRange(1)` | Specify the dataSource applied to the y-axis. |
+| `y2` | array<string \| number> \| string | — | Specify the dataSource applied to the y2-axis |
+| `y2AxisAbbreviation` | string \| string | `auto` | Specify whether to abbreviate large y2-axis values with the closest SI prefix. |
+| `y2AxisLabelVisibility` | string \| string | `auto` | Specify whether to show or hide labels on the y2-axis. |
+| `y2AxisLineVisibility` | string \| string | `hide` | Specify whether to show or hide the y2-axis line. |
+| `y2AxisMajorTickInterval` | string \| number \| string | `auto` | Specify the spacing unit between major tick marks along the numeric y2-axis. |
+| `y2AxisMajorTickSize` | number \| string | `6` | Specify the size, in pixels, of major tick marks on the y2-axis. |
+| `y2AxisMajorTickVisibility` | string \| string | `auto` | Specify whether to show or hide major tick marks on the y2-axis. |
+| `y2AxisMax` | string \| number \| string | `auto` | Specify the maximum number for the visible y2-axis range. |
+| `y2AxisMin` | string \| number \| string | `auto` | Specify the minimum number for the visible y2-axis range. |
+| `y2AxisMinorTickSize` | number \| string | `6` | Specify the size, in pixels, of minor tick marks on the y2-axis. |
+| `y2AxisMinorTickVisibility` | string \| string | `auto` | Specify whether to show or hide minor tick marks on the y2-axis. |
+| `y2AxisScale` | string \| string | `linear` | Specify the type of scale that applies to a numerical y2-axis. |
+| `y2AxisTitleText` | string \| string | — | Specify the title of the y2-axis. |
+| `y2AxisTitleVisibility` | string \| string | `show` | Specify whether to show or hide the title of the y2-axis. |
+| `y2Fields` | array<string> \| string \| string | `> y2 \| getField()` | Specify field(s) that should be mapped to a second 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 unit between major tick marks along the numeric y-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 visible y-axis range. |
+| `yAxisMin` | string \| number \| string | `auto` | Specify the minimum number for the visible y-axis range. |
+| `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. |
+| `yFields` | string \| string | `> y \| getField()` | Specify the field that should be mapped to the y-axis. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/line/overview.md

@@ -0,0 +1,29 @@
+# Line Visualization Guide
+
+**Component Reference:** Line or @splunk/visualizations/Line
+
+## Overview
+
+A line chart shows changes of values with respect to another variable, such as time. Line charts work well for continuous data rather than discrete values. The slope of the line makes it easy to identify trends in the data. Line charts also simplify comparisons between multiple data series. Use line charts instead of column charts when the data series consists of many data points.
+
+## Details
+
+- **Category:** Trends
+- **Visualization Type:** splunk.line
+
+## Tips
+
+- Use a line chart if there is no zero baseline.
+- Limit the number of series shown in a line chart.
+- Avoid smoothing lines between points in a line chart.
+
+## Variations
+
+| Variation | Description | Key |
+| --- | --- | --- |
+| Single Series | Use a basic line chart to show the progression of one series over time. | single |
+| Multi Series | Use a multi-series line chart to compare the progression of multiple series over time. | multi |
+| Split Series | Use smaller charts with one line each and place the charts adjacent to one other to analyze the general trends of the lines. Line charts with more than three intersecting lines tend to be confusing. | split |
+| Data Value Labeling | Add data values and markers to your line chart to highlight data points on the line. | dataValueLabelling |
+| Coloring & Styling By Field | Specify colors to be used on specific fields to convey semantic meaning used across your dashboard or application. | colorByField |
+| Outlier Detection | Outlier points highlight anomalies in a dataset. Outliers often exist above the upper bound, or below the lower bound, of the data, but can also occur inside of those values. You must include the upperBound, lowerBound, and isOutlier field values for your dataset. | outlierDetection |

package/docs-llm/link-graph/examples-json.md

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

package/docs-llm/link-graph/examples-react.md

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

package/docs-llm/link-graph/options.md

@@ -0,0 +1,26 @@
+# Link Graph Visualization Options
+
+**Component Reference:** Link Graph or @splunk/visualizations/linkGraph
+
+Source: `@splunk/visualization-schemas/linkGraphOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `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". |
+| `fieldOrder` | array<string> \| string | `> primary \| getField()` | Specify the order of fields to be displayed in the link graph from left to right when loaded. Unspecified fields will be excluded from the graph. |
+| `linkColor` | string \| string | `#6d6f76` | Specify the color used for highlighted links. Non-highlighted links will be displayed at 20% opacity. |
+| `linkWidth` | number \| string | `1` | Specify, in pixels, the stroke width of each link. |
+| `nodeColor` | string \| string | `> themes.defaultNodeColor` | Specify the color used for unhighlighted nodes. |
+| `nodeHeight` | number \| string | `21` | Specify, in pixels, the height of each node. |
+| `nodeHighlightColor` | string \| string | `#7B56DB` | Specify the color used for highlighted nodes. |
+| `nodeLabelOverflow` | string \| string | `ellipsis` | Specify the text overflow for node labels. Valid types include "break-word", "anywhere", and "ellipsis". |
+| `nodeSpacingX` | number \| string | `32` | Specify, in pixels, the horizontal spacing between each node. |
+| `nodeSpacingY` | number \| string | `18` | Specify, in pixels, the vertical spacing between each node. |
+| `nodeTextColor` | string \| string | `> nodeColor \| maxContrast(nodeTextColorMaxContrast)` | Specify the color used for unhighlighted nodes text. |
+| `nodeTextHighlightColor` | string \| string | `> nodeHighlightColor \| maxContrast(nodeHighlightTextColorMaxContrast)` | Specify the color used for highlighted nodes text. |
+| `nodeWidth` | number \| string | `180` | Specify, in pixels, the width of each node. |
+| `resultLimit` | number \| string | `50` | Specify the number of nodes rendered in each column. |
+| `showNodeCounts` | boolean \| string | `true` | Specify whether a count is shown for the number of nodes displayed in each column. The number of total nodes is also shown if there are hidden nodes. |
+| `showValueCounts` | boolean \| string | `true` | Specify whether a count is shown for the frequency of occurrence for each distinct node value. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/link-graph/overview.md

@@ -0,0 +1,16 @@
+# Link Graph Visualization Guide
+
+**Component Reference:** Link Graph or @splunk/visualizations/LinkGraph
+
+## Overview
+
+The link graph shows the connections between distinct values in various fields. It highlights relationships between entities, where nodes are the entities and lines are the links between them. Values within a specific field are displayed in a column. The aggregated node values allow users to quickly visualize highly connected data points that may be otherwise overlooked.
+
+## Details
+
+- **Category:** Flow
+- **Visualization Type:** splunk.linkgraph
+
+## Tips
+
+- Be mindful of how the fields are arranged. The fields should be arranged in a way that most accurately represents the connections between data.