kibana/api_docs/vis_type_timeseries.json

{
  "id": "visTypeTimeseries",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "visTypeTimeseries",
        "id": "def-server.isVisSeriesData",
        "type": "Function",
        "tags": [],
        "label": "isVisSeriesData",
        "description": [],
        "signature": [
          "(data: ",
          "TimeseriesVisData",
          ") => data is ",
          "SeriesData"
        ],
        "path": "src/plugins/vis_types/timeseries/common/vis_data_utils.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "visTypeTimeseries",
            "id": "def-server.isVisSeriesData.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "data",
            "description": [],
            "signature": [
              "TimeseriesVisData"
            ],
            "path": "src/plugins/vis_types/timeseries/common/vis_data_utils.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "visTypeTimeseries",
        "id": "def-server.isVisTableData",
        "type": "Function",
        "tags": [],
        "label": "isVisTableData",
        "description": [],
        "signature": [
          "(data: ",
          "TimeseriesVisData",
          ") => data is ",
          "TableData"
        ],
        "path": "src/plugins/vis_types/timeseries/common/vis_data_utils.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "visTypeTimeseries",
            "id": "def-server.isVisTableData.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "data",
            "description": [],
            "signature": [
              "TimeseriesVisData"
            ],
            "path": "src/plugins/vis_types/timeseries/common/vis_data_utils.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "visTypeTimeseries",
        "id": "def-server.TimeseriesVisData",
        "type": "Type",
        "tags": [],
        "label": "TimeseriesVisData",
        "description": [],
        "signature": [
          "SeriesData",
          " | ",
          "TableData"
        ],
        "path": "src/plugins/vis_types/timeseries/common/types/vis_data.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "visTypeTimeseries",
      "id": "def-server.VisTypeTimeseriesSetup",
      "type": "Interface",
      "tags": [],
      "label": "VisTypeTimeseriesSetup",
      "description": [],
      "path": "src/plugins/vis_types/timeseries/server/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "visTypeTimeseries",
          "id": "def-server.VisTypeTimeseriesSetup.getVisData",
          "type": "Function",
          "tags": [],
          "label": "getVisData",
          "description": [],
          "signature": [
            "(requestContext: ",
            "DataRequestHandlerContext",
            ", fakeRequest: ",
            {
              "pluginId": "core",
              "scope": "server",
              "docId": "kibCoreHttpPluginApi",
              "section": "def-server.KibanaRequest",
              "text": "KibanaRequest"
            },
            "<unknown, unknown, unknown, any>, options: any) => Promise<",
            "TimeseriesVisData",
            ">"
          ],
          "path": "src/plugins/vis_types/timeseries/server/plugin.ts",
          "deprecated": false,
          "children": [
            {
              "parentPluginId": "visTypeTimeseries",
              "id": "def-server.VisTypeTimeseriesSetup.getVisData.$1",
              "type": "Object",
              "tags": [],
              "label": "requestContext",
              "description": [],
              "signature": [
                "DataRequestHandlerContext"
              ],
              "path": "src/plugins/vis_types/timeseries/server/plugin.ts",
              "deprecated": false,
              "isRequired": true
            },
            {
              "parentPluginId": "visTypeTimeseries",
              "id": "def-server.VisTypeTimeseriesSetup.getVisData.$2",
              "type": "Object",
              "tags": [],
              "label": "fakeRequest",
              "description": [],
              "signature": [
                {
                  "pluginId": "core",
                  "scope": "server",
                  "docId": "kibCoreHttpPluginApi",
                  "section": "def-server.KibanaRequest",
                  "text": "KibanaRequest"
                },
                "<unknown, unknown, unknown, any>"
              ],
              "path": "src/plugins/vis_types/timeseries/server/plugin.ts",
              "deprecated": false,
              "isRequired": true
            },
            {
              "parentPluginId": "visTypeTimeseries",
              "id": "def-server.VisTypeTimeseriesSetup.getVisData.$3",
              "type": "Any",
              "tags": [],
              "label": "options",
              "description": [],
              "signature": [
                "any"
              ],
              "path": "src/plugins/vis_types/timeseries/server/plugin.ts",
              "deprecated": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}