@splunk/visualizations 28.6.0 → 28.7.0

package/docs-llm/dsl/selectors/frame-without-internal-fields-examples-react.md

@@ -0,0 +1,135 @@
+# frameWithoutInternalFields Examples
+
+## Example 1
+
+```jsx
+<Table
+    options={{
+        table: '> primary | frameWithoutInternalFields()'
+    }},
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: 'Name'
+                    },
+                    {
+                        name: 'UserID'
+                    },
+                    {
+                        name: '_time'
+                    },
+                    {
+                        name: '_span'
+                    },
+                ],
+                columns: [
+                    [
+                        'Ms. Herman Beer',
+                        'Crystal Ziemann',
+                        'Jay Renner',
+                        'Ora Borer',
+                        'Dr. Bradford Gulgowski'
+                    ],
+                    [
+                        'Enrico98',
+                        'Taylor_Parker83',
+                        'Charley.Feeney85',
+                        'Jensen_Jacobson74',
+                        'Dora_Volkman'
+                    ],
+                    [
+                        '2020-04-12T06:32:08-07:00',
+                        '2020-06-06T16:14:04-07:00',
+                        '2020-08-10T14:54:16-07:00',
+                        '2020-08-11T16:49:24-07:00',
+                        '2020-09-29T03:52:51-07:00'
+                    ],
+                    [
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800'
+                    ]
+                ]
+            },
+            meta: {
+                totalCount: 100
+            },
+            requestParams: {
+                count: 10,
+                offset: 0
+            }
+        }
+    }}
+/>
+```
+
+## Example 2
+
+```jsx
+<SingleValue
+    options={{
+        "majorValue": "> primary | frameWithoutInternalFields() | seriesByIndex(0) | lastPoint()"
+    }},
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: '_time'
+                    },
+                    {
+                        name: '_span'
+                    },
+                    {
+                        name: 'Name'
+                    },
+                    {
+                        name: 'UserID'
+                    }
+                ],
+                columns: [
+                    [
+                        '2020-04-12T06:32:08-07:00',
+                        '2020-06-06T16:14:04-07:00',
+                        '2020-08-10T14:54:16-07:00',
+                        '2020-08-11T16:49:24-07:00',
+                        '2020-09-29T03:52:51-07:00'
+                    ],
+                    [
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800'
+                    ],
+                    [
+                        'Patti Hodkiewicz IV',
+                        'Joanne Emmerich',
+                        'Jay Renner',
+                        'Ora Borer',
+                        'Dr. Bradford Gulgowski'
+                    ],
+                    [
+                        'Elwin52',
+                        'Francis8',
+                        'Charley.Feeney85',
+                        'Jensen_Jacobson74',
+                        'Dora_Volkman'
+                    ]
+                ]
+            },
+            meta: {
+                totalCount: 100
+            },
+            requestParams: {
+                count: 10,
+                offset: 0
+            }
+        }
+    }}
+/>
+```

package/docs-llm/dsl/selectors/frame-without-internal-fields-except-examples-json.md

@@ -0,0 +1,157 @@
+# frameWithoutInternalFieldsExcept Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameWithoutInternalFieldsExcept('_time', '_span')"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "Name"
+          },
+          {
+            "name": "UserID"
+          },
+          {
+            "name": "_time"
+          },
+          {
+            "name": "_span"
+          },
+          {
+            "name": "_raw"
+          }
+        ],
+        "columns": [
+          [
+            "Ms. Herman Beer",
+            "Joanne Emmerich",
+            "Jay Renner",
+            "Ora Borer",
+            "Dr. Bradford Gulgowski"
+          ],
+          [
+            "Enrico98",
+            "Francis8",
+            "Charley.Feeney85",
+            "Jensen_Jacobson74",
+            "Dora_Volkman"
+          ],
+          [
+            "2020-04-12T06:32:08-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"
+          ],
+          [
+            "1800",
+            "1800",
+            "1800",
+            "1800",
+            "1800"
+          ],
+          [
+            "2020-04-12T06:32:08-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
+      }
+    }
+  }
+}
+```
+
+## Example 2
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorValue": "> primary | frameWithoutInternalFieldsExcept('_time') | seriesByIndex(1) | lastPoint()"
+  },
+  "dataSources": {
+    "primary": {
+      "data": {
+        "fields": [
+          {
+            "name": "_time"
+          },
+          {
+            "name": "_span"
+          },
+          {
+            "name": "_raw"
+          },
+          {
+            "name": "Name"
+          },
+          {
+            "name": "UserID"
+          }
+        ],
+        "columns": [
+          [
+            "2020-04-12T06:32:08-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"
+          ],
+          [
+            "1800",
+            "1800",
+            "1800",
+            "1800",
+            "1800"
+          ],
+          [
+            "2020-04-12T06:32:08-07:00",
+            "2020-06-06T16:14:04-07:00",
+            "2020-08-10T14:54:16-07:00",
+            "2020-08-11T16:49:24-07:00",
+            "2020-09-29T03:52:51-07:00"
+          ],
+          [
+            "Ms. Herman Beer",
+            "Crystal Ziemann",
+            "Angel Krajcik",
+            "Jay Renner",
+            "Dr. Bradford Gulgowski"
+          ],
+          [
+            "Candice_Carroll",
+            "Elwin52",
+            "Francis8",
+            "Charley.Feeney85",
+            "Dora_Volkman"
+          ]
+        ]
+      },
+      "meta": {
+        "totalCount": 100
+      },
+      "requestParams": {
+        "count": 10,
+        "offset": 0
+      }
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/frame-without-internal-fields-except-examples-react.md

@@ -0,0 +1,155 @@
+# frameWithoutInternalFieldsExcept Examples
+
+## Example 1
+
+```jsx
+<Table
+    options={{
+        table: "> primary | frameWithoutInternalFieldsExcept('_time', '_span')"
+    }},
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: 'Name'
+                    },
+                    {
+                        name: 'UserID'
+                    },
+                    {
+                        name: '_time'
+                    },
+                    {
+                        name: '_span'
+                    },
+                    {
+                        name: '_raw'
+                    },
+                ],
+                columns: [
+                    [
+                        'Ms. Herman Beer',
+                        'Joanne Emmerich',
+                        'Jay Renner',
+                        'Ora Borer',
+                        'Dr. Bradford Gulgowski'
+                    ],
+                    [
+                        'Enrico98',
+                        'Francis8',
+                        'Charley.Feeney85',
+                        'Jensen_Jacobson74',
+                        'Dora_Volkman'
+                    ],
+                    [
+                        '2020-04-12T06:32:08-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'
+                    ],
+                    [
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800'
+                    ],
+                    [
+                        '2020-04-12T06:32:08-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
+            }
+        }
+    }}
+/>
+```
+
+## Example 2
+
+```jsx
+<SingleValue
+    options={{
+        "majorValue": "> primary | frameWithoutInternalFieldsExcept('_time') | seriesByIndex(1) | lastPoint()"
+    }},
+    dataSources={{
+        primary: {
+            data: {
+                fields: [
+                    {
+                        name: '_time'
+                    },
+                    {
+                        name: '_span'
+                    },
+                    {
+                        name: '_raw'
+                    },
+                    {
+                        name: 'Name'
+                    },
+                    {
+                        name: 'UserID'
+                    }
+                ],
+                columns: [
+                    [
+                        '2020-04-12T06:32:08-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'
+                    ],
+                    [
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800',
+                        '1800'
+                    ],
+                    [
+                        '2020-04-12T06:32:08-07:00',
+                        '2020-06-06T16:14:04-07:00',
+                        '2020-08-10T14:54:16-07:00',
+                        '2020-08-11T16:49:24-07:00',
+                        '2020-09-29T03:52:51-07:00'
+                    ],
+                    [
+                        'Ms. Herman Beer',
+                        'Crystal Ziemann',
+                        'Angel Krajcik',
+                        'Jay Renner',
+                        'Dr. Bradford Gulgowski'
+                    ],
+                    [
+                        'Candice_Carroll',
+                        'Elwin52',
+                        'Francis8',
+                        'Charley.Feeney85',
+                        'Dora_Volkman'
+                    ]
+                ]
+            },
+            meta: {
+                totalCount: 100
+            },
+            requestParams: {
+                count: 10,
+                offset: 0
+            }
+        }
+    }}
+/>
+```

package/docs-llm/dsl/selectors/frame-without-internal-fields-except.md

@@ -0,0 +1,21 @@
+# frameWithoutInternalFieldsExcept
+
+Filter a DataFrame by removing all internal fields starting with underscore `_`, except for the fields listed in `names`.
+For example, if you have a primary data source with the following fields: `_time, _span, date, count, cost, _raw`,
+then DSL `> primary | frameWithoutInternalFields('_time')` removes all the internal fields except `_time` and returns the DataFrame with fields `_time, date, count, cost`.
+If you want to remove all the internal fields, use `frameWithoutInternalFields()` instead.
+If you pass any non-internal fields as parameters, they will be ignored.
+
+@public
+@param {string[]} names
+@returns {DataFrame<DataType>}
+
+The following code sample shows how to use `frameWithoutInternalFieldsExcept(...names)` to remove some internal fields from the data source, but leaving specified internal fields by their field names.
+
+This code sample will visualize the table with the `Name`, `UserID`, `_time` and `_span` columns,
+and the `_raw` columns will not be displayed.
+
+Another example of using `frameWithoutInternalFieldsExcept(...names)` in a chained DSL:
+
+This code sample will visualize `Dr. Bradford Gulgowski` as the major value, because the internal fields other than `_time` are excluded,
+and index `1` of the rest of the data frame (`_time`, `Name`, `UserID`) corresponds to the `Name` column.

package/docs-llm/dsl/selectors/frame-without-internal-fields.md

@@ -0,0 +1,17 @@
+# frameWithoutInternalFields
+
+Filter a DataFrame by removing all internal fields starting with underscore `_`.
+For example, if you have a primary data source with the following fields: `_time, _span, date, count, cost, _raw`,
+then DSL `> primary | frameWithoutInternalFields()` removes all the internal fields and returns the DataFrame with fields `date, count, cost`.
+@public
+@returns {DataFrame<DataType>}
+
+The following code sample shows how to use `frameWithoutInternalFields()` to remove the internal fields from the data source.
+
+This code sample will visualize a table with the `Name` and `UserID` columns,
+and the columns of `_time` and `_span` (internal fields) will not be displayed.
+
+Another example of using `frameWithoutInternalFields()` in a chained DSL:
+
+This code sample will visualize `Dr. Bradford Gulgowski` as the major value,
+because both internal fields (`_time` and `_span`) are removed and index `0` of the rest of the data frame corresponds to the `Name` column.

package/docs-llm/dsl/selectors/frame-without-series-names.md

@@ -0,0 +1,8 @@
+# frameWithoutSeriesNames
+
+Filter a DataFrame by specifying the names of the DataSeries you would like to omit.
+ e.g. `frameWithoutSeriesNames(first_name, second_name, ...)`, where at least one series name is required.
+Note: the data columns of internal fields are automatically excluded from the result.
+@public
+@param {string[]} names
+@returns {DataFrame<DataType>}

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

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

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

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

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

@@ -0,0 +1,8 @@
+# multiply
+
+Multiplies 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 multiply the current point by
+@returns {DataPoint<'number'>} DataPoint with the adjusted numeric value, or undefined for non-numeric input

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

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

package/docs-llm/dsl/selectors/point-by-index.md

@@ -0,0 +1,6 @@
+# pointByIndex
+
+Finds and returns the individual dataPoint at the given index.
+@public
+@param {number} index
+@returns {DataPoint}

package/docs-llm/dsl/selectors/points-by-indexes.md

@@ -0,0 +1,6 @@
+# pointsByIndexes
+
+Finds dataPoint(s) in DataSeries by index(es).
+@public
+@param {...number} indexes
+@returns {DataSeries}

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

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

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

@@ -0,0 +1,49 @@
+# seriesByIndex Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "sparklineValues": "> primary | seriesByIndex(1)"
+  },
+  "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-index-examples-react.md

@@ -0,0 +1,39 @@
+# seriesByIndex Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        sparklineValues: '> primary | seriesByIndex(1)'
+    }}
+    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-index.md

@@ -0,0 +1,8 @@
+# seriesByIndex
+
+Select a DataSeries by specifying the index of the series you want to return.
+@public
+@param {number} index
+@returns {DataSeries<DataType>}
+
+The following code sample shows how to use seriesByIndex to display the second series in a data source as a single value.