@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/dsl/selectors/data-series-average.md

@@ -0,0 +1,22 @@
+# DataSeries#average
+
+Returns the average of all numeric values in the series as a DataPoint.
+Handles both numeric types and numeric strings (as returned by SPL queries).
+Non-numeric values are silently skipped.
+
+@public
+@returns {DataPoint<T>} DataPoint with average value, or undefined if no valid numeric values
+
+@example
+const series = new DataSeries([
+    new DataPoint('count', { type: 'number', value: 10 }),
+    new DataPoint('count', { type: 'number', value: 20 })
+]);
+series.average().getRawValue(); // Returns 15
+
+@example
+const splSeries = new DataSeries([
+    new DataPoint('count', { type: 'string', value: '10' }),
+    new DataPoint('count', { type: 'string', value: '20' })
+]);
+splSeries.average().getRawValue(); // Returns 15

package/docs-llm/dsl/selectors/data-series-count.md

@@ -0,0 +1,14 @@
+# DataSeries#count
+
+Returns the number of points in the series as a DataPoint.
+
+@public
+@returns {DataPoint<T>} DataPoint with count value, or undefined if the series is empty
+
+@example
+const series = new DataSeries([
+    new DataPoint('count', { type: 'number', value: 10 }),
+    new DataPoint('count', { type: 'number', value: 20 }),
+    new DataPoint('count', { type: 'number', value: 30 })
+]);
+series.count().getRawValue(); // Returns 3

package/docs-llm/dsl/selectors/data-series-get-field.md

@@ -0,0 +1,5 @@
+# DataSeries#getField
+
+Returns the data source field which the series belongs to.
+@public
+@returns {DataPoint<'string'>}

package/docs-llm/dsl/selectors/data-series-get-raw-value.md

@@ -0,0 +1,4 @@
+# DataSeries#getRawValue
+
+Gets all the values (only) in the Data Series.
+@returns {array}

package/docs-llm/dsl/selectors/data-series-get-type.md

@@ -0,0 +1,5 @@
+# DataSeries#getType
+
+Returns the inferred data type of the series.
+@public
+@returns {string}

package/docs-llm/dsl/selectors/data-series-get-value.md

@@ -0,0 +1,4 @@
+# DataSeries#getValue
+
+Gets all the values + their type in the Data Series.
+@returns {TypedValue[]}

package/docs-llm/dsl/selectors/data-series-max.md

@@ -0,0 +1,5 @@
+# DataSeries#max
+
+Returns the maximum DataPoint in the series.
+@public
+@returns {DataPoint<T>}

package/docs-llm/dsl/selectors/data-series-min.md

@@ -0,0 +1,5 @@
+# DataSeries#min
+
+Returns the minimum DataPoint in the series or undefined if no numbers in series.
+@public
+@returns {DataPoint<T>}

package/docs-llm/dsl/selectors/data-series-percentile.md

@@ -0,0 +1,17 @@
+# DataSeries#percentile
+
+Returns the nearest-rank percentile of all numeric values in the series as a DataPoint.
+Handles both numeric types and numeric strings (as returned by SPL queries).
+Non-numeric values are silently skipped.
+
+@public
+@param {number} percentile value from 0 to 100
+@returns {DataPoint<T>} DataPoint with percentile value, or undefined if no valid numeric values
+
+@example
+const series = new DataSeries([
+    new DataPoint('count', { type: 'number', value: 10 }),
+    new DataPoint('count', { type: 'number', value: 20 }),
+    new DataPoint('count', { type: 'number', value: 30 })
+]);
+series.percentile(90).getRawValue(); // Returns 30

package/docs-llm/dsl/selectors/data-series-set-value.md

@@ -0,0 +1,4 @@
+# DataSeries#setValue
+
+Sets all the values in the Data Series to a static TypedValue.
+@param {TypedValue} v

package/docs-llm/dsl/selectors/data-series-sum.md

@@ -0,0 +1,24 @@
+# DataSeries#sum
+
+Returns the sum of all numeric values in the series as a DataPoint.
+Handles both numeric types and numeric strings (as returned by SPL queries).
+Non-numeric values are silently skipped.
+
+@public
+@returns {DataPoint<T>} DataPoint with sum value, or undefined if no valid numeric values
+
+@example
+// With numeric values
+const series = new DataSeries([
+    new DataPoint('count', { type: 'number', value: 10 }),
+    new DataPoint('count', { type: 'number', value: 20 })
+]);
+series.sum().getRawValue(); // Returns 30
+
+@example
+// With numeric strings (SPL format)
+const series = new DataSeries([
+    new DataPoint('count', { type: 'string', value: '10' }),
+    new DataPoint('count', { type: 'string', value: '20' })
+]);
+series.sum().getRawValue(); // Returns 30

package/docs-llm/dsl/selectors/data-series.md

@@ -0,0 +1,4 @@
+# DataSeries Selectors
+
+DataSeries class and associated DataSeries selectors
+@implements {DataPrimitive}

package/docs-llm/dsl/selectors/delta.md

@@ -0,0 +1,7 @@
+# delta
+
+Finds the delta between the last point and point at the given index.
+A negative index can be used, indicating an offset from the end of the sequence.
+@public
+@param {number} index
+@returns {DataPoint}

package/docs-llm/dsl/selectors/divide.md

@@ -0,0 +1,8 @@
+# divide
+
+Divides the current data point value by a number and returns a new DataPoint.
+Numeric types and numeric strings are both supported.
+
+@public
+@param {number} value amount to divide the current point by
+@returns {DataPoint<'number'>} DataPoint with the adjusted numeric value, or undefined for non-numeric input

package/docs-llm/dsl/selectors/first-point.md

@@ -0,0 +1,5 @@
+# firstPoint
+
+Return first dataPoint in series.
+@public
+@returns {DataPoint}

package/docs-llm/dsl/selectors/floor.md

@@ -0,0 +1,7 @@
+# floor
+
+Floors the current data point value to the nearest lower integer and returns a new DataPoint.
+Numeric types and numeric strings are both supported.
+
+@public
+@returns {DataPoint<'number'>} DataPoint with floored value, or undefined for non-numeric input

package/docs-llm/dsl/selectors/frame-by-series-index-range-examples-json.md

@@ -0,0 +1,89 @@
+# frameBySeriesIndexRange Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameBySeriesIndexRange(0,2)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "Name"
+          },
+          {
+            "name": "UserID"
+          },
+          {
+            "name": "Money Spent"
+          },
+          {
+            "name": "Most Recent Game"
+          }
+        ],
+        "columns": [
+          [
+            "Ms. Herman Beer",
+            "Crystal Ziemann",
+            "Phil Bartoletti",
+            "Janis Kiehn V",
+            "Angel Krajcik",
+            "Patti Hodkiewicz IV",
+            "Joanne Emmerich",
+            "Jay Renner",
+            "Ora Borer",
+            "Dr. Bradford Gulgowski"
+          ],
+          [
+            "Enrico98",
+            "Taylor_Parker83",
+            "Candice_Carroll",
+            "Yolanda_McLaughlin95",
+            "Modesto84",
+            "Elwin52",
+            "Francis8",
+            "Charley.Feeney85",
+            "Jensen_Jacobson74",
+            "Dora_Volkman"
+          ],
+          [
+            9740890.83,
+            2107983.52,
+            5467223.67,
+            9529184.93,
+            9692275.78,
+            9395814.7,
+            5692737.43,
+            1001734.82,
+            3848531.8,
+            1691776.38
+          ],
+          [
+            "2020-04-12T06:32:08-07:00",
+            "2020-06-06T16:14:04-07:00",
+            "2020-02-12T09:43:25-08:00",
+            "2020-07-25T13:19:49-07:00",
+            "2020-03-16T21:46:40-07:00",
+            "2020-08-21T08:38:55-07:00",
+            "2020-09-26T16:06:03-07:00",
+            "2020-08-10T14:54:16-07:00",
+            "2020-08-11T16:49:24-07:00",
+            "2020-09-29T03:52:51-07:00"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      },
+      "requestParams": {
+        "count": 10,
+        "offset": 0
+      }
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/frame-by-series-index-range-examples-react.md

@@ -0,0 +1,88 @@
+# frameBySeriesIndexRange Examples
+
+## Example 1
+
+```jsx
+<Table
+  options={{
+    table: '> primary | frameBySeriesIndexRange(0,2)'
+  }},
+  dataSources={{
+    primary: {
+      data: {
+        fields: [
+          {
+            name: 'Name'
+          },
+          {
+            name: 'UserID'
+          },
+          {
+            name: 'Money Spent'
+          },
+          {
+            name: 'Most Recent Game'
+          },
+        ],
+        columns: [
+          [
+            'Ms. Herman Beer',
+            'Crystal Ziemann',
+            'Phil Bartoletti',
+            'Janis Kiehn V',
+            'Angel Krajcik',
+            'Patti Hodkiewicz IV',
+            'Joanne Emmerich',
+            'Jay Renner',
+            'Ora Borer',
+            'Dr. Bradford Gulgowski'
+          ],
+          [
+            'Enrico98',
+            'Taylor_Parker83',
+            'Candice_Carroll',
+            'Yolanda_McLaughlin95',
+            'Modesto84',
+            'Elwin52',
+            'Francis8',
+            'Charley.Feeney85',
+            'Jensen_Jacobson74',
+            'Dora_Volkman'
+          ],
+          [
+            9740890.83,
+            2107983.52,
+            5467223.67,
+            9529184.93,
+            9692275.78,
+            9395814.7,
+            5692737.43,
+            1001734.82,
+            3848531.8,
+            1691776.38
+          ],
+          [
+            '2020-04-12T06:32:08-07:00',
+            '2020-06-06T16:14:04-07:00',
+            '2020-02-12T09:43:25-08:00',
+            '2020-07-25T13:19:49-07:00',
+            '2020-03-16T21:46:40-07:00',
+            '2020-08-21T08:38:55-07:00',
+            '2020-09-26T16:06:03-07:00',
+            '2020-08-10T14:54:16-07:00',
+            '2020-08-11T16:49:24-07:00',
+            '2020-09-29T03:52:51-07:00'
+          ]
+        ]
+      },
+      meta: {
+        totalCount: 100
+      },
+      requestParams: {
+        count: 10,
+        offset: 0
+      }
+    }
+  }}
+/>
+```

package/docs-llm/dsl/selectors/frame-by-series-index-range.md

@@ -0,0 +1,10 @@
+# frameBySeriesIndexRange
+
+Filter a DataFrame by specifying the index range [start, end) of the DataSeries you would like to return.
+For example, `frameBySeriesIndexRange(start_index)` or `frameBySeriesIndexRange(start_index, end_index)`, where at least the starting index is required.
+@public
+@param {int} start (inclusive)
+@param {int=} end (optional, exclusive)
+@returns {DataFrame<DataType>}
+
+The following code sample shows how to use frameBySeriesIndexRange to render a table that includes the first, second, and third series from the data source.

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

@@ -0,0 +1,88 @@
+# frameBySeriesIndexes Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameBySeriesIndexes(0,1,3)"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "Name"
+          },
+          {
+            "name": "UserID"
+          },
+          {
+            "name": "Money Spent"
+          },
+          {
+            "name": "Most Recent Game"
+          }
+        ],
+        "columns": [
+          [
+            "Ms. Herman Beer",
+            "Crystal Ziemann",
+            "Phil Bartoletti",
+            "Janis Kiehn V",
+            "Angel Krajcik",
+            "Patti Hodkiewicz IV",
+            "Joanne Emmerich",
+            "Jay Renner",
+            "Ora Borer",
+            "Dr. Bradford Gulgowski"
+          ],
+          [
+            "Enrico98",
+            "Taylor_Parker83",
+            "Candice_Carroll",
+            "Yolanda_McLaughlin95",
+            "Modesto84",
+            "Elwin52",
+            "Francis8",
+            "Charley.Feeney85",
+            "Jensen_Jacobson74",
+            "Dora_Volkman"
+          ],
+          [
+            9740890.83,
+            2107983.52,
+            5467223.67,
+            9529184.93,
+            9692275.78,
+            5692737.43,
+            1001734.82,
+            3848531.8,
+            3848531.8
+          ],
+          [
+            "2020-04-12T06:32:08-07:00",
+            "2020-06-06T16:14:04-07:00",
+            "2020-02-12T09:43:25-08:00",
+            "2020-07-25T13:19:49-07:00",
+            "2020-03-16T21:46:40-07:00",
+            "2020-08-21T08:38:55-07:00",
+            "2020-09-26T16:06:03-07:00",
+            "2020-08-10T14:54:16-07:00",
+            "2020-08-11T16:49:24-07:00",
+            "2020-09-29T03:52:51-07:00"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      },
+      "requestParams": {
+        "count": 10,
+        "offset": 0
+      }
+    }
+  }
+}
+```

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

@@ -0,0 +1,87 @@
+# frameBySeriesIndexes Examples
+
+## Example 1
+
+```jsx
+<Table
+  options={{
+    table: '> primary | frameBySeriesIndexes(0,1,3)'
+  }},
+  dataSources={{
+    primary: {
+      data: {
+        fields: [
+          {
+            name: 'Name'
+          },
+          {
+            name: 'UserID'
+          },
+          {
+            name: 'Money Spent'
+          },
+          {
+            name: 'Most Recent Game'
+          }
+        ],
+        columns: [
+          [
+            'Ms. Herman Beer',
+            'Crystal Ziemann',
+            'Phil Bartoletti',
+            'Janis Kiehn V',
+            'Angel Krajcik',
+            'Patti Hodkiewicz IV',
+            'Joanne Emmerich',
+            'Jay Renner',
+            'Ora Borer',
+            'Dr. Bradford Gulgowski'
+          ],
+          [
+            'Enrico98',
+            'Taylor_Parker83',
+            'Candice_Carroll',
+            'Yolanda_McLaughlin95',
+            'Modesto84',
+            'Elwin52',
+            'Francis8',
+            'Charley.Feeney85',
+            'Jensen_Jacobson74',
+            'Dora_Volkman'
+          ],
+          [
+            9740890.83,
+            2107983.52,
+            5467223.67,
+            9529184.93,
+            9692275.78,
+            5692737.43,
+            1001734.82,
+            3848531.8,
+            3848531.8
+          ],
+          [
+            '2020-04-12T06:32:08-07:00',
+            '2020-06-06T16:14:04-07:00',
+            '2020-02-12T09:43:25-08:00',
+            '2020-07-25T13:19:49-07:00',
+            '2020-03-16T21:46:40-07:00',
+            '2020-08-21T08:38:55-07:00',
+            '2020-09-26T16:06:03-07:00',
+            '2020-08-10T14:54:16-07:00',
+            '2020-08-11T16:49:24-07:00',
+            '2020-09-29T03:52:51-07:00'
+          ]
+        ]
+      },
+      meta: {
+        totalCount: 100
+      },
+      requestParams: {
+        count: 10,
+        offset: 0
+      }
+    }
+  }}
+/>
+```

package/docs-llm/dsl/selectors/frame-by-series-indexes.md

@@ -0,0 +1,9 @@
+# frameBySeriesIndexes
+
+Filter a DataFrame by specifying the indexes of the DataSeries you would like to return.
+For example, `frameBySeriesIndexes(first_index, second_index, ...)`, where at least one index is required.
+@public
+@param {number[]} indexes
+@returns {DataFrame.<DataType>}
+
+The following code sample shows how to use frameBySeriesIndexes to render a table that includes the first, second, and fourth DataSeries from the data source.

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

@@ -0,0 +1,89 @@
+# frameBySeriesNames Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameBySeriesNames(\"Name\", \"Money Spent\")"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "Name"
+          },
+          {
+            "name": "UserID"
+          },
+          {
+            "name": "Money Spent"
+          },
+          {
+            "name": "Most Recent Game"
+          }
+        ],
+        "columns": [
+          [
+            "Ms. Herman Beer",
+            "Crystal Ziemann",
+            "Phil Bartoletti",
+            "Janis Kiehn V",
+            "Angel Krajcik",
+            "Patti Hodkiewicz IV",
+            "Joanne Emmerich",
+            "Jay Renner",
+            "Ora Borer",
+            "Dr. Bradford Gulgowski"
+          ],
+          [
+            "Enrico98",
+            "Taylor_Parker83",
+            "Candice_Carroll",
+            "Yolanda_McLaughlin95",
+            "Modesto84",
+            "Elwin52",
+            "Francis8",
+            "Charley.Feeney85",
+            "Jensen_Jacobson74",
+            "Dora_Volkman"
+          ],
+          [
+            9740890.83,
+            2107983.52,
+            5467223.67,
+            9529184.93,
+            9692275.78,
+            9395814.7,
+            5692737.43,
+            1001734.82,
+            3848531.8,
+            1691776.38
+          ],
+          [
+            "2020-04-12T06:32:08-07:00",
+            "2020-06-06T16:14:04-07:00",
+            "2020-02-12T09:43:25-08:00",
+            "2020-07-25T13:19:49-07:00",
+            "2020-03-16T21:46:40-07:00",
+            "2020-08-21T08:38:55-07:00",
+            "2020-09-26T16:06:03-07:00",
+            "2020-08-10T14:54:16-07:00",
+            "2020-08-11T16:49:24-07:00",
+            "2020-09-29T03:52:51-07:00"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      },
+      "requestParams": {
+        "count": 10,
+        "offset": 0
+      }
+    }
+  }
+}
+```