kibana/api_docs/kbn_event_annotation_components.devdocs.json

1074 lines
No EOL
41 KiB
JSON

{
"id": "@kbn/event-annotation-components",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.AnnotationEditorControls",
"type": "Function",
"tags": [],
"label": "AnnotationEditorControls",
"description": [],
"signature": [
"(props: ",
"Props",
") => JSX.Element"
],
"path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.AnnotationEditorControls.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.createCopiedAnnotation",
"type": "Function",
"tags": [],
"label": "createCopiedAnnotation",
"description": [],
"signature": [
"(newId: string, timestamp: string, source?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined) => ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
}
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.createCopiedAnnotation.$1",
"type": "string",
"tags": [],
"label": "newId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.createCopiedAnnotation.$2",
"type": "string",
"tags": [],
"label": "timestamp",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.createCopiedAnnotation.$3",
"type": "CompoundType",
"tags": [],
"label": "source",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.getAnnotationAccessor",
"type": "Function",
"tags": [],
"label": "getAnnotationAccessor",
"description": [],
"signature": [
"(annotation: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
") => ",
{
"pluginId": "@kbn/visualization-ui-components",
"scope": "public",
"docId": "kibKbnVisualizationUiComponentsPluginApi",
"section": "def-public.AccessorConfig",
"text": "AccessorConfig"
}
],
"path": "packages/kbn-event-annotation-components/components/get_annotation_accessor.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.getAnnotationAccessor.$1",
"type": "CompoundType",
"tags": [],
"label": "annotation",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
}
],
"path": "packages/kbn-event-annotation-components/components/get_annotation_accessor.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isManualPointAnnotationConfig",
"type": "Function",
"tags": [],
"label": "isManualPointAnnotationConfig",
"description": [],
"signature": [
"(annotation?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined) => annotation is ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.PointInTimeEventAnnotationConfig",
"text": "PointInTimeEventAnnotationConfig"
}
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isManualPointAnnotationConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "annotation",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isQueryAnnotationConfig",
"type": "Function",
"tags": [],
"label": "isQueryAnnotationConfig",
"description": [],
"signature": [
"(annotation?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined) => annotation is ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.QueryPointEventAnnotationConfig",
"text": "QueryPointEventAnnotationConfig"
}
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isQueryAnnotationConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "annotation",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isRangeAnnotationConfig",
"type": "Function",
"tags": [],
"label": "isRangeAnnotationConfig",
"description": [],
"signature": [
"(annotation?: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined) => annotation is ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.RangeEventAnnotationConfig",
"text": "RangeEventAnnotationConfig"
}
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.isRangeAnnotationConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "annotation",
"description": [],
"signature": [
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.EventAnnotationConfig",
"text": "EventAnnotationConfig"
},
" | undefined"
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType",
"type": "Interface",
"tags": [],
"label": "EventAnnotationServiceType",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.loadAnnotationGroup.$1",
"type": "string",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.groupExistsWithTitle",
"type": "Function",
"tags": [],
"label": "groupExistsWithTitle",
"description": [],
"signature": [
"(title: string) => Promise<boolean>"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.groupExistsWithTitle.$1",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$1",
"type": "string",
"tags": [],
"label": "searchTerm",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$2",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$3",
"type": "Array",
"tags": [],
"label": "tagsToInclude",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$4",
"type": "Array",
"tags": [],
"label": "tagsToExclude",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups",
"type": "Function",
"tags": [],
"label": "deleteAnnotationGroups",
"description": [],
"signature": [
"(ids: string[]) => Promise<void>"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups.$1",
"type": "Array",
"tags": [],
"label": "ids",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.updateAnnotationGroup.$2",
"type": "string",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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"
},
", \"ignoreGlobalFilters\" | \"annotations\" | \"indexPatternId\">[]; }) => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"[]"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.toFetchExpression.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.toFetchExpression.$1.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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"
},
", \"ignoreGlobalFilters\" | \"annotations\" | \"indexPatternId\">[]"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.fixedPageSize",
"type": "number",
"tags": [],
"label": "fixedPageSize",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"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": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.fullName",
"type": "string",
"tags": [],
"label": "fullName",
"description": [],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.savedObject",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "common",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-common.SOWithMetadata",
"text": "SOWithMetadata"
},
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onCreateNew",
"type": "Function",
"tags": [],
"label": "onCreateNew",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.annotationsIconSet",
"type": "Array",
"tags": [],
"label": "annotationsIconSet",
"description": [],
"signature": [
"{ value: ",
{
"pluginId": "@kbn/event-annotation-common",
"scope": "common",
"docId": "kibKbnEventAnnotationCommonPluginApi",
"section": "def-common.AvailableAnnotationIcon",
"text": "AvailableAnnotationIcon"
},
"; label: string; icon?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; shouldRotate?: boolean | undefined; }[]"
],
"path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/icon_set.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.defaultAnnotationColor",
"type": "string",
"tags": [],
"label": "defaultAnnotationColor",
"description": [],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.defaultAnnotationLabel",
"type": "string",
"tags": [],
"label": "defaultAnnotationLabel",
"description": [],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.defaultAnnotationRangeColor",
"type": "string",
"tags": [],
"label": "defaultAnnotationRangeColor",
"description": [],
"signature": [
"\"#F04E981A\""
],
"path": "packages/kbn-event-annotation-common/util.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/event-annotation-components",
"id": "def-public.EVENT_ANNOTATION_APP_NAME",
"type": "string",
"tags": [],
"label": "EVENT_ANNOTATION_APP_NAME",
"description": [],
"signature": [
"\"event-annotations\""
],
"path": "packages/kbn-event-annotation-components/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}