@splunk/visualizations 28.6.0 → 28.7.0

package/docs-llm/dsl/selectors/series-by-name-examples-json.md

@@ -0,0 +1,49 @@
+# seriesByName Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "sparklineValues": "> primary | seriesByName(\"count\")"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "_time"
+          },
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "2018-08-19T00:00:00.000+00:00",
+            "2018-08-20T00:00:00.000+00:00",
+            "2018-08-21T00:00:00.000+00:00",
+            "2018-08-22T00:00:00.000+00:00",
+            "2018-08-23T00:00:00.000+00:00",
+            "2018-08-24T00:00:00.000+00:00",
+            "2018-08-25T00:00:00.000+00:00",
+            "2018-08-26T00:00:00.000+00:00"
+          ],
+          [
+            "1",
+            "62",
+            "103",
+            "308",
+            "587",
+            "876",
+            "930",
+            "1320"
+          ]
+        ]
+      },
+      "meta": {}
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/series-by-name-examples-react.md

@@ -0,0 +1,39 @@
+# seriesByName Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        sparklineValues: '> primary | seriesByName("count")',
+    }}
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: '_time',
+                    },
+                    {
+                        name: 'count',
+                    },
+                ],
+                columns: [
+                    [
+                        '2018-08-19T00:00:00.000+00:00',
+                        '2018-08-20T00:00:00.000+00:00',
+                        '2018-08-21T00:00:00.000+00:00',
+                        '2018-08-22T00:00:00.000+00:00',
+                        '2018-08-23T00:00:00.000+00:00',
+                        '2018-08-24T00:00:00.000+00:00',
+                        '2018-08-25T00:00:00.000+00:00',
+                        '2018-08-26T00:00:00.000+00:00',
+                    ],
+                    ['1', '62', '103', '308', '587', '876', '930', '1320'],
+                ],
+            },
+            meta: {},
+        },
+    }}
+/>
+```

package/docs-llm/dsl/selectors/series-by-name.md

@@ -0,0 +1,8 @@
+# seriesByName
+
+Select a DataSeries by specifying the name of the DataSeries you would like to return.
+@public
+@param {string} field
+@returns {DataSeries<DataType>}
+
+The following code sample shows how to use seriesByName to display the count series in a data source as a single value.

package/docs-llm/dsl/selectors/series-by-prioritized-types-examples-json.md

@@ -0,0 +1,47 @@
+# seriesByPrioritizedTypes Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {},
+  "dataSources": {
+    "primary": {
+      "data": {
+        "columns": [
+          [
+            "2018-08-19T00:00:00.000+00:00",
+            "2018-08-20T00:00:00.000+00:00",
+            "2018-08-21T00:00:00.000+00:00",
+            "2018-08-22T00:00:00.000+00:00",
+            "2018-08-23T00:00:00.000+00:00",
+            "2018-08-24T00:00:00.000+00:00",
+            "2018-08-25T00:00:00.000+00:00",
+            "2018-08-26T00:00:00.000+00:00"
+          ],
+          [
+            "INFO",
+            "ERROR",
+            "WARN",
+            "INFO",
+            "ERROR",
+            "WARN",
+            "INFO",
+            "WARN"
+          ]
+        ],
+        "fields": [
+          {
+            "name": "_time"
+          },
+          {
+            "name": "status"
+          }
+        ]
+      },
+      "meta": {}
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/series-by-prioritized-types-examples-react.md

@@ -0,0 +1,39 @@
+# seriesByPrioritizedTypes Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        sparklineValues: '> primary | seriesByPrioritizedTypes'("number", "string", "time"),
+    }}
+    dataSources={{
+        primary: {
+            data: {
+                columns: [
+                    [
+                        '2018-08-19T00:00:00.000+00:00',
+                        '2018-08-20T00:00:00.000+00:00',
+                        '2018-08-21T00:00:00.000+00:00',
+                        '2018-08-22T00:00:00.000+00:00',
+                        '2018-08-23T00:00:00.000+00:00',
+                        '2018-08-24T00:00:00.000+00:00',
+                        '2018-08-25T00:00:00.000+00:00',
+                        '2018-08-26T00:00:00.000+00:00',
+                    ],
+                    [ 'INFO', 'ERROR', 'WARN', 'INFO', 'ERROR', 'WARN', 'INFO', 'WARN'],
+                ],
+                fields: [
+                    {
+                        name: '_time',
+                    },
+                    {
+                        name: 'status',
+                    },
+                ],
+            },
+            meta: {},
+        },
+    }}
+/>
+```

package/docs-llm/dsl/selectors/series-by-prioritized-types.md

@@ -0,0 +1,10 @@
+# seriesByPrioritizedTypes
+
+Select a DataSeries by specifying the prioritized types of the DataSeries you would like to return. The first DataSeries that matches the first type specified will be returned. If no DataSeries matches the first type specified, the first DataSeries that matches the second type will be returned, and so on.
+@public
+@param {DataType[]} types
+@returns {DataSeries<DataType>}
+
+The following code sample shows how to use seriesByPrioritizedTypes to display the first numeric series in a data source as a single value.
+
+If no numeric series are found in the data, the first series of type string is displayed. If no string series are found, the first series of type time is displayed.

package/docs-llm/dsl/selectors/series-by-type-examples-json.md

@@ -0,0 +1,49 @@
+# seriesByType Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "sparklineValues": "> primary | seriesByType(\"number\")"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "_time"
+          },
+          {
+            "name": "count"
+          }
+        ],
+        "columns": [
+          [
+            "2018-08-19T00:00:00.000+00:00",
+            "2018-08-20T00:00:00.000+00:00",
+            "2018-08-21T00:00:00.000+00:00",
+            "2018-08-22T00:00:00.000+00:00",
+            "2018-08-23T00:00:00.000+00:00",
+            "2018-08-24T00:00:00.000+00:00",
+            "2018-08-25T00:00:00.000+00:00",
+            "2018-08-26T00:00:00.000+00:00"
+          ],
+          [
+            "1",
+            "62",
+            "103",
+            "308",
+            "587",
+            "876",
+            "930",
+            "1320"
+          ]
+        ]
+      },
+      "meta": {}
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/series-by-type-examples-react.md

@@ -0,0 +1,39 @@
+# seriesByType Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        sparklineValues: '> primary | seriesByType("number")',
+    }}
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: '_time',
+                    },
+                    {
+                        name: 'count',
+                    },
+                ],
+                columns: [
+                    [
+                        '2018-08-19T00:00:00.000+00:00',
+                        '2018-08-20T00:00:00.000+00:00',
+                        '2018-08-21T00:00:00.000+00:00',
+                        '2018-08-22T00:00:00.000+00:00',
+                        '2018-08-23T00:00:00.000+00:00',
+                        '2018-08-24T00:00:00.000+00:00',
+                        '2018-08-25T00:00:00.000+00:00',
+                        '2018-08-26T00:00:00.000+00:00',
+                    ],
+                    [ '1', '62', '103', '308', '587', '876', '930', '1320'],
+                ],
+            },
+            meta: {},
+        },
+    }}
+/>
+```

package/docs-llm/dsl/selectors/series-by-type.md

@@ -0,0 +1,10 @@
+# seriesByType
+
+Select a DataSeries by specifying the type of the DataSeries you would like to return. The first DataSeries that matches the first type specified will be returned. If no DataSeries matches the first type specified, no DataSeries will be returned.
+@public
+@param {DataType} type
+@returns {DataSeries<DataType>}
+
+The following code sample shows how to use seriesByType to display the first numeric series in a data source as a single value.
+
+If no numeric series are found, return nothing and display N/A.

package/docs-llm/dsl/selectors/series-by-types.md

@@ -0,0 +1,6 @@
+# seriesByTypes
+
+Select a DataSeries by specifying any acceptable types of the DataSeries you would like to return. The first DataSeries that matches any of the types specified will be returned. If no DataSeries matches the type options specified, no DataSeries will be returned.
+@public
+@param {DataType[]} types
+@returns {DataSeries<DataType>}

package/docs-llm/ellipse/examples-json.md

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

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

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

package/docs-llm/ellipse/options.md

@@ -0,0 +1,16 @@
+# Ellipse Visualization Options
+
+**Component Reference:** Ellipse or @splunk/visualizations/ellipse
+
+Source: `@splunk/visualization-schemas/ellipseOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `fillColor` | string \| string | `> themes.defaultFillColor` | Specify the fill color. You may use a dataSource to apply the color. The hex value format should be "#FFFFFF". The default for enterprise light is "#C3CBD4". The default for enterprise dark is "#31373E". The default for prisma dark is "#0B0C0E". |
+| `fillOpacity` | number \| string | `1` | Specify the opacity of the fill. Choose a number in the range of 0 - 1 (inclusive). You can also express the value as a percentage. For example, "0.80" in source or "80%" in UI. |
+| `strokeColor` | string \| string | `> themes.defaultStrokeColor` | Specify the stroke color. You may use a dataSource to apply the color. The hex value format should be "#FFFFFF". The default for enterprise light is "#3C444D". The default for enterprise dark is "#C3CBD4". The default for prisma dark is "#ACACAD". |
+| `strokeDashStyle` | number \| string | `0` | Specify the size, in pixels, of dashes and spaces used to create a custom stitched outline. The value you specify applies to both the dashes and the spaces between them. |
+| `strokeOpacity` | number \| string | `1` | Specify the opacity of the stroke. Choose a number in the range of 0 - 1 (inclusive). You can also express the value as a percentage. For example, "0.80" in source or "80%" in UI. |
+| `strokeWidth` | number \| string | `1` | Specify the width of the stroke, in pixels. The minimum value is 0. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/ellipse/overview.md

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