maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/ui_actions.json
Stacey Gammon 2117e1324c
API DOCS Step 3/3 (#92929) (#93530) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	api_docs/core.json
#	api_docs/core_application.json
#	api_docs/core_http.json
#	api_docs/core_saved_objects.json
2021-03-03 20:12:24 -05:00

2530 lines
93 KiB
JSON
Raw Blame History

{
"id": "uiActions",
"client": {
"classes": [
{
"id": "def-public.UiActionsService",
"type": "Class",
"tags": [],
"label": "UiActionsService",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.UiActionsService.executionService",
"type": "Object",
"label": "executionService",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L27"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsExecutionService",
"text": "UiActionsExecutionService"
}
]
},
{
"tags": [],
"id": "def-public.UiActionsService.triggers",
"type": "Object",
"label": "triggers",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L28"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.TriggerRegistry",
"text": "TriggerRegistry"
}
]
},
{
"tags": [],
"id": "def-public.UiActionsService.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L29"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionRegistry",
"text": "ActionRegistry"
}
]
},
{
"tags": [],
"id": "def-public.UiActionsService.triggerToActions",
"type": "Object",
"label": "triggerToActions",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L30"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.TriggerToActionsRegistry",
"text": "TriggerToActionsRegistry"
}
]
},
{
"id": "def-public.UiActionsService.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "{\n triggers = new Map(),\n actions = new Map(),\n triggerToActions = new Map(),\n }",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsServiceParams",
"text": "UiActionsServiceParams"
}
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L32"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L32"
}
},
{
"id": "def-public.UiActionsService.registerTrigger",
"type": "Function",
"children": [
{
"type": "Object",
"label": "trigger",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
}
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L42"
}
}
],
"signature": [
"(trigger: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
},
") => void"
],
"description": [],
"label": "registerTrigger",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L42"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.getTrigger",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L53"
}
}
],
"signature": [
"(triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.TriggerContract",
"text": "TriggerContract"
},
"<object>"
],
"description": [],
"label": "getTrigger",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L53"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.registerAction",
"type": "Function",
"children": [
{
"type": "Uncategorized",
"label": "definition",
"isRequired": true,
"signature": [
"A"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L64"
}
}
],
"signature": [
"<A extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<object>>(definition: A) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionContext",
"text": "ActionContext"
},
"<A>>"
],
"description": [],
"label": "registerAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L63"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.unregisterAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "actionId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L77"
}
}
],
"signature": [
"(actionId: string) => void"
],
"description": [],
"label": "unregisterAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L77"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.hasAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "actionId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L85"
}
}
],
"signature": [
"(actionId: string) => boolean"
],
"description": [],
"label": "hasAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L85"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.attachAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L89"
}
},
{
"type": "string",
"label": "actionId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L89"
}
}
],
"signature": [
"(triggerId: string, actionId: string) => void"
],
"description": [],
"label": "attachAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L89"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.detachAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 105,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L105"
}
},
{
"type": "string",
"label": "actionId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 105,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L105"
}
}
],
"signature": [
"(triggerId: string, actionId: string) => void"
],
"description": [],
"label": "detachAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 105,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L105"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.addTriggerAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L127"
}
},
{
"type": "Object",
"label": "action",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<object>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L128"
}
}
],
"signature": [
"(triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<object>) => void"
],
"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."
],
"label": "addTriggerAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 126,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L126"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.getAction",
"type": "Function",
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 135,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L135"
}
}
],
"signature": [
"<T extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<object>>(id: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionContext",
"text": "ActionContext"
},
"<T>>"
],
"description": [],
"label": "getAction",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 134,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L134"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.getTriggerActions",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 144,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L144"
}
}
],
"signature": [
"(triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]"
],
"description": [],
"label": "getTriggerActions",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 144,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L144"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.getTriggerCompatibleActions",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 158,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L158"
}
},
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"object"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L159"
}
}
],
"signature": [
"(triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>"
],
"description": [],
"label": "getTriggerCompatibleActions",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 157,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L157"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.executeTriggerActions",
"type": "Function",
"children": [
{
"type": "string",
"label": "triggerId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 181,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L181"
}
},
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"object"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 181,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L181"
}
}
],
"signature": [
"(triggerId: string, context: object) => Promise<void>"
],
"description": [],
"label": "executeTriggerActions",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 181,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L181"
},
"tags": [
"deprecated"
],
"returnComment": []
},
{
"id": "def-public.UiActionsService.clear",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [
"\nRemoves all registered triggers and actions."
],
"label": "clear",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 189,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L189"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.UiActionsService.fork",
"type": "Function",
"children": [],
"signature": [
"() => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
}
],
"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."
],
"label": "fork",
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 200,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L200"
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L26"
},
"initialIsOpen": false
},
{
"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"
],
"children": [
{
"tags": [],
"id": "def-public.IncompatibleActionError.code",
"type": "string",
"label": "code",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/incompatible_action_error.ts#L12"
}
},
{
"id": "def-public.IncompatibleActionError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/incompatible_action_error.ts#L14"
}
}
],
"source": {
"path": "src/plugins/ui_actions/public/actions/incompatible_action_error.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/incompatible_action_error.ts#L11"
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.createAction",
"type": "Function",
"label": "createAction",
"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>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "action",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/create_action.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/create_action.ts#L12"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/create_action.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/create_action.ts#L11"
},
"initialIsOpen": false
},
{
"id": "def-public.buildContextMenuForActions",
"type": "Function",
"label": "buildContextMenuForActions",
"signature": [
"({\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}: ",
"BuildContextMenuParams",
") => Promise<",
"EuiContextMenuPanelDescriptor",
"[]>"
],
"description": [
"\nTransforms an array of Actions to the shape EuiContextMenuPanel expects."
],
"children": [
{
"type": "Object",
"label": "{\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.BuildContextMenuParams",
"text": "BuildContextMenuParams"
}
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx#L120"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx#L120"
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.UiActionsServiceParams",
"type": "Interface",
"label": "UiActionsServiceParams",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.UiActionsServiceParams.triggers",
"type": "Object",
"label": "triggers",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L17"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.TriggerRegistry",
"text": "TriggerRegistry"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.UiActionsServiceParams.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L18"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionRegistry",
"text": "ActionRegistry"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.UiActionsServiceParams.triggerToActions",
"type": "Object",
"label": "triggerToActions",
"description": [
"\nA 1-to-N mapping from `Trigger` to zero or more `Action`."
],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L23"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.TriggerToActionsRegistry",
"text": "TriggerToActionsRegistry"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/service/ui_actions_service.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-public.Action",
"type": "Interface",
"label": "Action",
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context> extends Partial<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Presentable",
"text": "Presentable"
},
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>>>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Action.order",
"type": "number",
"label": "order",
"description": [
"\nDetermined the order when there is more than one action matched to a trigger.\nHigher numbers are displayed first."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L44"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.Action.id",
"type": "string",
"label": "id",
"description": [
"\nA unique identifier for this action instance."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L49"
}
},
{
"tags": [],
"id": "def-public.Action.type",
"type": "string",
"label": "type",
"description": [
"\nThe action type is what determines the context shape."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L54"
}
},
{
"id": "def-public.Action.getIconType",
"type": "Function",
"label": "getIconType",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => string | undefined"
],
"description": [
"\nOptional EUI icon type that can be displayed along with the title."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L59"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L59"
}
},
{
"id": "def-public.Action.getDisplayName",
"type": "Function",
"label": "getDisplayName",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => string"
],
"description": [
"\nReturns a title to be displayed to the user."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L65"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L65"
}
},
{
"tags": [],
"id": "def-public.Action.MenuItem",
"type": "Function",
"label": "MenuItem",
"description": [
"\n`UiComponent` to render when displaying this action as a context menu item.\nIf not provided, `getDisplayName` will be used instead."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L71"
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<{ context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>; }> | undefined"
]
},
{
"id": "def-public.Action.isCompatible",
"type": "Function",
"label": "isCompatible",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<boolean>"
],
"description": [
"\nReturns a promise that resolves to true if this action is compatible given the context,\notherwise resolves to false."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L77"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L77"
}
},
{
"id": "def-public.Action.execute",
"type": "Function",
"label": "execute",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<void>"
],
"description": [
"\nExecutes the action."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L82"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L82"
}
},
{
"id": "def-public.Action.getHref",
"type": "Function",
"label": "getHref",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<string | undefined>) | undefined"
],
"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\"."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L89"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L89"
}
},
{
"id": "def-public.Action.shouldAutoExecute",
"type": "Function",
"label": "shouldAutoExecute",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>) => Promise<boolean>) | undefined"
],
"description": [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L96"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L96"
}
}
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L38"
},
"initialIsOpen": false
},
{
"id": "def-public.ActionDefinition",
"type": "Interface",
"label": "ActionDefinition",
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context> extends Partial<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Presentable",
"text": "Presentable"
},
"<",
"ActionDefinitionContext",
"<Context>>>"
],
"description": [
"\nA convenience interface used to register an action."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ActionDefinition.id",
"type": "string",
"label": "id",
"description": [
"\nID of the action that uniquely identifies this action in the actions registry."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 107,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L107"
}
},
{
"tags": [],
"id": "def-public.ActionDefinition.type",
"type": "string",
"label": "type",
"description": [
"\nID of the factory for this action. Used to construct dynamic actions."
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 112,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L112"
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.ActionDefinition.isCompatible",
"type": "Function",
"label": "isCompatible",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>) => Promise<boolean>) | undefined"
],
"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."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 118,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L118"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 118,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L118"
}
},
{
"id": "def-public.ActionDefinition.execute",
"type": "Function",
"label": "execute",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>) => Promise<void>"
],
"description": [
"\nExecutes the action."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 123,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L123"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 123,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L123"
}
},
{
"id": "def-public.ActionDefinition.shouldAutoExecute",
"type": "Function",
"label": "shouldAutoExecute",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>) => Promise<boolean>) | undefined"
],
"description": [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 130,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L130"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 130,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L130"
}
},
{
"id": "def-public.ActionDefinition.getHref",
"type": "Function",
"label": "getHref",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>) => Promise<string | undefined>) | undefined"
],
"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\"."
],
"children": [
{
"type": "CompoundType",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"<Context>"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 137,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L137"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 137,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L137"
}
}
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 102,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L102"
},
"initialIsOpen": false
},
{
"id": "def-public.Presentable",
"type": "Interface",
"label": "Presentable",
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Presentable",
"text": "Presentable"
},
"<Context>"
],
"description": [
"\nRepresents something that can be displayed to user in UI."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Presentable.id",
"type": "string",
"label": "id",
"description": [
"\nID that uniquely identifies this object."
],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L18"
}
},
{
"tags": [],
"id": "def-public.Presentable.order",
"type": "number",
"label": "order",
"description": [
"\nDetermines the display order in relation to other items. Higher numbers are\ndisplayed first."
],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L24"
}
},
{
"tags": [],
"id": "def-public.Presentable.MenuItem",
"type": "Function",
"label": "MenuItem",
"description": [
"\n`UiComponent` to render when displaying this entity as a context menu item.\nIf not provided, `getDisplayName` will be used instead."
],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L30"
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<{ context: Context; }> | undefined"
]
},
{
"id": "def-public.Presentable.getIconType",
"type": "Function",
"label": "getIconType",
"signature": [
"(context: Context) => string | undefined"
],
"description": [
"\nOptional EUI icon type that can be displayed along with the title."
],
"children": [
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L35"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L35"
}
},
{
"id": "def-public.Presentable.getDisplayName",
"type": "Function",
"label": "getDisplayName",
"signature": [
"(context: Context) => string"
],
"description": [
"\nReturns a title to be displayed to the user."
],
"children": [
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L40"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L40"
}
},
{
"id": "def-public.Presentable.getDisplayNameTooltip",
"type": "Function",
"label": "getDisplayNameTooltip",
"signature": [
"(context: Context) => string"
],
"description": [
"\nReturns tooltip text which should be displayed when user hovers this object.\nShould return empty string if tooltip should not be displayed."
],
"children": [
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L46"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L46"
}
},
{
"id": "def-public.Presentable.getHref",
"type": "Function",
"label": "getHref",
"signature": [
"((context: Context) => Promise<string | undefined>) | undefined"
],
"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\"."
],
"children": [
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L53"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L53"
}
},
{
"id": "def-public.Presentable.isCompatible",
"type": "Function",
"label": "isCompatible",
"signature": [
"(context: Context) => Promise<boolean>"
],
"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."
],
"children": [
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L59"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L59"
}
},
{
"tags": [],
"id": "def-public.Presentable.grouping",
"type": "Array",
"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."
],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L66"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.PresentableGrouping",
"text": "PresentableGrouping"
},
"<Context> | undefined"
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L14"
},
"initialIsOpen": false
},
{
"id": "def-public.Trigger",
"type": "Interface",
"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."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Trigger.id",
"type": "string",
"label": "id",
"description": [
"\nUnique name of the trigger as identified in `ui_actions` plugin trigger registry."
],
"source": {
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/trigger.ts#L24"
}
},
{
"tags": [],
"id": "def-public.Trigger.title",
"type": "string",
"label": "title",
"description": [
"\nUser friendly name of the trigger."
],
"source": {
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/trigger.ts#L29"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.Trigger.description",
"type": "string",
"label": "description",
"description": [
"\nA longer user friendly description of the trigger."
],
"source": {
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/trigger.ts#L34"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/triggers/trigger.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/trigger.ts#L20"
},
"initialIsOpen": false
},
{
"id": "def-public.RowClickContext",
"type": "Interface",
"label": "RowClickContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RowClickContext.embeddable",
"type": "Unknown",
"label": "embeddable",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L28"
},
"signature": [
"unknown"
]
},
{
"tags": [],
"id": "def-public.RowClickContext.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L29"
},
"signature": [
"{ rowIndex: number; table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; columns?: string[] | undefined; }"
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L25"
},
"initialIsOpen": false
},
{
"id": "def-public.VisualizeFieldContext",
"type": "Interface",
"label": "VisualizeFieldContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.VisualizeFieldContext.fieldName",
"type": "string",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L17"
}
},
{
"tags": [],
"id": "def-public.VisualizeFieldContext.indexPatternId",
"type": "string",
"label": "indexPatternId",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L18"
}
},
{
"tags": [],
"id": "def-public.VisualizeFieldContext.contextualFields",
"type": "Array",
"label": "contextualFields",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L19"
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-public.ActionExecutionMeta",
"type": "Interface",
"label": "ActionExecutionMeta",
"description": [
"\nDuring action execution we can provide additional information,\nfor example, trigger, that caused the action execution"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ActionExecutionMeta.trigger",
"type": "Object",
"label": "trigger",
"description": [
"\nTrigger that executed the action"
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L21"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
}
]
}
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L17"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.PresentableGrouping",
"type": "Type",
"label": "PresentableGrouping",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/util/presentable.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/util/presentable.ts#L76"
},
"signature": [
"PresentableGroup<Context>[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.VISUALIZE_FIELD_TRIGGER",
"type": "string",
"label": "VISUALIZE_FIELD_TRIGGER",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_field_trigger.ts#L11"
},
"signature": [
"\"VISUALIZE_FIELD_TRIGGER\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.VISUALIZE_GEO_FIELD_TRIGGER",
"type": "string",
"label": "VISUALIZE_GEO_FIELD_TRIGGER",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts#L11"
},
"signature": [
"\"VISUALIZE_GEO_FIELD_TRIGGER\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.ROW_CLICK_TRIGGER",
"type": "string",
"label": "ROW_CLICK_TRIGGER",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L13"
},
"signature": [
"\"ROW_CLICK_TRIGGER\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.ACTION_VISUALIZE_FIELD",
"type": "string",
"label": "ACTION_VISUALIZE_FIELD",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L22"
},
"signature": [
"\"ACTION_VISUALIZE_FIELD\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.ACTION_VISUALIZE_GEO_FIELD",
"type": "string",
"label": "ACTION_VISUALIZE_GEO_FIELD",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L23"
},
"signature": [
"\"ACTION_VISUALIZE_GEO_FIELD\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.ACTION_VISUALIZE_LENS_FIELD",
"type": "string",
"label": "ACTION_VISUALIZE_LENS_FIELD",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/types.ts#L24"
},
"signature": [
"\"ACTION_VISUALIZE_LENS_FIELD\""
],
"initialIsOpen": false
},
{
"id": "def-public.ActionExecutionContext",
"type": "Type",
"label": "ActionExecutionContext",
"tags": [],
"description": [
"\nAction methods are executed with Context from trigger + {@link ActionExecutionMeta}"
],
"source": {
"path": "src/plugins/ui_actions/public/actions/action.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/actions/action.ts#L27"
},
"signature": [
"Context & ActionExecutionMeta"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-public.visualizeFieldTrigger",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.visualizeFieldTrigger.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_field_trigger.ts#L13"
}
},
{
"tags": [],
"id": "def-public.visualizeFieldTrigger.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_field_trigger.ts#L14"
}
},
{
"tags": [],
"id": "def-public.visualizeFieldTrigger.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_field_trigger.ts#L15"
}
}
],
"description": [],
"label": "visualizeFieldTrigger",
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_field_trigger.ts#L12"
},
"initialIsOpen": false
},
{
"id": "def-public.visualizeGeoFieldTrigger",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.visualizeGeoFieldTrigger.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts#L13"
}
},
{
"tags": [],
"id": "def-public.visualizeGeoFieldTrigger.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts#L14"
}
},
{
"tags": [],
"id": "def-public.visualizeGeoFieldTrigger.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts#L15"
}
}
],
"description": [],
"label": "visualizeGeoFieldTrigger",
"source": {
"path": "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts#L12"
},
"initialIsOpen": false
},
{
"id": "def-public.rowClickTrigger",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.rowClickTrigger.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L16"
}
},
{
"tags": [],
"id": "def-public.rowClickTrigger.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L17"
}
},
{
"tags": [],
"id": "def-public.rowClickTrigger.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L20"
}
}
],
"description": [],
"label": "rowClickTrigger",
"source": {
"path": "src/plugins/ui_actions/public/triggers/row_click_trigger.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/triggers/row_click_trigger.ts#L15"
},
"initialIsOpen": false
}
],
"setup": {
"id": "def-public.UiActionsSetup",
"type": "Type",
"label": "UiActionsSetup",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/plugin.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/plugin.ts#L14"
},
"signature": [
"{ readonly addTriggerAction: (triggerId: string, action: ",
"UiActionsActionDefinition",
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A>(definition: A) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
"ActionContext",
"<A>>; readonly registerTrigger: (trigger: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Trigger",
"text": "Trigger"
},
") => void; readonly unregisterAction: (actionId: string) => void; }"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.UiActionsStart",
"type": "Type",
"label": "UiActionsStart",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/ui_actions/public/plugin.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/ui_actions/public/plugin.ts#L24"
},
"signature": [
"{ readonly clear: () => void; readonly fork: () => UiActionsService; readonly addTriggerAction: (triggerId: string, action: ",
"UiActionsActionDefinition",
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A>(definition: A) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
"ActionContext",
"<A>>; 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"
],
"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