kibana/api_docs/embeddable_enhanced.devdocs.json

{
  "id": "embeddableEnhanced",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "embeddableEnhanced",
        "id": "def-public.apiHasDynamicActions",
        "type": "Function",
        "tags": [],
        "label": "apiHasDynamicActions",
        "description": [],
        "signature": [
          "(api: unknown) => api is Required<Partial<{ enhancements: { dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "public",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-public.DynamicActionManager",
            "text": "DynamicActionManager"
          },
          "; }; setDynamicActions: (newState: { dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "common",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-common.DynamicActionsState",
            "text": "DynamicActionsState"
          },
          "; } | undefined) => void; dynamicActionsState$: ",
          {
            "pluginId": "@kbn/presentation-publishing",
            "scope": "public",
            "docId": "kibKbnPresentationPublishingPluginApi",
            "section": "def-public.PublishingSubject",
            "text": "PublishingSubject"
          },
          "<{ dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "common",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-common.DynamicActionsState",
            "text": "DynamicActionsState"
          },
          "; } | undefined>; }>>"
        ],
        "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/embeddables/interfaces/has_dynamic_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "embeddableEnhanced",
            "id": "def-public.apiHasDynamicActions.$1",
            "type": "Unknown",
            "tags": [],
            "label": "api",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/embeddables/interfaces/has_dynamic_actions.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "embeddableEnhanced",
        "id": "def-public.SetupDependencies",
        "type": "Interface",
        "tags": [],
        "label": "SetupDependencies",
        "description": [],
        "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "embeddableEnhanced",
            "id": "def-public.SetupDependencies.embeddable",
            "type": "Object",
            "tags": [],
            "label": "embeddable",
            "description": [],
            "signature": [
              {
                "pluginId": "embeddable",
                "scope": "public",
                "docId": "kibEmbeddablePluginApi",
                "section": "def-public.EmbeddableSetup",
                "text": "EmbeddableSetup"
              }
            ],
            "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "embeddableEnhanced",
            "id": "def-public.SetupDependencies.uiActionsEnhanced",
            "type": "Object",
            "tags": [],
            "label": "uiActionsEnhanced",
            "description": [],
            "signature": [
              {
                "pluginId": "uiActionsEnhanced",
                "scope": "public",
                "docId": "kibUiActionsEnhancedPluginApi",
                "section": "def-public.SetupContract",
                "text": "SetupContract"
              }
            ],
            "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "embeddableEnhanced",
        "id": "def-public.StartDependencies",
        "type": "Interface",
        "tags": [],
        "label": "StartDependencies",
        "description": [],
        "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "embeddableEnhanced",
            "id": "def-public.StartDependencies.embeddable",
            "type": "Object",
            "tags": [],
            "label": "embeddable",
            "description": [],
            "signature": [
              {
                "pluginId": "embeddable",
                "scope": "public",
                "docId": "kibEmbeddablePluginApi",
                "section": "def-public.EmbeddableStart",
                "text": "EmbeddableStart"
              }
            ],
            "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "embeddableEnhanced",
            "id": "def-public.StartDependencies.uiActionsEnhanced",
            "type": "Object",
            "tags": [],
            "label": "uiActionsEnhanced",
            "description": [],
            "signature": [
              {
                "pluginId": "uiActionsEnhanced",
                "scope": "public",
                "docId": "kibUiActionsEnhancedPluginApi",
                "section": "def-public.StartContract",
                "text": "StartContract"
              }
            ],
            "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "embeddableEnhanced",
        "id": "def-public.HasDynamicActions",
        "type": "Type",
        "tags": [],
        "label": "HasDynamicActions",
        "description": [],
        "signature": [
          "{ enhancements?: { dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "public",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-public.DynamicActionManager",
            "text": "DynamicActionManager"
          },
          "; } | undefined; setDynamicActions?: ((newState: { dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "common",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-common.DynamicActionsState",
            "text": "DynamicActionsState"
          },
          "; } | undefined) => void) | undefined; dynamicActionsState$?: ",
          {
            "pluginId": "@kbn/presentation-publishing",
            "scope": "public",
            "docId": "kibKbnPresentationPublishingPluginApi",
            "section": "def-public.PublishingSubject",
            "text": "PublishingSubject"
          },
          "<{ dynamicActions: ",
          {
            "pluginId": "uiActionsEnhanced",
            "scope": "common",
            "docId": "kibUiActionsEnhancedPluginApi",
            "section": "def-common.DynamicActionsState",
            "text": "DynamicActionsState"
          },
          "; } | undefined> | undefined; }"
        ],
        "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/embeddables/interfaces/has_dynamic_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "embeddableEnhanced",
      "id": "def-public.SetupContract",
      "type": "Interface",
      "tags": [],
      "label": "SetupContract",
      "description": [],
      "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "embeddableEnhanced",
      "id": "def-public.StartContract",
      "type": "Interface",
      "tags": [],
      "label": "StartContract",
      "description": [],
      "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "embeddableEnhanced",
          "id": "def-public.StartContract.initializeReactEmbeddableDynamicActions",
          "type": "Function",
          "tags": [],
          "label": "initializeReactEmbeddableDynamicActions",
          "description": [],
          "signature": [
            "(uuid: string, getTitle: () => string | undefined, state: ",
            "DynamicActionsSerializedState",
            ") => ",
            "ReactEmbeddableDynamicActionsApi"
          ],
          "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
          "deprecated": false,
          "trackAdoption": false,
          "children": [
            {
              "parentPluginId": "embeddableEnhanced",
              "id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$1",
              "type": "string",
              "tags": [],
              "label": "uuid",
              "description": [],
              "signature": [
                "string"
              ],
              "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
              "deprecated": false,
              "trackAdoption": false,
              "isRequired": true
            },
            {
              "parentPluginId": "embeddableEnhanced",
              "id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$2",
              "type": "Function",
              "tags": [],
              "label": "getTitle",
              "description": [],
              "signature": [
                "() => string | undefined"
              ],
              "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
              "deprecated": false,
              "trackAdoption": false,
              "isRequired": true
            },
            {
              "parentPluginId": "embeddableEnhanced",
              "id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$3",
              "type": "Object",
              "tags": [],
              "label": "state",
              "description": [],
              "signature": [
                "DynamicActionsSerializedState"
              ],
              "path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
              "deprecated": false,
              "trackAdoption": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}