github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/ui_actions.devdocs.json

2791 lines
No EOL
96 KiB
JSON
Raw Permalink Blame History

{
"id": "uiActions",
"client": {
"classes": [
{
"parentPluginId": "uiActions",
"id": "def-public.IncompatibleActionError",
"type": "Class",
"tags": [],
"label": "IncompatibleActionError",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.IncompatibleActionError",
"text": "IncompatibleActionError"
},
" extends Error"
],
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.IncompatibleActionError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.IncompatibleActionError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService",
"type": "Class",
"tags": [],
"label": "UiActionsService",
"description": [],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.executionService",
"type": "Object",
"tags": [],
"label": "executionService",
"description": [],
"signature": [
"UiActionsExecutionService"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.triggers",
"type": "Object",
"tags": [],
"label": "triggers",
"description": [],
"signature": [
"Map<string, ",
"TriggerInternal",
"<object>>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"Map<string, ",
"ActionInternal",
"<object>>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.triggerToActions",
"type": "Object",
"tags": [],
"label": "triggerToActions",
"description": [],
"signature": [
"Map<string, string[]>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n triggers = new Map(),\n actions = new Map(),\n triggerToActions = new Map(),\n }",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsServiceParams",
"text": "UiActionsServiceParams"
}
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.registerTrigger",
"type": "Function",
"tags": [],
"label": "registerTrigger",
"description": [],
"signature": [
"(trigger: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
},
") => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.registerTrigger.$1",
"type": "Object",
"tags": [],
"label": "trigger",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
}
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTrigger",
"type": "Function",
"tags": [],
"label": "getTrigger",
"description": [],
"signature": [
"(triggerId: string) => ",
"TriggerContract",
"<object>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTrigger.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.registerAction",
"type": "Function",
"tags": [],
"label": "registerAction",
"description": [],
"signature": [
"<Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.registerAction.$1",
"type": "Object",
"tags": [],
"label": "definition",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.unregisterAction",
"type": "Function",
"tags": [],
"label": "unregisterAction",
"description": [],
"signature": [
"(actionId: string) => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.unregisterAction.$1",
"type": "string",
"tags": [],
"label": "actionId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.hasAction",
"type": "Function",
"tags": [],
"label": "hasAction",
"description": [],
"signature": [
"(actionId: string) => boolean"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.hasAction.$1",
"type": "string",
"tags": [],
"label": "actionId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.attachAction",
"type": "Function",
"tags": [],
"label": "attachAction",
"description": [],
"signature": [
"(triggerId: string, actionId: string) => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.attachAction.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.attachAction.$2",
"type": "string",
"tags": [],
"label": "actionId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.detachAction",
"type": "Function",
"tags": [],
"label": "detachAction",
"description": [],
"signature": [
"(triggerId: string, actionId: string) => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.detachAction.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.detachAction.$2",
"type": "string",
"tags": [],
"label": "actionId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.addTriggerAction",
"type": "Function",
"tags": [],
"label": "addTriggerAction",
"description": [
"\n`addTriggerAction` is similar to `attachAction` as it attaches action to a\ntrigger, but it also registers the action, if it has not been registered, yet."
],
"signature": [
"(triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.addTriggerAction.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.addTriggerAction.$2",
"type": "Object",
"tags": [],
"label": "action",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getAction",
"type": "Function",
"tags": [],
"label": "getAction",
"description": [],
"signature": [
"(id: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getAction.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTriggerActions",
"type": "Function",
"tags": [],
"label": "getTriggerActions",
"description": [],
"signature": [
"(triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTriggerActions.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTriggerCompatibleActions",
"type": "Function",
"tags": [],
"label": "getTriggerCompatibleActions",
"description": [],
"signature": [
"(triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTriggerCompatibleActions.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.getTriggerCompatibleActions.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"object"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.executeTriggerActions",
"type": "Function",
"tags": [
"deprecated"
],
"label": "executeTriggerActions",
"description": [],
"signature": [
"(triggerId: string, context: object) => Promise<void>"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "data",
"path": "src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx"
},
{
"plugin": "data",
"path": "src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx"
},
{
"plugin": "discover",
"path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx"
},
{
"plugin": "discover",
"path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts"
},
{
"plugin": "discover",
"path": "src/plugins/discover/public/plugin.tsx"
},
{
"plugin": "imageEmbeddable",
"path": "src/plugins/image_embeddable/public/image_embeddable/image_embeddable_factory.tsx"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/tests/container.test.ts"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/tests/container.test.ts"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/tests/container.test.ts"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/tests/container.test.ts"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/tests/explicit_input.test.ts"
}
],
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.executeTriggerActions.$1",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.executeTriggerActions.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"object"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.clear",
"type": "Function",
"tags": [],
"label": "clear",
"description": [
"\nRemoves all registered triggers and actions."
],
"signature": [
"() => void"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsService.fork",
"type": "Function",
"tags": [],
"label": "fork",
"description": [
"\n\"Fork\" a separate instance of `UiActionsService` that inherits all existing\ntriggers and actions, but going forward all new triggers and actions added\nto this instance of `UiActionsService` are only available within this instance."
],
"signature": [
"() => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
}
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "uiActions",
"id": "def-public.buildContextMenuForActions",
"type": "Function",
"tags": [],
"label": "buildContextMenuForActions",
"description": [
"\nTransforms an array of Actions to the shape EuiContextMenuPanel expects."
],
"signature": [
"({\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}: ",
"BuildContextMenuParams",
") => Promise<",
"EuiContextMenuPanelDescriptor",
"[]>"
],
"path": "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.buildContextMenuForActions.$1",
"type": "Object",
"tags": [],
"label": "{\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}",
"description": [],
"signature": [
"BuildContextMenuParams"
],
"path": "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.createAction",
"type": "Function",
"tags": [],
"label": "createAction",
"description": [],
"signature": [
"(action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/create_action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.createAction.$1",
"type": "Object",
"tags": [],
"label": "action",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/create_action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action",
"type": "Interface",
"tags": [],
"label": "Action",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context> extends Partial<",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Presentable",
"text": "Presentable"
},
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>>>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.order",
"type": "number",
"tags": [],
"label": "order",
"description": [
"\nDetermined the order when there is more than one action matched to a trigger.\nHigher numbers are displayed first."
],
"signature": [
"number | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nA unique identifier for this action instance."
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nThe action type is what determines the context shape."
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getIconType",
"type": "Function",
"tags": [],
"label": "getIconType",
"description": [
"\nOptional EUI icon type that can be displayed along with the title."
],
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => string | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getIconType.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [
"\nReturns a title to be displayed to the user."
],
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => string"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getDisplayName.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [
"\nReturns a promise that resolves to true if this action is compatible given the context,\notherwise resolves to false."
],
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<boolean>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.isCompatible.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.execute",
"type": "Function",
"tags": [],
"label": "execute",
"description": [
"\nExecutes the action."
],
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<void>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.execute.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getHref",
"type": "Function",
"tags": [],
"label": "getHref",
"description": [
"\nThis method should return a link if this item can be clicked on. The link\nis used to navigate user if user middle-clicks it or Ctrl + clicks or\nright-clicks and selects \"Open in new tab\"."
],
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<string | undefined>) | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.getHref.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.shouldAutoExecute",
"type": "Function",
"tags": [],
"label": "shouldAutoExecute",
"description": [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
],
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<boolean>) | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Action.shouldAutoExecute.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [
"\naction is disabled or not\n"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Action.showNotification",
"type": "CompoundType",
"tags": [],
"label": "showNotification",
"description": [
"\nDetermines if notification should be shown in menu for that action\n"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition",
"type": "Interface",
"tags": [],
"label": "ActionDefinition",
"description": [
"\nA convenience interface used to register an action."
],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context> extends Partial<",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Presentable",
"text": "Presentable"
},
"<",
"ActionDefinitionContext",
"<Context>>>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nID of the action that uniquely identifies this action in the actions registry."
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nID of the factory for this action. Used to construct dynamic actions."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [
"\nReturns a promise that resolves to true if this item is compatible given\nthe context and should be displayed to user, otherwise resolves to false."
],
"signature": [
"((context: ",
"ActionDefinitionContext",
"<Context>) => Promise<boolean>) | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.isCompatible.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ActionDefinitionContext",
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.execute",
"type": "Function",
"tags": [],
"label": "execute",
"description": [
"\nExecutes the action."
],
"signature": [
"(context: ",
"ActionDefinitionContext",
"<Context>) => Promise<void>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.execute.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ActionDefinitionContext",
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.shouldAutoExecute",
"type": "Function",
"tags": [],
"label": "shouldAutoExecute",
"description": [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
],
"signature": [
"((context: ",
"ActionDefinitionContext",
"<Context>) => Promise<boolean>) | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.shouldAutoExecute.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ActionDefinitionContext",
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.getHref",
"type": "Function",
"tags": [],
"label": "getHref",
"description": [
"\nThis method should return a link if this item can be clicked on. The link\nis used to navigate user if user middle-clicks it or Ctrl + clicks or\nright-clicks and selects \"Open in new tab\"."
],
"signature": [
"((context: ",
"ActionDefinitionContext",
"<Context>) => Promise<string | undefined>) | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.getHref.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ActionDefinitionContext",
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [
"\naction is disabled or not\n"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionDefinition.showNotification",
"type": "CompoundType",
"tags": [],
"label": "showNotification",
"description": [
"\nDetermines if notification should be shown in menu for that action\n"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionExecutionMeta",
"type": "Interface",
"tags": [],
"label": "ActionExecutionMeta",
"description": [
"\nDuring action execution we can provide additional information,\nfor example, trigger, that caused the action execution"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionExecutionMeta.trigger",
"type": "Object",
"tags": [],
"label": "trigger",
"description": [
"\nTrigger that executed the action"
],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
}
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionMenuItemProps",
"type": "Interface",
"tags": [],
"label": "ActionMenuItemProps",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionMenuItemProps",
"text": "ActionMenuItemProps"
},
"<Context>"
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.ActionMenuItemProps.context",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context & ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionMeta",
"text": "ActionExecutionMeta"
}
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.CategorizeFieldContext",
"type": "Interface",
"tags": [],
"label": "CategorizeFieldContext",
"description": [],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.CategorizeFieldContext.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.CategorizeFieldContext.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.CategorizeFieldContext.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable",
"type": "Interface",
"tags": [],
"label": "Presentable",
"description": [
"\nRepresents something that can be displayed to user in UI."
],
"signature": [
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Presentable",
"text": "Presentable"
},
"<Context>"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nID that uniquely identifies this object."
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.order",
"type": "number",
"tags": [],
"label": "order",
"description": [
"\nDetermines the display order in relation to other items. Higher numbers are\ndisplayed first."
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.MenuItem",
"type": "Function",
"tags": [],
"label": "MenuItem",
"description": [
"\nComponent to render when displaying this entity as a context menu item.\nIf not provided, `getDisplayName` will be used instead."
],
"signature": [
"React.FC<{ context: Context; }> | undefined"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getIconType",
"type": "Function",
"tags": [],
"label": "getIconType",
"description": [
"\nOptional EUI icon type that can be displayed along with the title."
],
"signature": [
"(context: Context) => string | undefined"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getIconType.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [
"\nReturns a title to be displayed to the user."
],
"signature": [
"(context: Context) => string"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getDisplayName.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getDisplayNameTooltip",
"type": "Function",
"tags": [],
"label": "getDisplayNameTooltip",
"description": [
"\nReturns tooltip text which should be displayed when user hovers this object.\nShould return empty string if tooltip should not be displayed."
],
"signature": [
"((context: Context) => string) | undefined"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getDisplayNameTooltip.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getHref",
"type": "Function",
"tags": [],
"label": "getHref",
"description": [
"\nThis method should return a link if this item can be clicked on. The link\nis used to navigate user if user middle-clicks it or Ctrl + clicks or\nright-clicks and selects \"Open in new tab\"."
],
"signature": [
"((context: Context) => Promise<string | undefined>) | undefined"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.getHref.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [
"\nReturns a promise that resolves to true if this item is compatible given\nthe context and should be displayed to user, otherwise resolves to false."
],
"signature": [
"(context: Context) => Promise<boolean>"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.isCompatible.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActions",
"id": "def-public.Presentable.grouping",
"type": "Array",
"tags": [],
"label": "grouping",
"description": [
"\nGrouping where this item should appear as a submenu. Each entry is a new\nsub-menu level. For example, used to show drilldowns and sharing options\nin panel context menu in a sub-menu."
],
"signature": [
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.PresentableGrouping",
"text": "PresentableGrouping"
},
"<Context> | undefined"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.RowClickContext",
"type": "Interface",
"tags": [],
"label": "RowClickContext",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.RowClickContext.embeddable",
"type": "Unknown",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.RowClickContext.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ rowIndex: number; table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; columns?: string[] | undefined; }"
],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Trigger",
"type": "Interface",
"tags": [],
"label": "Trigger",
"description": [
"\nThis is a convenience interface used to register a *trigger*.\n\n`Trigger` specifies a named anchor to which `Action` can be attached. When\n`Trigger` is being *called* it creates a `Context` object and passes it to\nthe `execute` method of an `Action`.\n\nMore than one action can be attached to a single trigger, in which case when\ntrigger is *called* it first displays a context menu for user to pick a\nsingle action to execute."
],
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.Trigger.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique name of the trigger as identified in `ui_actions` plugin trigger registry."
],
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Trigger.title",
"type": "string",
"tags": [],
"label": "title",
"description": [
"\nUser friendly name of the trigger."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.Trigger.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nA longer user friendly description of the trigger."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsServiceParams",
"type": "Interface",
"tags": [],
"label": "UiActionsServiceParams",
"description": [],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsServiceParams.triggers",
"type": "Object",
"tags": [],
"label": "triggers",
"description": [],
"signature": [
"TriggerRegistry",
" | undefined"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsServiceParams.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"ActionRegistry",
" | undefined"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.UiActionsServiceParams.triggerToActions",
"type": "Object",
"tags": [],
"label": "triggerToActions",
"description": [
"\nA 1-to-N mapping from `Trigger` to zero or more `Action`."
],
"signature": [
"TriggerToActionsRegistry",
" | undefined"
],
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext",
"type": "Interface",
"tags": [],
"label": "VisualizeFieldContext",
"description": [],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext.dataViewSpec",
"type": "Object",
"tags": [],
"label": "dataViewSpec",
"description": [],
"signature": [
"{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined; fields?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewFieldMap",
"text": "DataViewFieldMap"
},
" | undefined; typeMeta?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined; type?: string | undefined; fieldFormats?: Record<string, ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<{}, ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">> | undefined; runtimeFieldMap?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.RuntimeFieldSpec",
"text": "RuntimeFieldSpec"
},
"> | undefined; fieldAttrs?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext.contextualFields",
"type": "Array",
"tags": [],
"label": "contextualFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VisualizeFieldContext.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "uiActions",
"id": "def-public.ACTION_CATEGORIZE_FIELD",
"type": "string",
"tags": [],
"label": "ACTION_CATEGORIZE_FIELD",
"description": [],
"signature": [
"\"ACTION_CATEGORIZE_FIELD\""
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ACTION_VISUALIZE_FIELD",
"type": "string",
"tags": [],
"label": "ACTION_VISUALIZE_FIELD",
"description": [],
"signature": [
"\"ACTION_VISUALIZE_FIELD\""
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ACTION_VISUALIZE_GEO_FIELD",
"type": "string",
"tags": [],
"label": "ACTION_VISUALIZE_GEO_FIELD",
"description": [],
"signature": [
"\"ACTION_VISUALIZE_GEO_FIELD\""
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ACTION_VISUALIZE_LENS_FIELD",
"type": "string",
"tags": [],
"label": "ACTION_VISUALIZE_LENS_FIELD",
"description": [],
"signature": [
"\"ACTION_VISUALIZE_LENS_FIELD\""
],
"path": "src/plugins/ui_actions/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ActionExecutionContext",
"type": "Type",
"tags": [],
"label": "ActionExecutionContext",
"description": [
"\nAction methods are executed with Context from trigger + {@link ActionExecutionMeta}"
],
"signature": [
"Context & ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionMeta",
"text": "ActionExecutionMeta"
}
],
"path": "src/plugins/ui_actions/public/actions/action.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.CATEGORIZE_FIELD_TRIGGER",
"type": "string",
"tags": [],
"label": "CATEGORIZE_FIELD_TRIGGER",
"description": [],
"signature": [
"\"CATEGORIZE_FIELD_TRIGGER\""
],
"path": "src/plugins/ui_actions/public/triggers/categorize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.PresentableGrouping",
"type": "Type",
"tags": [],
"label": "PresentableGrouping",
"description": [],
"signature": [
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.PresentableGroup",
"text": "PresentableGroup"
},
"<Context>[]"
],
"path": "packages/kbn-ui-actions-browser/src/types/presentable.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.ROW_CLICK_TRIGGER",
"type": "string",
"tags": [],
"label": "ROW_CLICK_TRIGGER",
"description": [],
"signature": [
"\"ROW_CLICK_TRIGGER\""
],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VISUALIZE_FIELD_TRIGGER",
"type": "string",
"tags": [],
"label": "VISUALIZE_FIELD_TRIGGER",
"description": [],
"signature": [
"\"VISUALIZE_FIELD_TRIGGER\""
],
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.VISUALIZE_GEO_FIELD_TRIGGER",
"type": "string",
"tags": [],
"label": "VISUALIZE_GEO_FIELD_TRIGGER",
"description": [],
"signature": [
"\"VISUALIZE_GEO_FIELD_TRIGGER\""
],
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "uiActions",
"id": "def-public.categorizeFieldTrigger",
"type": "Object",
"tags": [],
"label": "categorizeFieldTrigger",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/categorize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.categorizeFieldTrigger.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/categorize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.categorizeFieldTrigger.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/categorize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.categorizeFieldTrigger.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/categorize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.rowClickTrigger",
"type": "Object",
"tags": [],
"label": "rowClickTrigger",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.rowClickTrigger.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.rowClickTrigger.title",
"type": "Any",
"tags": [],
"label": "title",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.rowClickTrigger.description",
"type": "Any",
"tags": [],
"label": "description",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeFieldTrigger",
"type": "Object",
"tags": [],
"label": "visualizeFieldTrigger",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeFieldTrigger.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeFieldTrigger.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeFieldTrigger.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeGeoFieldTrigger",
"type": "Object",
"tags": [],
"label": "visualizeGeoFieldTrigger",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeGeoFieldTrigger.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeGeoFieldTrigger.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActions",
"id": "def-public.visualizeGeoFieldTrigger.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "uiActions",
"id": "def-public.UiActionsSetup",
"type": "Type",
"tags": [],
"label": "UiActionsSetup",
"description": [],
"signature": [
"{ readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerTrigger: (trigger: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
},
") => void; readonly unregisterAction: (actionId: string) => void; }"
],
"path": "src/plugins/ui_actions/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "uiActions",
"id": "def-public.UiActionsStart",
"type": "Type",
"tags": [],
"label": "UiActionsStart",
"description": [],
"signature": [
"{ readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerTrigger: (trigger: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
},
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: (id: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>; readonly getTriggerActions: (triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
"; }"
],
"path": "src/plugins/ui_actions/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink