* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
3124 lines
120 KiB
JSON
3124 lines
120 KiB
JSON
{
|
|
"id": "savedObjects",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.SavedObjectSaveModal",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SavedObjectSaveModal",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectSaveModal",
|
|
"text": "SavedObjectSaveModal"
|
|
},
|
|
" extends React.Component<Props, ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SaveModalState",
|
|
"text": "SaveModalState"
|
|
},
|
|
", any>"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.SavedObjectSaveModal.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L72"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.copyOnSave",
|
|
"type": "boolean",
|
|
"label": "copyOnSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 73,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L73"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.isTitleDuplicateConfirmed",
|
|
"type": "boolean",
|
|
"label": "isTitleDuplicateConfirmed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L74"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.hasTitleDuplicate",
|
|
"type": "boolean",
|
|
"label": "hasTitleDuplicate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 75,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L75"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.isLoading",
|
|
"type": "boolean",
|
|
"label": "isLoading",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 76,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L76"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveModal.state.visualizationDescription",
|
|
"type": "string",
|
|
"label": "visualizationDescription",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 77,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L77"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "state",
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L71"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectSaveModal.render",
|
|
"type": "Function",
|
|
"label": "render",
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 80,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L80"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 69,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L69"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SavedObjectFinderUi",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectFinderUi",
|
|
"text": "SavedObjectFinderUi"
|
|
},
|
|
" extends React.Component<",
|
|
"SavedObjectFinderUiProps",
|
|
", SavedObjectFinderState, any>"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi.propTypes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose",
|
|
"type": "Function",
|
|
"label": "onChoose",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 108,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L108"
|
|
},
|
|
"signature": [
|
|
"Requireable",
|
|
"<(...args: any[]) => any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage",
|
|
"type": "Function",
|
|
"label": "noItemsMessage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 109,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L109"
|
|
},
|
|
"signature": [
|
|
"Requireable",
|
|
"<",
|
|
"ReactNodeLike",
|
|
">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData",
|
|
"type": "Function",
|
|
"label": "savedObjectMetaData",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 110,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L110"
|
|
},
|
|
"signature": [
|
|
"Validator",
|
|
"<any[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize",
|
|
"type": "Function",
|
|
"label": "initialPageSize",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 111,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L111"
|
|
},
|
|
"signature": [
|
|
"Requireable",
|
|
"<number>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize",
|
|
"type": "Function",
|
|
"label": "fixedPageSize",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 112,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L112"
|
|
},
|
|
"signature": [
|
|
"Requireable",
|
|
"<number>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter",
|
|
"type": "Function",
|
|
"label": "showFilter",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 113,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L113"
|
|
},
|
|
"signature": [
|
|
"Requireable",
|
|
"<boolean>"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "propTypes",
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 107,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L107"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "props",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectFinderUiProps",
|
|
"text": "SavedObjectFinderUiProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 173,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L173"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 173,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L173"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi.componentWillUnmount",
|
|
"type": "Function",
|
|
"label": "componentWillUnmount",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 188,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L188"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi.componentDidMount",
|
|
"type": "Function",
|
|
"label": "componentDidMount",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 193,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L193"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectFinderUi.render",
|
|
"type": "Function",
|
|
"label": "render",
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 198,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L198"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 103,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L103"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SavedObjectLoader",
|
|
"description": [
|
|
"\nThe SavedObjectLoader class provides some convenience functions\nto load and save one kind of saved objects (specified in the constructor).\n\nIt is based on the SavedObjectClient which implements loading and saving\nin an abstract, type-agnostic way. If possible, use SavedObjectClient directly\nto avoid pulling in extra functionality which isn't used."
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.lowercaseType",
|
|
"type": "string",
|
|
"label": "lowercaseType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.loaderProperties",
|
|
"type": "Object",
|
|
"label": "loaderProperties",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L36"
|
|
},
|
|
"signature": [
|
|
"Record<string, string>"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Any",
|
|
"label": "SavedObjectClass",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L39"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObjectsClient",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L40"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L38"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.get",
|
|
"type": "Function",
|
|
"label": "get",
|
|
"signature": [
|
|
"(opts?: string | Record<string, unknown> | undefined) => Promise<any>"
|
|
],
|
|
"description": [
|
|
"\nRetrieve a saved object by id or create new one.\nReturns a promise that completes when the object finishes\ninitializing."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "opts",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | Record<string, unknown> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L60"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L60"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.urlFor",
|
|
"type": "Function",
|
|
"label": "urlFor",
|
|
"signature": [
|
|
"(id: string) => string"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 68,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L68"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 68,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L68"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.delete",
|
|
"type": "Function",
|
|
"label": "delete",
|
|
"signature": [
|
|
"(ids: string | string[]) => Promise<void>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "ids",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L72"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L72"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.mapHitSource",
|
|
"type": "Function",
|
|
"label": "mapHitSource",
|
|
"signature": [
|
|
"(source: Record<string, unknown>, id: string, references?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]) => Record<string, unknown>"
|
|
],
|
|
"description": [
|
|
"\nUpdates source to contain an id, url and references fields, and returns the updated\nsource object."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "source",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 92,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L92"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"type": "Array",
|
|
"label": "references",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 94,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L94"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [
|
|
"The modified source object, with an id and url field."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L91"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.mapSavedObjectApiHits",
|
|
"type": "Function",
|
|
"label": "mapSavedObjectApiHits",
|
|
"signature": [
|
|
"({ attributes, id, references, }: { attributes: Record<string, unknown>; id: string; references?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[] | undefined; }) => Record<string, unknown>"
|
|
],
|
|
"description": [
|
|
"\nUpdates hit.attributes to contain an id and url field, and returns the updated\nattributes object."
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }",
|
|
"type": "Object",
|
|
"label": "{\n attributes,\n id,\n references = [],\n }",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.attributes",
|
|
"type": "Object",
|
|
"label": "attributes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 113,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L113"
|
|
},
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 114,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L114"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.references",
|
|
"type": "Array",
|
|
"label": "references",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 115,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L115"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[] | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 112,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L112"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [
|
|
"The modified hit.attributes object, with an id and url field."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 108,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L108"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoader.find",
|
|
"type": "Function",
|
|
"label": "find",
|
|
"signature": [
|
|
"(search?: string, sizeOrOptions?: number | ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoaderFindOptions",
|
|
"text": "SavedObjectLoaderFindOptions"
|
|
},
|
|
") => Promise<{ total: number; hits: Record<string, unknown>[]; }>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "search",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 152,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L152"
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "sizeOrOptions",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"number | ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoaderFindOptions",
|
|
"text": "SavedObjectLoaderFindOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 152,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L152"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 152,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L152"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L32"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.SavedObjectSaveModalOrigin",
|
|
"type": "Function",
|
|
"label": "SavedObjectSaveModalOrigin",
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.OriginSaveModalProps",
|
|
"text": "OriginSaveModalProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "props",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.OriginSaveModalProps",
|
|
"text": "OriginSaveModalProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L34"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L34"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.showSaveModal",
|
|
"type": "Function",
|
|
"label": "showSaveModal",
|
|
"signature": [
|
|
"(saveModal: React.ReactElement<MinimalSaveModalProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element, Wrapper: React.FC<{}> | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "saveModal",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"React.ReactElement<MinimalSaveModalProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx#L33"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "I18nContext",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"({ children }: { children: React.ReactNode; }) => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx#L34"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "Wrapper",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"React.FC<{}> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx#L35"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx#L32"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getSavedObjectFinder",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsStart",
|
|
"text": "SavedObjectsStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 526,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L526"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "uiSettings",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 526,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L526"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(savedObject: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsStart",
|
|
"text": "SavedObjectsStart"
|
|
},
|
|
", uiSettings: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
") => (props: ",
|
|
"SavedObjectFinderProps",
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"label": "getSavedObjectFinder",
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 526,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L526"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.checkForDuplicateTitle",
|
|
"type": "Function",
|
|
"label": "checkForDuplicateTitle",
|
|
"signature": [
|
|
"(savedObject: Pick<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
", \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">, isTitleDuplicateConfirmed: boolean, onTitleDuplicate: (() => void) | undefined, services: Pick<",
|
|
"SavedObjectKibanaServices",
|
|
", \"savedObjectsClient\" | \"overlays\">) => Promise<true>"
|
|
],
|
|
"description": [
|
|
"\ncheck for an existing SavedObject with the same title in ES\nreturns Promise<true> when it's no duplicate, or the modal displaying the warning\nthat's there's a duplicate is confirmed, else it returns a rejected Promise<ErrorMsg>"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
", \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts#L24"
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "isTitleDuplicateConfirmed",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts#L28"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "onTitleDuplicate",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts#L29"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "services",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectKibanaServices",
|
|
"text": "SavedObjectKibanaServices"
|
|
},
|
|
", \"savedObjectsClient\" | \"overlays\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts#L23"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.saveWithConfirmation",
|
|
"type": "Function",
|
|
"label": "saveWithConfirmation",
|
|
"signature": [
|
|
"(source: ",
|
|
"SavedObjectAttributes",
|
|
", savedObject: { getEsType(): string; title: string; displayName: string; }, options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
", services: { savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">; overlays: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
},
|
|
"; }) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
}
|
|
],
|
|
"description": [
|
|
"\nAttempts to create the current object using the serialized source. If an object already\nexists, a warning message requests an overwrite confirmation."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "source",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"description": [
|
|
"- serialized version of this object what will be indexed into elasticsearch."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.saveWithConfirmation.savedObject",
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.saveWithConfirmation.savedObject.getEsType",
|
|
"type": "Function",
|
|
"label": "getEsType",
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L36"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.saveWithConfirmation.savedObject.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.saveWithConfirmation.savedObject.displayName",
|
|
"type": "string",
|
|
"label": "displayName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L38"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
}
|
|
],
|
|
"description": [
|
|
"- options to pass to the saved object create method"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L40"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.saveWithConfirmation.services",
|
|
"type": "Object",
|
|
"label": "services",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.saveWithConfirmation.services.savedObjectsClient",
|
|
"type": "Object",
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L41"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.saveWithConfirmation.services.overlays",
|
|
"type": "Object",
|
|
"label": "overlays",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L41"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L41"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"resolved"
|
|
],
|
|
"returnComment": [
|
|
"- A promise that is resolved with the objects id if the object is\nsuccessfully indexed. If the overwrite confirmation was rejected, an error is thrown with\na confirmRejected = true parameter so that case can be handled differently than\na create or index error."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#L33"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.isErrorNonFatal",
|
|
"type": "Function",
|
|
"label": "isErrorNonFatal",
|
|
"signature": [
|
|
"(error: { message: string; }) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.isErrorNonFatal.error",
|
|
"type": "Object",
|
|
"label": "error",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.isErrorNonFatal.error.message",
|
|
"type": "string",
|
|
"label": "message",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts#L23"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts#L23"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts#L23"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.OnSaveProps",
|
|
"type": "Interface",
|
|
"label": "OnSaveProps",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OnSaveProps.newTitle",
|
|
"type": "string",
|
|
"label": "newTitle",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L35"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OnSaveProps.newCopyOnSave",
|
|
"type": "boolean",
|
|
"label": "newCopyOnSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L36"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OnSaveProps.isTitleDuplicateConfirmed",
|
|
"type": "boolean",
|
|
"label": "isTitleDuplicateConfirmed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L37"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OnSaveProps.onTitleDuplicate",
|
|
"type": "Function",
|
|
"label": "onTitleDuplicate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L38"
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OnSaveProps.newDescription",
|
|
"type": "string",
|
|
"label": "newDescription",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L39"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L34"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.OriginSaveModalProps",
|
|
"type": "Interface",
|
|
"label": "OriginSaveModalProps",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.originatingApp",
|
|
"type": "string",
|
|
"label": "originatingApp",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L23"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.getAppNameFromId",
|
|
"type": "Function",
|
|
"label": "getAppNameFromId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L24"
|
|
},
|
|
"signature": [
|
|
"((appId: string) => string | undefined) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.originatingAppName",
|
|
"type": "string",
|
|
"label": "originatingAppName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L25"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.returnToOriginSwitchLabel",
|
|
"type": "string",
|
|
"label": "returnToOriginSwitchLabel",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L26"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.documentInfo",
|
|
"type": "Object",
|
|
"label": "documentInfo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L27"
|
|
},
|
|
"signature": [
|
|
"SaveModalDocumentInfo"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.objectType",
|
|
"type": "string",
|
|
"label": "objectType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L28"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.onClose",
|
|
"type": "Function",
|
|
"label": "onClose",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L29"
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.options",
|
|
"type": "CompoundType",
|
|
"label": "options",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L30"
|
|
},
|
|
"signature": [
|
|
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | ((state: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SaveModalState",
|
|
"text": "SaveModalState"
|
|
},
|
|
") => React.ReactNode) | null | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OriginSaveModalProps.onSave",
|
|
"type": "Function",
|
|
"label": "onSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L31"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.OnSaveProps",
|
|
"text": "OnSaveProps"
|
|
},
|
|
" & { returnToOrigin: boolean; }) => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx#L22"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SaveModalState",
|
|
"type": "Interface",
|
|
"label": "SaveModalState",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 59,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L59"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.copyOnSave",
|
|
"type": "boolean",
|
|
"label": "copyOnSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L60"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.isTitleDuplicateConfirmed",
|
|
"type": "boolean",
|
|
"label": "isTitleDuplicateConfirmed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L61"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.hasTitleDuplicate",
|
|
"type": "boolean",
|
|
"label": "hasTitleDuplicate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 62,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L62"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.isLoading",
|
|
"type": "boolean",
|
|
"label": "isLoading",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 63,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L63"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalState.visualizationDescription",
|
|
"type": "string",
|
|
"label": "visualizationDescription",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 64,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L64"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
|
"lineNumber": 58,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx#L58"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectMetaData",
|
|
"type": "Interface",
|
|
"label": "SavedObjectMetaData",
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectMetaData",
|
|
"text": "SavedObjectMetaData"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectMetaData.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L44"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectMetaData.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 45,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L45"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectMetaData.getIconForSavedObject",
|
|
"type": "Function",
|
|
"label": "getIconForSavedObject",
|
|
"signature": [
|
|
"(savedObject: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>) => ",
|
|
"IconType"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L46"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L46"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectMetaData.getTooltipForSavedObject",
|
|
"type": "Function",
|
|
"label": "getTooltipForSavedObject",
|
|
"signature": [
|
|
"((savedObject: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>) => string) | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L47"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L47"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectMetaData.showSavedObject",
|
|
"type": "Function",
|
|
"label": "showSavedObject",
|
|
"signature": [
|
|
"((savedObject: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>) => boolean) | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SimpleSavedObject",
|
|
"text": "SimpleSavedObject"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L48"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L48"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectMetaData.includeFields",
|
|
"type": "Array",
|
|
"label": "includeFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 49,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L49"
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/finder/saved_object_finder.tsx#L43"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectLoaderFindOptions",
|
|
"type": "Interface",
|
|
"label": "SavedObjectLoaderFindOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoaderFindOptions.size",
|
|
"type": "number",
|
|
"label": "size",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L19"
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoaderFindOptions.fields",
|
|
"type": "Array",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L20"
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectLoaderFindOptions.hasReference",
|
|
"type": "Array",
|
|
"label": "hasReference",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L21"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptionsReference",
|
|
"text": "SavedObjectsFindOptionsReference"
|
|
},
|
|
"[] | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/saved_object_loader.ts#L18"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectDecorator",
|
|
"type": "Interface",
|
|
"label": "SavedObjectDecorator",
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectDecorator",
|
|
"text": "SavedObjectDecorator"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.SavedObjectDecorator.getId",
|
|
"type": "Function",
|
|
"label": "getId",
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"description": [
|
|
"\nId of the decorator"
|
|
],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/types.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectDecorator.decorateConfig",
|
|
"type": "Function",
|
|
"label": "decorateConfig",
|
|
"description": [
|
|
"\nDecorate the saved object provided config. This can be used to enhance or alter the object's provided\nconfiguration."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/types.ts#L21"
|
|
},
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectConfig",
|
|
"text": "SavedObjectConfig"
|
|
},
|
|
") => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [
|
|
"remarks"
|
|
],
|
|
"id": "def-public.SavedObjectDecorator.decorateObject",
|
|
"type": "Function",
|
|
"label": "decorateObject",
|
|
"description": [
|
|
"\nDecorate the saved object instance. Can be used to add additional methods to it.\n"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/types.ts#L28"
|
|
},
|
|
"signature": [
|
|
"(object: T) => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/types.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectDecoratorConfig",
|
|
"type": "Interface",
|
|
"label": "SavedObjectDecoratorConfig",
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectDecoratorConfig",
|
|
"text": "SavedObjectDecoratorConfig"
|
|
},
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectDecoratorConfig.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe id of the decorator"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/registry.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectDecoratorConfig.priority",
|
|
"type": "number",
|
|
"label": "priority",
|
|
"description": [
|
|
"\nHighest priority will be called **last**\n(the decoration will be at the highest level)"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/registry.ts#L22"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectDecoratorConfig.factory",
|
|
"type": "Function",
|
|
"label": "factory",
|
|
"description": [
|
|
"\nThe factory to use to create the decorator"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/registry.ts#L26"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectDecoratorFactory",
|
|
"text": "SavedObjectDecoratorFactory"
|
|
},
|
|
"<T>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/registry.ts#L13"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectSaveOpts",
|
|
"type": "Interface",
|
|
"label": "SavedObjectSaveOpts",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveOpts.confirmOverwrite",
|
|
"type": "CompoundType",
|
|
"label": "confirmOverwrite",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L52"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveOpts.isTitleDuplicateConfirmed",
|
|
"type": "CompoundType",
|
|
"label": "isTitleDuplicateConfirmed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 53,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L53"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveOpts.onTitleDuplicate",
|
|
"type": "Function",
|
|
"label": "onTitleDuplicate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L54"
|
|
},
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSaveOpts.returnToOrigin",
|
|
"type": "CompoundType",
|
|
"label": "returnToOrigin",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L55"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 51,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L51"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObject",
|
|
"type": "Interface",
|
|
"label": "SavedObject",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject._serialize",
|
|
"type": "Function",
|
|
"label": "_serialize",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L25"
|
|
},
|
|
"signature": [
|
|
"() => { attributes: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
},
|
|
"; references: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject._source",
|
|
"type": "Object",
|
|
"label": "_source",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L26"
|
|
},
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.applyESResp",
|
|
"type": "Function",
|
|
"label": "applyESResp",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L27"
|
|
},
|
|
"signature": [
|
|
"(resp: Record<string, any>) => Promise<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.copyOnSave",
|
|
"type": "boolean",
|
|
"label": "copyOnSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L28"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.creationOpts",
|
|
"type": "Function",
|
|
"label": "creationOpts",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L29"
|
|
},
|
|
"signature": [
|
|
"(opts: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectCreationOpts",
|
|
"text": "SavedObjectCreationOpts"
|
|
},
|
|
") => Record<string, unknown>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.defaults",
|
|
"type": "Any",
|
|
"label": "defaults",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L30"
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.delete",
|
|
"type": "Function",
|
|
"label": "delete",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L31"
|
|
},
|
|
"signature": [
|
|
"(() => Promise<{}>) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.destroy",
|
|
"type": "Function",
|
|
"label": "destroy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L32"
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.getDisplayName",
|
|
"type": "Function",
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L33"
|
|
},
|
|
"signature": [
|
|
"() => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.getEsType",
|
|
"type": "Function",
|
|
"label": "getEsType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L34"
|
|
},
|
|
"signature": [
|
|
"() => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.getFullPath",
|
|
"type": "Function",
|
|
"label": "getFullPath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L35"
|
|
},
|
|
"signature": [
|
|
"() => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.hydrateIndexPattern",
|
|
"type": "Function",
|
|
"label": "hydrateIndexPattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L36"
|
|
},
|
|
"signature": [
|
|
"((id?: string | undefined) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
},
|
|
" | null>) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L37"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.init",
|
|
"type": "Function",
|
|
"label": "init",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L38"
|
|
},
|
|
"signature": [
|
|
"(() => Promise<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
">) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.isSaving",
|
|
"type": "boolean",
|
|
"label": "isSaving",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L39"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.isTitleChanged",
|
|
"type": "Function",
|
|
"label": "isTitleChanged",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L40"
|
|
},
|
|
"signature": [
|
|
"() => boolean"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.lastSavedTitle",
|
|
"type": "string",
|
|
"label": "lastSavedTitle",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L41"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.migrationVersion",
|
|
"type": "Object",
|
|
"label": "migrationVersion",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L42"
|
|
},
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.save",
|
|
"type": "Function",
|
|
"label": "save",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L43"
|
|
},
|
|
"signature": [
|
|
"(saveOptions: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectSaveOpts",
|
|
"text": "SavedObjectSaveOpts"
|
|
},
|
|
") => Promise<string>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.searchSource",
|
|
"type": "Object",
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L44"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.searchSourceFields",
|
|
"type": "Object",
|
|
"label": "searchSourceFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 45,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L45"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.showInRecentlyAccessed",
|
|
"type": "boolean",
|
|
"label": "showInRecentlyAccessed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L46"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L47"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObject.unresolvedIndexPatternReference",
|
|
"type": "Object",
|
|
"label": "unresolvedIndexPatternReference",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L48"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
" | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L24"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectConfig",
|
|
"type": "Interface",
|
|
"label": "SavedObjectConfig",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.afterESResp",
|
|
"type": "Function",
|
|
"label": "afterESResp",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L78"
|
|
},
|
|
"signature": [
|
|
"((savedObject: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
">) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.defaults",
|
|
"type": "Any",
|
|
"label": "defaults",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 79,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L79"
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.extractReferences",
|
|
"type": "Function",
|
|
"label": "extractReferences",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 80,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L80"
|
|
},
|
|
"signature": [
|
|
"((opts: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectAttributesAndRefs",
|
|
"text": "SavedObjectAttributesAndRefs"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectAttributesAndRefs",
|
|
"text": "SavedObjectAttributesAndRefs"
|
|
},
|
|
") | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.injectReferences",
|
|
"type": "Function",
|
|
"label": "injectReferences",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 81,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L81"
|
|
},
|
|
"signature": [
|
|
"(<T extends ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
">(object: T, references: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]) => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 82,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L82"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.init",
|
|
"type": "Function",
|
|
"label": "init",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 83,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L83"
|
|
},
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.indexPattern",
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 84,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L84"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.mapping",
|
|
"type": "Object",
|
|
"label": "mapping",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 85,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L85"
|
|
},
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.migrationVersion",
|
|
"type": "Object",
|
|
"label": "migrationVersion",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 86,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L86"
|
|
},
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.path",
|
|
"type": "string",
|
|
"label": "path",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 87,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L87"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.searchSource",
|
|
"type": "CompoundType",
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 88,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L88"
|
|
},
|
|
"signature": [
|
|
"boolean | Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectConfig.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 89,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L89"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/types.ts",
|
|
"lineNumber": 76,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/types.ts#L76"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.SaveResult",
|
|
"type": "Type",
|
|
"label": "SaveResult",
|
|
"tags": [],
|
|
"description": [
|
|
"\nRepresents the result of trying to persist the saved object.\nContains `error` prop if something unexpected happened (e.g. network error).\nContains an `id` if persisting was successful. If `id` and\n`error` are undefined, persisting was not successful, but the\nmodal can still recover (e.g. the name of the saved object was already taken)."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx#L21"
|
|
},
|
|
"signature": [
|
|
"{ id?: string | undefined; } | { error: Error; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.SavedObjectDecoratorFactory",
|
|
"type": "Type",
|
|
"label": "SavedObjectDecoratorFactory",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/saved_object/decorators/types.ts#L31"
|
|
},
|
|
"signature": [
|
|
"(services: ",
|
|
"SavedObjectKibanaServices",
|
|
") => ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectDecorator",
|
|
"text": "SavedObjectDecorator"
|
|
},
|
|
"<T>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PER_PAGE_SETTING",
|
|
"type": "string",
|
|
"label": "PER_PAGE_SETTING",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/common/index.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/common/index.ts#L9"
|
|
},
|
|
"signature": [
|
|
"\"savedObjects:perPage\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.LISTING_LIMIT_SETTING",
|
|
"type": "string",
|
|
"label": "LISTING_LIMIT_SETTING",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/common/index.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/common/index.ts#L10"
|
|
},
|
|
"signature": [
|
|
"\"savedObjects:listingLimit\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-public.SavedObjectsStart",
|
|
"type": "Interface",
|
|
"label": "SavedObjectsStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectsStart.SavedObjectClass",
|
|
"type": "Object",
|
|
"label": "SavedObjectClass",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/plugin.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/plugin.ts#L26"
|
|
},
|
|
"signature": [
|
|
"new (raw: Record<string, any>) => ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectsStart.settings",
|
|
"type": "Object",
|
|
"label": "settings",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/plugin.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/plugin.ts#L27"
|
|
},
|
|
"signature": [
|
|
"{ getPerPage: () => number; getListingLimit: () => number; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/plugin.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/plugin.ts#L25"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
},
|
|
"setup": {
|
|
"id": "def-public.SavedObjectSetup",
|
|
"type": "Interface",
|
|
"label": "SavedObjectSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SavedObjectSetup.registerDecorator",
|
|
"type": "Function",
|
|
"label": "registerDecorator",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/plugin.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/plugin.ts#L22"
|
|
},
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectDecoratorConfig",
|
|
"text": "SavedObjectDecoratorConfig"
|
|
},
|
|
"<any>) => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/public/plugin.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/public/plugin.ts#L21"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.PER_PAGE_SETTING",
|
|
"type": "string",
|
|
"label": "PER_PAGE_SETTING",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/common/index.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/common/index.ts#L9"
|
|
},
|
|
"signature": [
|
|
"\"savedObjects:perPage\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.LISTING_LIMIT_SETTING",
|
|
"type": "string",
|
|
"label": "LISTING_LIMIT_SETTING",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/saved_objects/common/index.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/saved_objects/common/index.ts#L10"
|
|
},
|
|
"signature": [
|
|
"\"savedObjects:listingLimit\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |