github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/saved_objects.devdocs.json
Kibana Machine e82e0a150f
[api-docs] Daily api_docs build (#144203)
2022-10-29 00:46:56 -04:00

3446 lines
No EOL
123 KiB
JSON
Raw Blame History

{
"id": "savedObjects",
"client": {
"classes": [
{
"parentPluginId": "savedObjects",
"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<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectFinderUiProps",
"text": "SavedObjectFinderUiProps"
},
", SavedObjectFinderState, any>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes",
"type": "Object",
"tags": [],
"label": "propTypes",
"description": [],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose",
"type": "Function",
"tags": [],
"label": "onChoose",
"description": [],
"signature": [
"Requireable",
"<(...args: any[]) => any>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.onChoose.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage",
"type": "Function",
"tags": [],
"label": "noItemsMessage",
"description": [],
"signature": [
"Requireable",
"<",
"ReactNodeLike",
">"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData",
"type": "Function",
"tags": [],
"label": "savedObjectMetaData",
"description": [],
"signature": [
"Validator",
"<any[]>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize",
"type": "Function",
"tags": [],
"label": "initialPageSize",
"description": [],
"signature": [
"Requireable",
"<number>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize",
"type": "Function",
"tags": [],
"label": "fixedPageSize",
"description": [],
"signature": [
"Requireable",
"<number>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter",
"type": "Function",
"tags": [],
"label": "showFilter",
"description": [],
"signature": [
"Requireable",
"<boolean>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter.$2",
"type": "string",
"tags": [],
"label": "propName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter.$3",
"type": "string",
"tags": [],
"label": "componentName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter.$4",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.propTypes.showFilter.$5",
"type": "string",
"tags": [],
"label": "propFullName",
"description": [],
"path": "node_modules/@types/prop-types/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectFinderUiProps",
"text": "SavedObjectFinderUiProps"
}
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.componentWillUnmount",
"type": "Function",
"tags": [],
"label": "componentWillUnmount",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.componentDidMount",
"type": "Function",
"tags": [],
"label": "componentDidMount",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUi.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal",
"type": "Class",
"tags": [
"deprecated"
],
"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>"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": true,
"removeBy": "8.8.0",
"trackAdoption": false,
"references": [
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx"
},
{
"plugin": "embeddable",
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx"
},
{
"plugin": "discover",
"path": "src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx"
},
{
"plugin": "discover",
"path": "src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx"
},
{
"plugin": "presentationUtil",
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx"
},
{
"plugin": "presentationUtil",
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/public/application/top_nav/save_modal.tsx"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/public/application/top_nav/save_modal.tsx"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/components/save_modal.tsx"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/components/save_modal.tsx"
}
],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.copyOnSave",
"type": "boolean",
"tags": [],
"label": "copyOnSave",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.isTitleDuplicateConfirmed",
"type": "boolean",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.hasTitleDuplicate",
"type": "boolean",
"tags": [],
"label": "hasTitleDuplicate",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.state.visualizationDescription",
"type": "string",
"tags": [],
"label": "visualizationDescription",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModal.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "savedObjects",
"id": "def-public.checkForDuplicateTitle",
"type": "Function",
"tags": [],
"label": "checkForDuplicateTitle",
"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>"
],
"signature": [
"(savedObject: Pick<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">, \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">, isTitleDuplicateConfirmed: boolean, onTitleDuplicate: (() => void) | undefined, services: Pick<",
"SavedObjectKibanaServices",
", \"savedObjectsClient\" | \"overlays\">) => Promise<true>"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.checkForDuplicateTitle.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">, \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.checkForDuplicateTitle.$2",
"type": "boolean",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.checkForDuplicateTitle.$3",
"type": "Function",
"tags": [],
"label": "onTitleDuplicate",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.checkForDuplicateTitle.$4",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Pick<",
"SavedObjectKibanaServices",
", \"savedObjectsClient\" | \"overlays\">"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.getSavedObjectFinder",
"type": "Function",
"tags": [],
"label": "getSavedObjectFinder",
"description": [],
"signature": [
"(savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsBrowserPluginApi",
"section": "def-common.SavedObjectsStart",
"text": "SavedObjectsStart"
},
", uiSettings: ",
{
"pluginId": "@kbn/core-ui-settings-browser",
"scope": "common",
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
},
") => (props: ",
"SavedObjectFinderProps",
") => JSX.Element"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.getSavedObjectFinder.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsBrowserPluginApi",
"section": "def-common.SavedObjectsStart",
"text": "SavedObjectsStart"
}
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.getSavedObjectFinder.$2",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-ui-settings-browser",
"scope": "common",
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.isErrorNonFatal",
"type": "Function",
"tags": [
"return"
],
"label": "isErrorNonFatal",
"description": [],
"signature": [
"(error: { message: string; }) => boolean"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.isErrorNonFatal.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.isErrorNonFatal.$1.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModalOrigin",
"type": "Function",
"tags": [],
"label": "SavedObjectSaveModalOrigin",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OriginSaveModalProps",
"text": "OriginSaveModalProps"
},
") => JSX.Element"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveModalOrigin.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OriginSaveModalProps",
"text": "OriginSaveModalProps"
}
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation",
"type": "Function",
"tags": [
"resolved"
],
"label": "saveWithConfirmation",
"description": [
"\nAttempts to create the current object using the serialized source. If an object already\nexists, a warning message requests an overwrite confirmation."
],
"signature": [
"(source: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
", savedObject: { getEsType(): string; title: string; displayName: string; }, options: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
", services: { savedObjectsClient: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
"; overlays: ",
{
"pluginId": "@kbn/core-overlays-browser",
"scope": "common",
"docId": "kibKbnCoreOverlaysBrowserPluginApi",
"section": "def-common.OverlayStart",
"text": "OverlayStart"
},
"; }) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">>"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$1",
"type": "Object",
"tags": [],
"label": "source",
"description": [
"- serialized version of this object what will be indexed into elasticsearch."
],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$2",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$2.getEsType",
"type": "Function",
"tags": [],
"label": "getEsType",
"description": [],
"signature": [
"() => string"
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$2.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$2.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"- options to pass to the saved object create method"
],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$4",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$4.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.saveWithConfirmation.$4.overlays",
"type": "Object",
"tags": [],
"label": "overlays",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-overlays-browser",
"scope": "common",
"docId": "kibKbnCoreOverlaysBrowserPluginApi",
"section": "def-common.OverlayStart",
"text": "OverlayStart"
}
],
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"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."
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.showSaveModal",
"type": "Function",
"tags": [],
"label": "showSaveModal",
"description": [],
"signature": [
"(saveModal: React.ReactElement<MinimalSaveModalProps, string | React.JSXElementConstructor<any>>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element, Wrapper: React.FC<{}> | undefined) => void"
],
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.showSaveModal.$1",
"type": "Object",
"tags": [],
"label": "saveModal",
"description": [],
"signature": [
"React.ReactElement<MinimalSaveModalProps, string | React.JSXElementConstructor<any>>"
],
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.showSaveModal.$2",
"type": "Function",
"tags": [],
"label": "I18nContext",
"description": [],
"signature": [
"({ children }: { children: React.ReactNode; }) => JSX.Element"
],
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.showSaveModal.$3",
"type": "Function",
"tags": [],
"label": "Wrapper",
"description": [],
"signature": [
"React.FC<{}> | undefined"
],
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps",
"type": "Interface",
"tags": [],
"label": "OnSaveProps",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps.newTitle",
"type": "string",
"tags": [],
"label": "newTitle",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps.newCopyOnSave",
"type": "boolean",
"tags": [],
"label": "newCopyOnSave",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps.isTitleDuplicateConfirmed",
"type": "boolean",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps.onTitleDuplicate",
"type": "Function",
"tags": [],
"label": "onTitleDuplicate",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OnSaveProps.newDescription",
"type": "string",
"tags": [],
"label": "newDescription",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps",
"type": "Interface",
"tags": [],
"label": "OriginSaveModalProps",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.getAppNameFromId",
"type": "Function",
"tags": [],
"label": "getAppNameFromId",
"description": [],
"signature": [
"((appId: string) => string | undefined) | undefined"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.getAppNameFromId.$1",
"type": "string",
"tags": [],
"label": "appId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.originatingAppName",
"type": "string",
"tags": [],
"label": "originatingAppName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.returnToOriginSwitchLabel",
"type": "string",
"tags": [],
"label": "returnToOriginSwitchLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.documentInfo",
"type": "Object",
"tags": [],
"label": "documentInfo",
"description": [],
"signature": [
"SaveModalDocumentInfo"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.objectType",
"type": "string",
"tags": [],
"label": "objectType",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.options",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"React.ReactNode | ((state: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SaveModalState",
"text": "SaveModalState"
},
") => React.ReactNode)"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
" & { returnToOrigin: boolean; }) => void"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.OriginSaveModalProps.onSave.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
" & { returnToOrigin: boolean; }"
],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "SavedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": true,
"removeBy": "8.8.0",
"trackAdoption": false,
"references": [
{
"plugin": "savedObjectsTaggingOss",
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts"
},
{
"plugin": "savedObjectsTaggingOss",
"path": "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts"
},
{
"plugin": "savedObjectsTaggingOss",
"path": "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts"
},
{
"plugin": "savedObjectsTaggingOss",
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts"
},
{
"plugin": "savedObjectsTaggingOss",
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/public/application/actions/clone_panel_action.tsx"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/public/application/actions/clone_panel_action.tsx"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/public/application/actions/clone_panel_action.tsx"
}
],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject._serialize",
"type": "Function",
"tags": [],
"label": "_serialize",
"description": [],
"signature": [
"() => { attributes: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
"; references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject._source",
"type": "Object",
"tags": [],
"label": "_source",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.applyESResp",
"type": "Function",
"tags": [],
"label": "applyESResp",
"description": [],
"signature": [
"(resp: ",
"EsResponse",
") => Promise<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.applyESResp.$1",
"type": "Object",
"tags": [],
"label": "resp",
"description": [],
"signature": [
"EsResponse"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.copyOnSave",
"type": "boolean",
"tags": [],
"label": "copyOnSave",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.creationOpts",
"type": "Function",
"tags": [],
"label": "creationOpts",
"description": [],
"signature": [
"(opts: ",
"SavedObjectCreationOpts",
") => Record<string, unknown>"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.creationOpts.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"SavedObjectCreationOpts"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.defaults",
"type": "Any",
"tags": [],
"label": "defaults",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"(() => Promise<{}>) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [],
"signature": [
"() => string"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.getEsType",
"type": "Function",
"tags": [],
"label": "getEsType",
"description": [],
"signature": [
"() => string"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.getFullPath",
"type": "Function",
"tags": [],
"label": "getFullPath",
"description": [],
"signature": [
"() => string"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.hydrateIndexPattern",
"type": "Function",
"tags": [],
"label": "hydrateIndexPattern",
"description": [],
"signature": [
"((id?: string | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | null>) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.hydrateIndexPattern.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.init",
"type": "Function",
"tags": [],
"label": "init",
"description": [],
"signature": [
"(() => Promise<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<T>>) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.isSaving",
"type": "boolean",
"tags": [],
"label": "isSaving",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.isTitleChanged",
"type": "Function",
"tags": [],
"label": "isTitleChanged",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.lastSavedTitle",
"type": "string",
"tags": [],
"label": "lastSavedTitle",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.save",
"type": "Function",
"tags": [],
"label": "save",
"description": [],
"signature": [
"(saveOptions: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
},
") => Promise<string>"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.save.$1",
"type": "Object",
"tags": [],
"label": "saveOptions",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
}
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
" | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.searchSourceFields",
"type": "Object",
"tags": [],
"label": "searchSourceFields",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
},
" | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.showInRecentlyAccessed",
"type": "boolean",
"tags": [],
"label": "showInRecentlyAccessed",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObject.unresolvedIndexPatternReference",
"type": "Object",
"tags": [],
"label": "unresolvedIndexPatternReference",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
" | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig",
"type": "Interface",
"tags": [],
"label": "SavedObjectConfig",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.afterESResp",
"type": "Function",
"tags": [],
"label": "afterESResp",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">) => Promise<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">>) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.afterESResp.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.defaults",
"type": "Any",
"tags": [],
"label": "defaults",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.extractReferences",
"type": "Function",
"tags": [],
"label": "extractReferences",
"description": [],
"signature": [
"((opts: ",
"SavedObjectAttributesAndRefs",
") => ",
"SavedObjectAttributesAndRefs",
") | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.extractReferences.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"SavedObjectAttributesAndRefs"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.injectReferences",
"type": "Function",
"tags": [],
"label": "injectReferences",
"description": [],
"signature": [
"(<T extends ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">>(object: T, references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => void) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.injectReferences.$1",
"type": "Uncategorized",
"tags": [],
"label": "object",
"description": [],
"signature": [
"T"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.injectReferences.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.init",
"type": "Function",
"tags": [],
"label": "init",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.indexPattern",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.mapping",
"type": "Object",
"tags": [],
"label": "mapping",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.path",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.searchSource",
"type": "CompoundType",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
"boolean | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
" | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectConfig.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator",
"type": "Interface",
"tags": [],
"label": "SavedObjectDecorator",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecorator",
"text": "SavedObjectDecorator"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator.getId",
"type": "Function",
"tags": [],
"label": "getId",
"description": [
"\nId of the decorator"
],
"signature": [
"() => string"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator.decorateConfig",
"type": "Function",
"tags": [],
"label": "decorateConfig",
"description": [
"\nDecorate the saved object provided config. This can be used to enhance or alter the object's provided\nconfiguration."
],
"signature": [
"(config: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectConfig",
"text": "SavedObjectConfig"
},
") => void"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator.decorateConfig.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectConfig",
"text": "SavedObjectConfig"
}
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator.decorateObject",
"type": "Function",
"tags": [],
"label": "decorateObject",
"description": [
"\nDecorate the saved object instance. Can be used to add additional methods to it.\n"
],
"signature": [
"(object: T) => void"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecorator.decorateObject.$1",
"type": "Uncategorized",
"tags": [],
"label": "object",
"description": [],
"signature": [
"T"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorConfig",
"type": "Interface",
"tags": [],
"label": "SavedObjectDecoratorConfig",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecoratorConfig",
"text": "SavedObjectDecoratorConfig"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorConfig.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nThe id of the decorator"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorConfig.priority",
"type": "number",
"tags": [],
"label": "priority",
"description": [
"\nHighest priority will be called **last**\n(the decoration will be at the highest level)"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorConfig.factory",
"type": "Function",
"tags": [],
"label": "factory",
"description": [
"\nThe factory to use to create the decorator"
],
"signature": [
"(services: ",
"SavedObjectKibanaServices",
") => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecorator",
"text": "SavedObjectDecorator"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorConfig.factory.$1",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"SavedObjectKibanaServices"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData",
"type": "Interface",
"tags": [],
"label": "SavedObjectMetaData",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectMetaData",
"text": "SavedObjectMetaData"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getIconForSavedObject",
"type": "Function",
"tags": [],
"label": "getIconForSavedObject",
"description": [],
"signature": [
"(savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>) => ",
"IconType"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getIconForSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getTooltipForSavedObject",
"type": "Function",
"tags": [],
"label": "getTooltipForSavedObject",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>) => string) | undefined"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getTooltipForSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.showSavedObject",
"type": "Function",
"tags": [],
"label": "showSavedObject",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>) => boolean) | undefined"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.showSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getSavedObjectSubType",
"type": "Function",
"tags": [],
"label": "getSavedObjectSubType",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>) => string) | undefined"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.getSavedObjectSubType.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.includeFields",
"type": "Array",
"tags": [],
"label": "includeFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectMetaData.defaultSearchField",
"type": "string",
"tags": [],
"label": "defaultSearchField",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveOpts",
"type": "Interface",
"tags": [],
"label": "SavedObjectSaveOpts",
"description": [],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveOpts.confirmOverwrite",
"type": "CompoundType",
"tags": [],
"label": "confirmOverwrite",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveOpts.isTitleDuplicateConfirmed",
"type": "CompoundType",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveOpts.onTitleDuplicate",
"type": "Function",
"tags": [],
"label": "onTitleDuplicate",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSaveOpts.returnToOrigin",
"type": "CompoundType",
"tags": [],
"label": "returnToOrigin",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_objects/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState",
"type": "Interface",
"tags": [],
"label": "SaveModalState",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.copyOnSave",
"type": "boolean",
"tags": [],
"label": "copyOnSave",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.isTitleDuplicateConfirmed",
"type": "boolean",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.hasTitleDuplicate",
"type": "boolean",
"tags": [],
"label": "hasTitleDuplicate",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveModalState.visualizationDescription",
"type": "string",
"tags": [],
"label": "visualizationDescription",
"description": [],
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "savedObjects",
"id": "def-public.LISTING_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "LISTING_LIMIT_SETTING",
"description": [],
"signature": [
"\"savedObjects:listingLimit\""
],
"path": "src/plugins/saved_objects/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.PER_PAGE_SETTING",
"type": "string",
"tags": [],
"label": "PER_PAGE_SETTING",
"description": [],
"signature": [
"\"savedObjects:perPage\""
],
"path": "src/plugins/saved_objects/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorFactory",
"type": "Type",
"tags": [],
"label": "SavedObjectDecoratorFactory",
"description": [],
"signature": [
"(services: ",
"SavedObjectKibanaServices",
") => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecorator",
"text": "SavedObjectDecorator"
},
"<T>"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectDecoratorFactory.$1",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"SavedObjectKibanaServices"
],
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectFinderUiProps",
"type": "Type",
"tags": [],
"label": "SavedObjectFinderUiProps",
"description": [],
"signature": [
"{ savedObjects: ",
{
"pluginId": "@kbn/core-saved-objects-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsBrowserPluginApi",
"section": "def-common.SavedObjectsStart",
"text": "SavedObjectsStart"
},
"; uiSettings: ",
{
"pluginId": "@kbn/core-ui-settings-browser",
"scope": "common",
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
},
"; } & ",
"SavedObjectFinderProps"
],
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SaveResult",
"type": "Type",
"tags": [],
"label": "SaveResult",
"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)."
],
"signature": [
"{ id?: string | undefined; } | { error: Error; }"
],
"path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectsStart",
"type": "Interface",
"tags": [],
"label": "SavedObjectsStart",
"description": [],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectsStart.SavedObjectClass",
"type": "Object",
"tags": [
"deprecated"
],
"label": "SavedObjectClass",
"description": [],
"signature": [
"new (raw: Record<string, any>) => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">"
],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": true,
"removeBy": "8.8.0",
"trackAdoption": false,
"references": []
},
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectsStart.settings",
"type": "Object",
"tags": [
"deprecated"
],
"label": "settings",
"description": [],
"signature": [
"{ getPerPage: () => number; getListingLimit: () => number; }"
],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": true,
"removeBy": "8.8.0",
"trackAdoption": false,
"references": []
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSetup",
"type": "Interface",
"tags": [],
"label": "SavedObjectSetup",
"description": [],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSetup.registerDecorator",
"type": "Function",
"tags": [],
"label": "registerDecorator",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecoratorConfig",
"text": "SavedObjectDecoratorConfig"
},
"<any>) => void"
],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjects",
"id": "def-public.SavedObjectSetup.registerDecorator.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectDecoratorConfig",
"text": "SavedObjectDecoratorConfig"
},
"<any>"
],
"path": "src/plugins/saved_objects/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "savedObjects",
"id": "def-common.LISTING_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "LISTING_LIMIT_SETTING",
"description": [],
"signature": [
"\"savedObjects:listingLimit\""
],
"path": "src/plugins/saved_objects/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjects",
"id": "def-common.PER_PAGE_SETTING",
"type": "string",
"tags": [],
"label": "PER_PAGE_SETTING",
"description": [],
"signature": [
"\"savedObjects:perPage\""
],
"path": "src/plugins/saved_objects/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink