@splunk/visualizations 28.6.0 → 28.8.0

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

@@ -0,0 +1,830 @@
+# DataFrame Selectors 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
+      }
+    }
+  }
+}
+```
+
+## Example 2
+
+```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
+      }
+    }
+  }
+}
+```
+
+## Example 3
+
+```json
+{
+  "context": {},
+  "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 4
+
+```json
+{
+  "context": {},
+  "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
+      }
+    }
+  }
+}
+```
+
+## Example 5
+
+```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 6
+
+```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
+      }
+    }
+  }
+}
+```
+
+## Example 7
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameBySeriesNamesOrIndexes(\"Name\", 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,
+            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
+      }
+    }
+  }
+}
+```
+
+## Example 8
+
+```json
+{
+  "context": {},
+  "options": {
+    "table": "> primary | frameBySeriesTypes(\"string\")"
+  },
+  "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
+      }
+    }
+  }
+}
+```
+
+## Example 9
+
+```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": {}
+    }
+  }
+}
+```
+
+## Example 10
+
+```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
+      }
+    }
+  }
+}
+```
+
+## Example 11
+
+```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": {}
+    }
+  }
+}
+```