@splunk/visualizations 28.5.3 → 28.7.0

package/docs-llm/dsl/selectors/data-frame-get-field-examples-json.md

@@ -0,0 +1,89 @@
+# DataFrame#getField Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "headers": "> table | getField()"
+  },
+  "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",
+            "Dore_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/data-frame-get-field-examples-react.md

@@ -0,0 +1,124 @@
+# DataFrame#getField Examples
+
+## Example 1
+
+```jsx
+<Table
+  options={{
+      headers: '> table | getField()'
+  }},
+  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',
+             'Dore_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
+     }
+    }
+  }}
+/>
+
+Display the third and fourth DataSeries in a column chart as overlay fields.
+
+<Column
+  options={{
+    overlayFields: '> primary | frameBySeriesIndex(2,3) | getField()'
+  }},
+  dataSources={{
+    primary: {
+      requestParams: { offset: 0, count: 20},
+      data: {
+        fields: [
+            { name: '_time' },
+            { name: 'splunkd' },
+            { name: 'splunkd_web_access' },
+            { name: 'mongod' },
+        ],
+        columns: [
+            [
+                '2018-05-02T18:15:46.000-07:00',
+                '2018-05-02T18:15:47.000-07:00',
+                '2018-05-02T18:15:48.000-07:00',
+                '2018-05-02T18:15:49.000-07:00',
+                '2018-05-02T18:15:50.000-07:00',
+            ],
+            ['67228', '83195', '3145', '19332', '29763'],
+            ['67228', '83195', '3145', '19332', '29763'],
+            ['14881', '17341', '18081', '19774', '10467'],
+        ]
+      },
+      meta: {
+        totalCount: 100,
+      }
+    }
+  }}
+/>
+```

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

@@ -0,0 +1,5 @@
+# DataFrame#getField
+
+Get the names of each DataSeries in the DataFrame.
+@public
+@returns {DataSeries<string>}

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

@@ -0,0 +1,5 @@
+# DataFrame#getRawValue
+
+Get all values in the DataFrame. This excludes field names.
+@public
+@returns {array}

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

@@ -0,0 +1,5 @@
+# DataFrame#getType
+
+Get the data type of each DataSeries in the DataFrame.
+@public
+@returns {string[]}

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

@@ -0,0 +1,5 @@
+# DataFrame#getValue
+
+Get all values and their types in the DataFrame. This excludes field names.
+@public
+@returns {TypedValue[][]}

package/docs-llm/dsl/selectors/data-frame-max-examples-json.md

@@ -0,0 +1,51 @@
+# DataFrame#max Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorValue": "> primary | max()",
+    "trendDisplay": "off",
+    "sparklineDisplay": "off"
+  },
+  "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/data-frame-max-examples-react.md

@@ -0,0 +1,41 @@
+# DataFrame#max Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        majorValue: '> primary | max()',
+        trendDisplay: 'off',
+        sparklineDisplay: 'off',
+    }}
+    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/data-frame-max.md

@@ -0,0 +1,7 @@
+# DataFrame#max
+
+Get the global maximum value from all numeric DataSeries in the DataFrame.
+@public
+@returns {number}
+
+The following code sample shows how to use max to display the largest data point in a data source as a single value.

package/docs-llm/dsl/selectors/data-frame-min-examples-json.md

@@ -0,0 +1,51 @@
+# DataFrame#min Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorValue": "> primary | min()",
+    "trendDisplay": "off",
+    "sparklineDisplay": "off"
+  },
+  "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/data-frame-min-examples-react.md

@@ -0,0 +1,41 @@
+# DataFrame#min Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        majorValue: '> primary | min()',
+        trendDisplay: 'off',
+        sparklineDisplay: 'off'
+    }}
+    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/data-frame-min.md

@@ -0,0 +1,7 @@
+# DataFrame#min
+
+Get the global minimum value from all numeric DataSeries in the DataFrame.
+@public
+@returns {number}
+
+The following code sample shows how to use min to display the smallest data point in a data source as a single value.

package/docs-llm/dsl/selectors/data-frame-percentile-examples-json.md

@@ -0,0 +1,41 @@
+# DataFrame#percentile Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorValue": "> primary | percentile(90)",
+    "trendDisplay": "off",
+    "sparklineDisplay": "off"
+  },
+  "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"
+          ],
+          [
+            "10",
+            "20",
+            "30"
+          ]
+        ]
+      },
+      "meta": {}
+    }
+  }
+}
+```

package/docs-llm/dsl/selectors/data-frame-percentile-examples-react.md

@@ -0,0 +1,36 @@
+# DataFrame#percentile Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        majorValue: '> primary | percentile(90)',
+        trendDisplay: 'off',
+        sparklineDisplay: 'off'
+    }}
+    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',
+                    ],
+                    [ '10', '20', '30' ],
+                ],
+            },
+            meta: {},
+        },
+    }}
+/>
+```

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

@@ -0,0 +1,8 @@
+# DataFrame#percentile
+
+Get the nearest-rank percentile of all numeric values from all numeric DataSeries in the DataFrame.
+@public
+@param {number} percentile value from 0 to 100
+@returns {DataPoint<DataType>}
+
+The following code sample shows how to use percentile to display the 90th percentile of all data points in a data source as a single value.

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

@@ -0,0 +1,5 @@
+# DataFrame#setValue
+
+Set all values in the DataFrame to a static TypedValue.
+@public
+@param {TypedValue} v

package/docs-llm/dsl/selectors/data-frame-sum-examples-json.md

@@ -0,0 +1,51 @@
+# DataFrame#sum Examples
+
+## Example 1
+
+```json
+{
+  "context": {},
+  "options": {
+    "majorValue": "> primary | sum()",
+    "trendDisplay": "off",
+    "sparklineDisplay": "off"
+  },
+  "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/data-frame-sum-examples-react.md

@@ -0,0 +1,41 @@
+# DataFrame#sum Examples
+
+## Example 1
+
+```jsx
+<SingleValue
+    options={{
+        majorValue: '> primary | sum()',
+        trendDisplay: 'off',
+        sparklineDisplay: 'off'
+    }}
+    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/data-frame-sum.md

@@ -0,0 +1,7 @@
+# DataFrame#sum
+
+Get the sum of all numeric values from all numeric DataSeries in the DataFrame.
+@public
+@returns {DataPoint<DataType>}
+
+The following code sample shows how to use sum to display the total of all data points in a data source as a single value.

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

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

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

@@ -0,0 +1,5 @@
+# DataPoint#getField
+
+Returns the data field of the point.
+@public
+@returns {DataPoint<'string'>}

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

@@ -0,0 +1,4 @@
+# DataPoint#getRawValue
+
+Get only value of the data point.
+@returns {string|number|GeoJsonDataType|null}

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

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

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

@@ -0,0 +1,5 @@
+# DataPoint#getValue
+
+Get the typed value of the data point.
+@public
+@returns {TypeSafeValue<T>}

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

@@ -0,0 +1,4 @@
+# DataPoint#setValue
+
+Sets the data point's value to a static TypedValue.
+@param {TypedValue} v

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

@@ -0,0 +1,5 @@
+# DataPoint Selectors
+
+Base DataPoint class and associated DataPoint selectors
+@implements {DataPrimitive}
+@implements {IDataPoint}