kibana/api_docs/canvas.devdocs.json

{
  "id": "canvas",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "canvas",
        "id": "def-public.WithKibanaProps",
        "type": "Interface",
        "tags": [],
        "label": "WithKibanaProps",
        "description": [],
        "path": "x-pack/plugins/canvas/public/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "canvas",
            "id": "def-public.WithKibanaProps.kibana",
            "type": "Object",
            "tags": [],
            "label": "kibana",
            "description": [],
            "signature": [
              "{ services: ",
              {
                "pluginId": "@kbn/core-lifecycle-browser",
                "scope": "common",
                "docId": "kibKbnCoreLifecycleBrowserPluginApi",
                "section": "def-common.CoreStart",
                "text": "CoreStart"
              },
              " & ",
              "CanvasStartDeps",
              " & { canvas: ",
              "CanvasServices",
              "; }; }"
            ],
            "path": "x-pack/plugins/canvas/public/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "canvas",
      "id": "def-public.CanvasSetup",
      "type": "Type",
      "tags": [],
      "label": "CanvasSetup",
      "description": [
        "\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."
      ],
      "signature": [
        "CanvasApi"
      ],
      "path": "x-pack/plugins/canvas/public/plugin.tsx",
      "deprecated": false,
      "trackAdoption": false,
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "canvas",
      "id": "def-public.CanvasStart",
      "type": "Type",
      "tags": [],
      "label": "CanvasStart",
      "description": [],
      "signature": [
        "void"
      ],
      "path": "x-pack/plugins/canvas/public/plugin.tsx",
      "deprecated": false,
      "trackAdoption": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "canvas",
        "id": "def-common.CANVAS_APP_LOCATOR",
        "type": "string",
        "tags": [],
        "label": "CANVAS_APP_LOCATOR",
        "description": [],
        "signature": [
          "\"CANVAS_APP_LOCATOR\""
        ],
        "path": "x-pack/plugins/canvas/common/locator.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "canvas",
        "id": "def-common.CanvasAppLocator",
        "type": "Type",
        "tags": [],
        "label": "CanvasAppLocator",
        "description": [],
        "signature": [
          {
            "pluginId": "share",
            "scope": "common",
            "docId": "kibSharePluginApi",
            "section": "def-common.LocatorPublic",
            "text": "LocatorPublic"
          },
          "<",
          {
            "pluginId": "canvas",
            "scope": "common",
            "docId": "kibCanvasPluginApi",
            "section": "def-common.CanvasAppLocatorParams",
            "text": "CanvasAppLocatorParams"
          },
          ">"
        ],
        "path": "x-pack/plugins/canvas/common/locator.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "canvas",
        "id": "def-common.CanvasAppLocatorParams",
        "type": "Type",
        "tags": [],
        "label": "CanvasAppLocatorParams",
        "description": [],
        "signature": [
          "{ view: \"workpadPDF\"; id: string; page: number; }"
        ],
        "path": "x-pack/plugins/canvas/common/locator.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "canvas",
        "id": "def-common.UI_SETTINGS",
        "type": "Object",
        "tags": [],
        "label": "UI_SETTINGS",
        "description": [],
        "path": "x-pack/plugins/canvas/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "canvas",
            "id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
            "type": "string",
            "tags": [],
            "label": "ENABLE_LABS_UI",
            "description": [],
            "path": "x-pack/plugins/canvas/common/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}