kibana/api_docs/dashboard_mode.json

{
  "id": "dashboardMode",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [
      {
        "id": "def-server.DashboardModeServerPlugin",
        "type": "Class",
        "tags": [],
        "label": "DashboardModeServerPlugin",
        "description": [],
        "signature": [
          {
            "pluginId": "dashboardMode",
            "scope": "server",
            "docId": "kibDashboardModePluginApi",
            "section": "def-server.DashboardModeServerPlugin",
            "text": "DashboardModeServerPlugin"
          },
          " implements ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCorePluginApi",
            "section": "def-server.Plugin",
            "text": "Plugin"
          },
          "<void, void, object, object>"
        ],
        "children": [
          {
            "id": "def-server.DashboardModeServerPlugin.Unnamed",
            "type": "Function",
            "label": "Constructor",
            "signature": [
              "any"
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.DashboardModeServerPlugin.Unnamed.$1",
                "type": "Object",
                "label": "initializerContext",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.PluginInitializerContext",
                    "text": "PluginInitializerContext"
                  },
                  "<unknown>"
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
                  "lineNumber": 30
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
              "lineNumber": 30
            }
          },
          {
            "id": "def-server.DashboardModeServerPlugin.setup",
            "type": "Function",
            "label": "setup",
            "signature": [
              "(core: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCorePluginApi",
                "section": "def-server.CoreSetup",
                "text": "CoreSetup"
              },
              "<object, unknown>, { security }: DashboardModeServerSetupDependencies) => void"
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.DashboardModeServerPlugin.setup.$1",
                "type": "Object",
                "label": "core",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.CoreSetup",
                    "text": "CoreSetup"
                  },
                  "<object, unknown>"
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
                  "lineNumber": 34
                }
              },
              {
                "id": "def-server.DashboardModeServerPlugin.setup.$2",
                "type": "Object",
                "label": "{ security }",
                "isRequired": true,
                "signature": [
                  "DashboardModeServerSetupDependencies"
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
                  "lineNumber": 34
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
              "lineNumber": 34
            }
          },
          {
            "id": "def-server.DashboardModeServerPlugin.start",
            "type": "Function",
            "label": "start",
            "signature": [
              "(core: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCorePluginApi",
                "section": "def-server.CoreStart",
                "text": "CoreStart"
              },
              ") => void"
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.DashboardModeServerPlugin.start.$1",
                "type": "Object",
                "label": "core",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.CoreStart",
                    "text": "CoreStart"
                  }
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
                  "lineNumber": 60
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
              "lineNumber": 60
            }
          },
          {
            "id": "def-server.DashboardModeServerPlugin.stop",
            "type": "Function",
            "label": "stop",
            "signature": [
              "() => void"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
              "lineNumber": 62
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
          "lineNumber": 26
        },
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "id": "def-common.UI_SETTINGS",
        "type": "Object",
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES",
            "type": "string",
            "label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES",
            "description": [],
            "source": {
              "path": "x-pack/plugins/dashboard_mode/common/constants.ts",
              "lineNumber": 9
            }
          }
        ],
        "description": [],
        "label": "UI_SETTINGS",
        "source": {
          "path": "x-pack/plugins/dashboard_mode/common/constants.ts",
          "lineNumber": 8
        },
        "initialIsOpen": false
      }
    ]
  }
}