2021-03-03 04:02:17 +01:00
{
"id" : "uiActions" ,
"client" : {
"classes" : [
2021-03-06 02:12:28 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"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"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/incompatible_action_error.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.IncompatibleActionError.code" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "code" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/incompatible_action_error.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.IncompatibleActionError.Unnamed" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "Constructor" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"any"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/incompatible_action_error.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "UiActionsService" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.executionService" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "executionService" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"UiActionsExecutionService"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.triggers" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggers" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"Map<string, " ,
"TriggerInternal" ,
2021-09-08 23:50:25 +02:00
"<object>>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.actions" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "actions" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"Map<string, " ,
"ActionInternal" ,
"<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>>>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.triggerToActions" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerToActions" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"Map<string, string[]>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.Unnamed" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "Constructor" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"any"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "{\n triggers = new Map(),\n actions = new Map(),\n triggerToActions = new Map(),\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsServiceParams" ,
"text" : "UiActionsServiceParams"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.registerTrigger" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "registerTrigger" ,
"description" : [ ] ,
"signature" : [
"(trigger: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Trigger" ,
"text" : "Trigger"
} ,
") => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.registerTrigger.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "trigger" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Trigger" ,
"text" : "Trigger"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.getTrigger" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getTrigger" ,
"description" : [ ] ,
"signature" : [
"(triggerId: string) => " ,
"TriggerContract" ,
"<object>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.getTrigger.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.registerAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "registerAction" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"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"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"ActionContext" ,
2021-03-03 04:02:17 +01:00
"<A>>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.registerAction.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "definition" ,
"description" : [ ] ,
"signature" : [
"A"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.unregisterAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "unregisterAction" ,
"description" : [ ] ,
"signature" : [
"(actionId: string) => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.unregisterAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "actionId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.hasAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "hasAction" ,
"description" : [ ] ,
"signature" : [
"(actionId: string) => boolean"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.hasAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "actionId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.attachAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "attachAction" ,
"description" : [ ] ,
"signature" : [
"(triggerId: string, actionId: string) => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.attachAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.attachAction.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "actionId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.detachAction" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "detachAction" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(triggerId: string, actionId: string) => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.detachAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.detachAction.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "actionId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.addTriggerAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"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"
} ,
"<object>) => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.addTriggerAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.addTriggerAction.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "action" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.getAction" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getAction" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"<T extends " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
2021-05-06 21:29:47 +02:00
"<object>>(id: string) => " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Action" ,
"text" : "Action"
} ,
"<" ,
"ActionContext" ,
"<T>>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.getAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.getTriggerActions" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getTriggerActions" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"(triggerId: string) => " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Action" ,
"text" : "Action"
} ,
2021-05-06 21:29:47 +02:00
"<object>[]"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.getTriggerActions.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.getTriggerCompatibleActions" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getTriggerCompatibleActions" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"(triggerId: string, context: object) => Promise<" ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Action" ,
"text" : "Action"
} ,
2021-05-06 21:29:47 +02:00
"<object>[]>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.getTriggerCompatibleActions.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.getTriggerCompatibleActions.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"object"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "uiActions" ,
"id" : "def-public.UiActionsService.executeTriggerActions" ,
"type" : "Function" ,
"tags" : [
"deprecated"
] ,
"label" : "executeTriggerActions" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"(triggerId: string, context: object) => Promise<void>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : true ,
"references" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"plugin" : "data" ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx"
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
{
"plugin" : "data" ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx"
2021-05-06 21:29:47 +02:00
} ,
{
"plugin" : "discover" ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/discover/public/application/embeddable/saved_search_embeddable.tsx"
2021-05-06 21:29:47 +02:00
} ,
{
"plugin" : "discover" ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/discover/public/application/embeddable/search_embeddable_factory.ts"
2021-05-06 21:29:47 +02:00
} ,
{
"plugin" : "discover" ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/discover/public/plugin.tsx"
2021-08-24 19:42:23 +02:00
} ,
{
"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"
} ,
{
"plugin" : "discover" ,
"path" : "src/plugins/discover/target/types/public/application/embeddable/search_embeddable_factory.d.ts"
2021-05-06 21:29:47 +02:00
}
2021-03-03 04:02:17 +01:00
] ,
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.executeTriggerActions.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "triggerId" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.UiActionsService.executeTriggerActions.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"object"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.clear" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "clear" ,
2021-03-03 04:02:17 +01:00
"description" : [
"\nRemoves all registered triggers and actions."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"() => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsService.fork" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"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."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"() => " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsService" ,
"text" : "UiActionsService"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
}
] ,
"functions" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.buildContextMenuForActions" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "buildContextMenuForActions" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nTransforms an array of Actions to the shape EuiContextMenuPanel expects."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}: " ,
"BuildContextMenuParams" ,
") => Promise<" ,
"EuiContextMenuPanelDescriptor" ,
"[]>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.buildContextMenuForActions.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"BuildContextMenuParams"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.createAction" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "createAction" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"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>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/create_action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.createAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "action" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/create_action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "Action" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"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>>>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.order" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "order" ,
"description" : [
"\nDetermined the order when there is more than one action matched to a trigger.\nHigher numbers are displayed first."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"number | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.id" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
"\nA unique identifier for this action instance."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.type" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "type" ,
"description" : [
"\nThe action type is what determines the context shape."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.getIconType" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getIconType" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nOptional EUI icon type that can be displayed along with the title."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.getIconType.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.getDisplayName" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getDisplayName" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nReturns a title to be displayed to the user."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.getDisplayName.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.MenuItem" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "MenuItem" ,
"description" : [
"\n`UiComponent` to render when displaying this action as a context menu item.\nIf not provided, `getDisplayName` will be used instead."
] ,
"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"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.isCompatible" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "isCompatible" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nReturns a promise that resolves to true if this action is compatible given the context,\notherwise resolves to false."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => Promise<boolean>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.isCompatible.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.execute" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "execute" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nExecutes the action."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => Promise<void>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.execute.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.getHref" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getHref" ,
2021-05-06 21:29:47 +02:00
"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\"."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"((context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => Promise<string | undefined>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.getHref.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Action.shouldAutoExecute" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "shouldAutoExecute" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"((context: " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>) => Promise<boolean>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Action.shouldAutoExecute.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "ActionDefinition" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nA convenience interface used to register an action."
] ,
2021-03-03 04:02:17 +01:00
"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>>>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.id" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
"\nID of the action that uniquely identifies this action in the actions registry."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.type" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "type" ,
"description" : [
"\nID of the factory for this action. Used to construct dynamic actions."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.isCompatible" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "isCompatible" ,
2021-05-06 21:29:47 +02:00
"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."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"((context: " ,
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>) => Promise<boolean>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionDefinition.isCompatible.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.execute" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "execute" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nExecutes the action."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(context: " ,
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>) => Promise<void>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionDefinition.execute.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.shouldAutoExecute" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "shouldAutoExecute" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nDetermines if action should be executed automatically,\nwithout first showing up in context menu.\nfalse by default."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"((context: " ,
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>) => Promise<boolean>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionDefinition.shouldAutoExecute.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.ActionDefinition.getHref" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getHref" ,
2021-05-06 21:29:47 +02:00
"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\"."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"((context: " ,
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>) => Promise<string | undefined>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionDefinition.getHref.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionDefinitionContext" ,
2021-03-03 04:02:17 +01:00
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ActionExecutionMeta" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ActionExecutionMeta" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nDuring action execution we can provide additional information,\nfor example, trigger, that caused the action execution"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ActionExecutionMeta.trigger" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "trigger" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nTrigger that executed the action"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Trigger" ,
"text" : "Trigger"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.Presentable" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "Presentable" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nRepresents something that can be displayed to user in UI."
] ,
2021-03-06 02:12:28 +01:00
"signature" : [
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Presentable" ,
"text" : "Presentable"
} ,
"<Context>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.Presentable.id" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "id" ,
"description" : [
"\nID that uniquely identifies this object."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.order" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "order" ,
"description" : [
"\nDetermines the display order in relation to other items. Higher numbers are\ndisplayed first."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.MenuItem" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "MenuItem" ,
"description" : [
"\n`UiComponent` to render when displaying this entity as a context menu item.\nIf not provided, `getDisplayName` will be used instead."
] ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.UiComponent" ,
"text" : "UiComponent"
} ,
"<{ context: Context; }> | undefined"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.getIconType" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getIconType" ,
"description" : [
"\nOptional EUI icon type that can be displayed along with the title."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"(context: Context) => string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Presentable.getIconType.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Context"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.getDisplayName" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getDisplayName" ,
"description" : [
"\nReturns a title to be displayed to the user."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"(context: Context) => string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Presentable.getDisplayName.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Context"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.getDisplayNameTooltip" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"((context: Context) => string) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Presentable.getDisplayNameTooltip.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Context"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.getHref" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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\"."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"((context: Context) => Promise<string | undefined>) | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Presentable.getHref.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Context"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.isCompatible" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"(context: Context) => Promise<boolean>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Presentable.isCompatible.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "context" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Context"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Presentable.grouping" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.PresentableGrouping" ,
"text" : "PresentableGrouping"
} ,
"<Context> | undefined"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
2021-03-06 02:12:28 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.RowClickContext" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "RowClickContext" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.RowClickContext.embeddable" ,
"type" : "Unknown" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "embeddable" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"unknown"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.RowClickContext.data" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "data" ,
"description" : [ ] ,
"signature" : [
"{ rowIndex: number; table: " ,
{
"pluginId" : "expressions" ,
"scope" : "common" ,
"docId" : "kibExpressionsPluginApi" ,
"section" : "def-common.Datatable" ,
"text" : "Datatable"
} ,
"; columns?: string[] | undefined; }"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
}
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Trigger" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Trigger.id" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
"\nUnique name of the trigger as identified in `ui_actions` plugin trigger registry."
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Trigger.title" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "title" ,
"description" : [
"\nUser friendly name of the trigger."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Trigger.description" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "description" ,
"description" : [
"\nA longer user friendly description of the trigger."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.UiActionsServiceParams" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "UiActionsServiceParams" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.UiActionsServiceParams.triggers" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "triggers" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"TriggerRegistry" ,
" | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.UiActionsServiceParams.actions" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "actions" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"ActionRegistry" ,
" | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.UiActionsServiceParams.triggerToActions" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "triggerToActions" ,
"description" : [
"\nA 1-to-N mapping from `Trigger` to zero or more `Action`."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"TriggerToActionsRegistry" ,
" | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/service/ui_actions_service.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.VisualizeFieldContext" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "VisualizeFieldContext" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.VisualizeFieldContext.fieldName" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "fieldName" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.VisualizeFieldContext.indexPatternId" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "indexPatternId" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.VisualizeFieldContext.contextualFields" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "contextualFields" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[] | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ACTION_VISUALIZE_FIELD" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ACTION_VISUALIZE_FIELD" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"ACTION_VISUALIZE_FIELD\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ACTION_VISUALIZE_GEO_FIELD" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ACTION_VISUALIZE_GEO_FIELD" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"ACTION_VISUALIZE_GEO_FIELD\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ACTION_VISUALIZE_LENS_FIELD" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ACTION_VISUALIZE_LENS_FIELD" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"ACTION_VISUALIZE_LENS_FIELD\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ActionExecutionContext" ,
"type" : "Type" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "ActionExecutionContext" ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nAction methods are executed with Context from trigger + {@link ActionExecutionMeta}"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"Context & " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionMeta" ,
"text" : "ActionExecutionMeta"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/actions/action.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.PresentableGrouping" ,
"type" : "Type" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "PresentableGrouping" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"PresentableGroup" ,
"<Context>[]"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/util/presentable.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.ROW_CLICK_TRIGGER" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ROW_CLICK_TRIGGER" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"ROW_CLICK_TRIGGER\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.VISUALIZE_FIELD_TRIGGER" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "VISUALIZE_FIELD_TRIGGER" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"VISUALIZE_FIELD_TRIGGER\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.VISUALIZE_GEO_FIELD_TRIGGER" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "VISUALIZE_GEO_FIELD_TRIGGER" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"VISUALIZE_GEO_FIELD_TRIGGER\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.rowClickTrigger" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "rowClickTrigger" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.rowClickTrigger.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.rowClickTrigger.title" ,
2021-06-07 23:55:35 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "title" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.rowClickTrigger.description" ,
2021-06-07 23:55:35 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "description" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/row_click_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeFieldTrigger" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "visualizeFieldTrigger" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeFieldTrigger.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeFieldTrigger.title" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "title" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeFieldTrigger.description" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "description" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeGeoFieldTrigger" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "visualizeGeoFieldTrigger" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeGeoFieldTrigger.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeGeoFieldTrigger.title" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "title" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.visualizeGeoFieldTrigger.description" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "description" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/triggers/visualize_geo_field_trigger.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsSetup" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "UiActionsSetup" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
"{ readonly addTriggerAction: (triggerId: string, action: " ,
2021-06-07 23:55:35 +02:00
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>>(definition: A) => " ,
2021-03-03 04:02:17 +01:00
{
"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; }"
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "uiActions" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UiActionsStart" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "UiActionsStart" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
2021-09-28 19:17:12 +02:00
"{ readonly clear: () => void; readonly addTriggerAction: (triggerId: string, action: " ,
2021-06-07 23:55:35 +02:00
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<object>>(definition: A) => " ,
2021-03-03 04:02:17 +01:00
{
"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) => " ,
2021-06-07 23:55:35 +02:00
"TriggerContract" ,
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: <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"
} ,
"<" ,
"ActionContext" ,
"<T>>; 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"
} ,
2021-09-28 19:17:12 +02:00
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly fork: () => " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsService" ,
"text" : "UiActionsService"
} ,
"; }"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "src/plugins/ui_actions/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}