kibana/api_docs/event_annotation.devdocs.json

3274 lines
No EOL
132 KiB
JSON

{
"id": "eventAnnotation",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType",
"type": "Interface",
"tags": [],
"label": "EventAnnotationServiceType",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.loadAnnotationGroup",
"type": "Function",
"tags": [],
"label": "loadAnnotationGroup",
"description": [],
"signature": [
"(savedObjectId: string) => Promise<",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
},
">"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.loadAnnotationGroup.$1",
"type": "string",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.groupExistsWithTitle",
"type": "Function",
"tags": [],
"label": "groupExistsWithTitle",
"description": [],
"signature": [
"(title: string) => Promise<boolean>"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.groupExistsWithTitle.$1",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent",
"type": "Function",
"tags": [],
"label": "findAnnotationGroupContent",
"description": [],
"signature": [
"(searchTerm: string, pageSize: number, tagsToInclude?: string[] | undefined, tagsToExclude?: string[] | undefined) => Promise<{ total: number; hits: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupContent",
"text": "EventAnnotationGroupContent"
},
"[]; }>"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$1",
"type": "string",
"tags": [],
"label": "searchTerm",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$2",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$3",
"type": "Array",
"tags": [],
"label": "tagsToInclude",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$4",
"type": "Array",
"tags": [],
"label": "tagsToExclude",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups",
"type": "Function",
"tags": [],
"label": "deleteAnnotationGroups",
"description": [],
"signature": [
"(ids: string[]) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups.$1",
"type": "Array",
"tags": [],
"label": "ids",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.createAnnotationGroup",
"type": "Function",
"tags": [],
"label": "createAnnotationGroup",
"description": [],
"signature": [
"(group: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
},
") => Promise<{ id: string; }>"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.createAnnotationGroup.$1",
"type": "Object",
"tags": [],
"label": "group",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
}
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.updateAnnotationGroup",
"type": "Function",
"tags": [],
"label": "updateAnnotationGroup",
"description": [],
"signature": [
"(group: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
},
", savedObjectId: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.updateAnnotationGroup.$1",
"type": "Object",
"tags": [],
"label": "group",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
}
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.updateAnnotationGroup.$2",
"type": "string",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toExpression",
"type": "Function",
"tags": [],
"label": "toExpression",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
"[]) => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toExpression.$1",
"type": "Array",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toFetchExpression",
"type": "Function",
"tags": [],
"label": "toFetchExpression",
"description": [],
"signature": [
"(props: { interval: string; groups: Pick<",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
},
", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]; }) => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toFetchExpression.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toFetchExpression.$1.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.toFetchExpression.$1.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig"
},
", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder",
"type": "Function",
"tags": [],
"label": "renderEventAnnotationGroupSavedObjectFinder",
"description": [],
"signature": [
"(props: { fixedPageSize?: number | undefined; onChoose: (value: { id: string; type: string; fullName: string; savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">; }) => void; onCreateNew: () => void; }) => JSX.Element"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.fixedPageSize",
"type": "number",
"tags": [],
"label": "fixedPageSize",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose",
"type": "Function",
"tags": [],
"label": "onChoose",
"description": [],
"signature": [
"(value: { id: string; type: string; fullName: string; savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">; }) => void"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.fullName",
"type": "string",
"tags": [],
"label": "fullName",
"description": [],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.savedObject",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.SOWithMetadata",
"text": "SOWithMetadata"
},
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onCreateNew",
"type": "Function",
"tags": [],
"label": "onCreateNew",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationPluginSetup",
"type": "Type",
"tags": [],
"label": "EventAnnotationPluginSetup",
"description": [],
"signature": [
"void"
],
"path": "src/platform/plugins/private/event_annotation/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService",
"type": "Class",
"tags": [],
"label": "EventAnnotationService",
"description": [],
"path": "src/platform/plugins/private/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/plugins/private/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreStart"
],
"path": "src/platform/plugins/private/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "contentManagement",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "public",
"docId": "kibContentManagementPluginApi",
"section": "def-public.ContentManagementPublicStart",
"text": "ContentManagementPublicStart"
}
],
"path": "src/platform/plugins/private/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/event-annotation-components",
"scope": "public",
"docId": "kibKbnEventAnnotationComponentsPluginApi",
"section": "def-public.EventAnnotationServiceType",
"text": "EventAnnotationServiceType"
},
">"
],
"path": "src/platform/plugins/private/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.eventAnnotationGroup",
"type": "Function",
"tags": [],
"label": "eventAnnotationGroup",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"event_annotation_group\", null, ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.EventAnnotationGroupArgs",
"text": "EventAnnotationGroupArgs"
},
", ",
"EventAnnotationGroupOutput",
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
">>"
],
"path": "src/platform/plugins/private/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupArgs",
"type": "Interface",
"tags": [],
"label": "EventAnnotationGroupArgs",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupArgs.annotations",
"type": "Array",
"tags": [],
"label": "annotations",
"description": [],
"signature": [
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.EventAnnotationOutput",
"text": "EventAnnotationOutput"
},
"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupArgs.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPatternExpressionType",
"text": "IndexPatternExpressionType"
}
],
"path": "src/platform/plugins/private/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupArgs.ignoreGlobalFilters",
"type": "boolean",
"tags": [],
"label": "ignoreGlobalFilters",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes",
"type": "Interface",
"tags": [],
"label": "EventAnnotationGroupSavedObjectAttributes",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes.ignoreGlobalFilters",
"type": "boolean",
"tags": [],
"label": "ignoreGlobalFilters",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes.annotations",
"type": "Array",
"tags": [],
"label": "annotations",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSavedObjectAttributes.dataViewSpec",
"type": "CompoundType",
"tags": [],
"label": "dataViewSpec",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
" | null"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs",
"type": "Interface",
"tags": [],
"label": "FetchEventAnnotationsArgs",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/fetch_event_annotations/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
"EventAnnotationGroupOutput",
"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/fetch_event_annotations/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/fetch_event_annotations/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ANNOTATIONS_LISTING_VIEW_ID",
"type": "string",
"tags": [],
"label": "ANNOTATIONS_LISTING_VIEW_ID",
"description": [],
"signature": [
"\"annotations\""
],
"path": "src/platform/plugins/private/event_annotation/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.CONTENT_ID",
"type": "string",
"tags": [],
"label": "CONTENT_ID",
"description": [],
"signature": [
"\"event-annotation-group\""
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupCreateIn",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupCreateIn",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.CreateIn",
"text": "CreateIn"
},
"<\"event-annotation-group\", ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.EventAnnotationGroupSavedObjectAttributes",
"text": "EventAnnotationGroupSavedObjectAttributes"
},
", ",
"CreateOptions",
">"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupCreateOut",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupCreateOut",
"description": [],
"signature": [
"{ item: ",
"EventAnnotationGroupSavedObject",
"; meta?: undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupCrudTypes",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupCrudTypes",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.ContentManagementCrudTypes",
"text": "ContentManagementCrudTypes"
},
"<\"event-annotation-group\", ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.EventAnnotationGroupSavedObjectAttributes",
"text": "EventAnnotationGroupSavedObjectAttributes"
},
", ",
"CreateOptions",
", ",
"UpdateOptions",
", {}>"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupDeleteIn",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupDeleteIn",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.DeleteIn",
"text": "DeleteIn"
},
"<\"event-annotation-group\", object>"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupDeleteOut",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupDeleteOut",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.DeleteResult",
"text": "DeleteResult"
}
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupGetIn",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupGetIn",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.GetIn",
"text": "GetIn"
},
"<\"event-annotation-group\", object>"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupGetOut",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupGetOut",
"description": [],
"signature": [
"{ item: ",
"EventAnnotationGroupSavedObject",
"; meta: { outcome: \"exactMatch\" | \"aliasMatch\" | \"conflict\"; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; }; }"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSearchIn",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupSearchIn",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<\"event-annotation-group\", ",
"EventAnnotationGroupSearchQuery",
">"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupSearchOut",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupSearchOut",
"description": [],
"signature": [
"{ hits: ",
"EventAnnotationGroupSavedObject",
"[]; pagination: { total: number; cursor?: string | undefined; }; }"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupUpdateIn",
"type": "Type",
"tags": [],
"label": "EventAnnotationGroupUpdateIn",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.UpdateIn",
"text": "UpdateIn"
},
"<\"event-annotation-group\", ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.EventAnnotationGroupSavedObjectAttributes",
"text": "EventAnnotationGroupSavedObjectAttributes"
},
", ",
"UpdateOptions",
">"
],
"path": "src/platform/plugins/private/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationOutput",
"type": "Type",
"tags": [],
"label": "EventAnnotationOutput",
"description": [],
"signature": [
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.QueryPointEventAnnotationOutput",
"text": "QueryPointEventAnnotationOutput"
},
" | ",
"ManualEventAnnotationOutput"
],
"path": "src/platform/plugins/private/event_annotation/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ManualPointEventAnnotationArgs",
"type": "Type",
"tags": [],
"label": "ManualPointEventAnnotationArgs",
"description": [],
"signature": [
"{ id: string; time: string; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ManualPointEventAnnotationOutput",
"type": "Type",
"tags": [],
"label": "ManualPointEventAnnotationOutput",
"description": [],
"signature": [
"{ id: string; time: string; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; } & { type: \"manual_point_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ManualRangeEventAnnotationArgs",
"type": "Type",
"tags": [],
"label": "ManualRangeEventAnnotationArgs",
"description": [],
"signature": [
"{ id: string; time: string; endTime: string; } & StyleSharedProps & { outside?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ManualRangeEventAnnotationOutput",
"type": "Type",
"tags": [],
"label": "ManualRangeEventAnnotationOutput",
"description": [],
"signature": [
"{ id: string; time: string; endTime: string; } & StyleSharedProps & { outside?: boolean | undefined; } & { type: \"manual_range_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.ManualRangeEventAnnotationRow",
"type": "Type",
"tags": [],
"label": "ManualRangeEventAnnotationRow",
"description": [],
"signature": [
"{ id: string; time: string; endTime: string; type: \"range\"; } & StyleSharedProps & { outside?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.PointEventAnnotationRow",
"type": "Type",
"tags": [],
"label": "PointEventAnnotationRow",
"description": [],
"signature": [
"{ id: string; time: string; type: \"point\"; timebucket: string; skippedCount?: number | undefined; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; } & Record<string, any>"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.QueryPointEventAnnotationArgs",
"type": "Type",
"tags": [],
"label": "QueryPointEventAnnotationArgs",
"description": [],
"signature": [
"{ id: string; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.KibanaQueryOutput",
"text": "KibanaQueryOutput"
},
"; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.QueryPointEventAnnotationOutput",
"type": "Type",
"tags": [],
"label": "QueryPointEventAnnotationOutput",
"description": [],
"signature": [
"{ id: string; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.KibanaQueryOutput",
"text": "KibanaQueryOutput"
},
"; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; } & { type: \"query_point_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation",
"type": "Object",
"tags": [],
"label": "manualPointEventAnnotation",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"manual_point_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.aliases",
"type": "Array",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"never[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"manual_point_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.inputTypes",
"type": "Array",
"tags": [],
"label": "inputTypes",
"description": [],
"signature": [
"\"null\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id",
"type": "Object",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id.required",
"type": "boolean",
"tags": [],
"label": "required",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.time",
"type": "Object",
"tags": [],
"label": "time",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.time.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.time.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.label",
"type": "Object",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.label.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.label.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.color",
"type": "Object",
"tags": [],
"label": "color",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.color.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.color.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle",
"type": "Object",
"tags": [],
"label": "lineStyle",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"(\"dashed\" | \"solid\" | \"dotted\")[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineWidth",
"type": "Object",
"tags": [],
"label": "lineWidth",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineWidth.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"number\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineWidth.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon",
"type": "Object",
"tags": [],
"label": "icon",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"(\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\")[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.strict",
"type": "boolean",
"tags": [],
"label": "strict",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.textVisibility",
"type": "Object",
"tags": [],
"label": "textVisibility",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.textVisibility.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.textVisibility.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.isHidden",
"type": "Object",
"tags": [],
"label": "isHidden",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.isHidden.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.isHidden.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.fn",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(input: unknown, args: ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.ManualPointEventAnnotationArgs",
"text": "ManualPointEventAnnotationArgs"
},
") => { id: string; time: string; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; type: \"manual_point_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.fn.$1",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.fn.$2",
"type": "CompoundType",
"tags": [],
"label": "args",
"description": [],
"signature": [
"{ id: string; time: string; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation",
"type": "Object",
"tags": [],
"label": "manualRangeEventAnnotation",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"manual_range_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.aliases",
"type": "Array",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"never[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"manual_range_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.inputTypes",
"type": "Array",
"tags": [],
"label": "inputTypes",
"description": [],
"signature": [
"\"null\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id",
"type": "Object",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id.required",
"type": "boolean",
"tags": [],
"label": "required",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.time",
"type": "Object",
"tags": [],
"label": "time",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.time.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.time.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime",
"type": "Object",
"tags": [],
"label": "endTime",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime.required",
"type": "boolean",
"tags": [],
"label": "required",
"description": [],
"signature": [
"false"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.outside",
"type": "Object",
"tags": [],
"label": "outside",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.outside.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.outside.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.outside.required",
"type": "boolean",
"tags": [],
"label": "required",
"description": [],
"signature": [
"false"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.label",
"type": "Object",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.label.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.label.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.color",
"type": "Object",
"tags": [],
"label": "color",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.color.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.color.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.isHidden",
"type": "Object",
"tags": [],
"label": "isHidden",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.isHidden.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.isHidden.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.fn",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(input: unknown, args: ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.ManualRangeEventAnnotationArgs",
"text": "ManualRangeEventAnnotationArgs"
},
") => { id: string; time: string; endTime: string; label: string; color?: string | undefined; isHidden?: boolean | undefined; outside?: boolean | undefined; type: \"manual_range_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.fn.$1",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.fn.$2",
"type": "CompoundType",
"tags": [],
"label": "args",
"description": [],
"signature": [
"{ id: string; time: string; endTime: string; } & StyleSharedProps & { outside?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation",
"type": "Object",
"tags": [],
"label": "queryPointEventAnnotation",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"query_point_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.aliases",
"type": "Array",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"never[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"query_point_event_annotation\""
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.inputTypes",
"type": "Array",
"tags": [],
"label": "inputTypes",
"description": [],
"signature": [
"\"null\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id",
"type": "Object",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id.required",
"type": "boolean",
"tags": [],
"label": "required",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.filter.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"kibana_query\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.filter.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields",
"type": "Object",
"tags": [],
"label": "extraFields",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields.multi",
"type": "boolean",
"tags": [],
"label": "multi",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.timeField",
"type": "Object",
"tags": [],
"label": "timeField",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.timeField.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.timeField.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.label",
"type": "Object",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.label.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.label.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.color",
"type": "Object",
"tags": [],
"label": "color",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.color.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.color.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle",
"type": "Object",
"tags": [],
"label": "lineStyle",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"(\"dashed\" | \"solid\" | \"dotted\")[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineWidth",
"type": "Object",
"tags": [],
"label": "lineWidth",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineWidth.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"number\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineWidth.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon",
"type": "Object",
"tags": [],
"label": "icon",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"(\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\")[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.strict",
"type": "boolean",
"tags": [],
"label": "strict",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textVisibility",
"type": "Object",
"tags": [],
"label": "textVisibility",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textVisibility.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textVisibility.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textField",
"type": "Object",
"tags": [],
"label": "textField",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textField.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"string\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textField.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.isHidden",
"type": "Object",
"tags": [],
"label": "isHidden",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.isHidden.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [],
"signature": [
"\"boolean\"[]"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.isHidden.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.fn",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(input: unknown, args: ",
{
"pluginId": "eventAnnotation",
"scope": "common",
"docId": "kibEventAnnotationPluginApi",
"section": "def-common.QueryPointEventAnnotationArgs",
"text": "QueryPointEventAnnotationArgs"
},
") => { id: string; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.KibanaQueryOutput",
"text": "KibanaQueryOutput"
},
"; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; type: \"query_point_event_annotation\"; }"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.fn.$1",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.fn.$2",
"type": "CompoundType",
"tags": [],
"label": "args",
"description": [],
"signature": [
"{ id: string; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.KibanaQueryOutput",
"text": "KibanaQueryOutput"
},
"; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
" | undefined; lineWidth?: number | undefined; lineStyle?: ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.LineStyle",
"text": "LineStyle"
},
" | undefined; textVisibility?: boolean | undefined; }"
],
"path": "src/platform/plugins/private/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
}
}