{ "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<", "SavedObjectFinderUiProps", ", SavedObjectFinderState, any>" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": 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, "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, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": 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, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData", "type": "Function", "tags": [], "label": "savedObjectMetaData", "description": [], "signature": [ "Validator", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize", "type": "Function", "tags": [], "label": "initialPageSize", "description": [], "signature": [ "Requireable", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize", "type": "Function", "tags": [], "label": "fixedPageSize", "description": [], "signature": [ "Requireable", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectFinderUi.propTypes.showFilter", "type": "Function", "tags": [], "label": "showFilter", "description": [], "signature": [ "Requireable", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.props", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [key: string]: any; }" ], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propName", "type": "string", "tags": [], "label": "propName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.componentName", "type": "string", "tags": [], "label": "componentName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.location", "type": "string", "tags": [], "label": "location", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.propFullName", "type": "string", "tags": [], "label": "propFullName", "description": [], "path": "node_modules/@types/prop-types/index.d.ts", "deprecated": 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, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectFinderUi.Unnamed.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "SavedObjectFinderUiProps" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": 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, "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, "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, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader", "type": "Class", "tags": [ "deprecated" ], "label": "SavedObjectLoader", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": true, "references": [ { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/find_list_items.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/find_list_items.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/saved_searches/saved_searches.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/saved_searches/saved_searches.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/plugin.tsx" }, { "plugin": "discover", "path": "src/plugins/discover/public/plugin.tsx" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/services.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/services.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/services/saved_objects.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/types.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/types.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/plugin.tsx" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/plugin.tsx" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/url_generator.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/url_generator.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/services/service_registry.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/services/service_registry.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/create_field_list.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/create_field_list.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/management_section/object_view/components/form.tsx" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/management_section/object_view/components/form.tsx" } ], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.lowercaseType", "type": "string", "tags": [], "label": "lowercaseType", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.loaderProperties", "type": "Object", "tags": [], "label": "loaderProperties", "description": [], "signature": [ "{ [x: string]: string; }" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.Unnamed.$1", "type": "Any", "tags": [], "label": "SavedObjectClass", "description": [], "signature": [ "any" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.Unnamed.$2", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"bulkUpdate\">" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nRetrieve a saved object by id or create new one.\nReturns a promise that completes when the object finishes\ninitializing." ], "signature": [ "(opts?: string | Record | undefined) => Promise" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.get.$1", "type": "CompoundType", "tags": [], "label": "opts", "description": [], "signature": [ "string | Record | undefined" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.urlFor", "type": "Function", "tags": [], "label": "urlFor", "description": [], "signature": [ "(id: string) => string" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.urlFor.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.delete", "type": "Function", "tags": [], "label": "delete", "description": [], "signature": [ "(ids: string | string[]) => Promise" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.delete.$1", "type": "CompoundType", "tags": [], "label": "ids", "description": [], "signature": [ "string | string[]" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapHitSource", "type": "Function", "tags": [], "label": "mapHitSource", "description": [ "\nUpdates source to contain an id, url and references fields, and returns the updated\nsource object." ], "signature": [ "(source: Record, id: string, references?: ", "SavedObjectReference", "[]) => Record" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapHitSource.$1", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "Record" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapHitSource.$2", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapHitSource.$3", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[]" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "The modified source object, with an id and url field." ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits", "type": "Function", "tags": [], "label": "mapSavedObjectApiHits", "description": [ "\nUpdates hit.attributes to contain an id and url field, and returns the updated\nattributes object." ], "signature": [ "({ attributes, id, references, }: { attributes: Record; id: string; references?: ", "SavedObjectReference", "[] | undefined; }) => Record" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences", "type": "Object", "tags": [], "label": "{\n attributes,\n id,\n references = [],\n }", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.attributes", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.references", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[] | undefined" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false } ] } ], "returnComment": [ "The modified hit.attributes object, with an id and url field." ] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.find", "type": "Function", "tags": [], "label": "find", "description": [], "signature": [ "(search?: string, sizeOrOptions?: number | ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectLoaderFindOptions", "text": "SavedObjectLoaderFindOptions" }, ") => Promise<{ total: number; hits: Record[]; }>" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.find.$1", "type": "string", "tags": [], "label": "search", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoader.find.$2", "type": "CompoundType", "tags": [], "label": "sizeOrOptions", "description": [], "signature": [ "number | ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectLoaderFindOptions", "text": "SavedObjectLoaderFindOptions" } ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "isRequired": true } ], "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" ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "deprecated": true, "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/apps/main/components/top_nav/on_save_search.tsx" }, { "plugin": "discover", "path": "src/plugins/discover/public/application/apps/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/services/saved_objects.ts" }, { "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, "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 }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 } ] }, { "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, "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 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" ], "signature": [ "(savedObject: Pick<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ", \"title\" | \"id\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">, isTitleDuplicateConfirmed: boolean, onTitleDuplicate: (() => void) | undefined, services: Pick<", "SavedObjectKibanaServices", ", \"savedObjectsClient\" | \"overlays\">) => Promise" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "deprecated": 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" }, ", \"title\" | \"id\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "deprecated": 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, "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, "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, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "savedObjects", "id": "def-public.getSavedObjectFinder", "type": "Function", "tags": [], "label": "getSavedObjectFinder", "description": [], "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" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.getSavedObjectFinder.$1", "type": "Object", "tags": [], "label": "savedObject", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsStart", "text": "SavedObjectsStart" } ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.getSavedObjectFinder.$2", "type": "Object", "tags": [], "label": "uiSettings", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": 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, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.isErrorNonFatal.$1.error", "type": "Object", "tags": [], "label": "error", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.isErrorNonFatal.$1.error.message", "type": "string", "tags": [], "label": "message", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts", "deprecated": 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, "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, "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: ", "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\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"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" }, "<", "SavedObjectAttributes", ">>" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": 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": [ "SavedObjectAttributes" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$2.savedObject", "type": "Object", "tags": [], "label": "savedObject", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$2.savedObject.getEsType", "type": "Function", "tags": [], "label": "getEsType", "description": [], "signature": [ "() => string" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$2.savedObject.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$2.savedObject.displayName", "type": "string", "tags": [], "label": "displayName", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": 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": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" } ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$4.services", "type": "Object", "tags": [], "label": "services", "description": [], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$4.services.savedObjectsClient", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ "{ get: (type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ">; delete: (type: string, id: string, options?: ", "SavedObjectsDeleteOptions", " | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ">; bulkCreate: (objects?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBulkCreateObject", "text": "SavedObjectsBulkCreateObject" }, "[], options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBulkCreateOptions", "text": "SavedObjectsBulkCreateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBatchResponse", "text": "SavedObjectsBatchResponse" }, ">; find: (options: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsFindResponsePublic", "text": "SavedObjectsFindResponsePublic" }, ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBatchResponse", "text": "SavedObjectsBatchResponse" }, ">; resolve: (type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.ResolvedSimpleSavedObject", "text": "ResolvedSimpleSavedObject" }, ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ">; bulkUpdate: (objects?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBulkUpdateObject", "text": "SavedObjectsBulkUpdateObject" }, "[]) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsBatchResponse", "text": "SavedObjectsBatchResponse" }, ">; }" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.saveWithConfirmation.$4.services.overlays", "type": "Object", "tags": [], "label": "overlays", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayStart", "text": "OverlayStart" } ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": 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 React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>, 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, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.showSaveModal.$1", "type": "Object", "tags": [], "label": "saveModal", "description": [], "signature": [ "React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ], "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "deprecated": 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, "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, "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, "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 }, { "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 }, { "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 }, { "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, "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 } ], "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, "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 }, { "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, "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, "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 }, { "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 }, { "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 }, { "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 }, { "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, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.OriginSaveModalProps.options", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | ((state: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SaveModalState", "text": "SaveModalState" }, ") => React.ReactNode) | null | undefined" ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "deprecated": 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, "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, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject", "type": "Interface", "tags": [ "deprecated" ], "label": "SavedObject", "description": [], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": true, "references": [ { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/types.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/types.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/saved_searches/_saved_search.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/saved_searches/_saved_search.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.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/services/saved_objects.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/dashboard_tagging.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/dashboard_tagging.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" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" }, { "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts" } ], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObject._serialize", "type": "Function", "tags": [], "label": "_serialize", "description": [], "signature": [ "() => { attributes: ", "SavedObjectAttributes", "; references: ", "SavedObjectReference", "[]; }" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.applyESResp", "type": "Function", "tags": [], "label": "applyESResp", "description": [], "signature": [ "(resp: Record) => Promise<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ">" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.applyESResp.$1", "type": "Object", "tags": [], "label": "resp", "description": [], "signature": [ "Record" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.creationOpts", "type": "Function", "tags": [], "label": "creationOpts", "description": [], "signature": [ "(opts: ", "SavedObjectCreationOpts", ") => Record" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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, "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 }, { "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, "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, "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, "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, "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, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.hydrateIndexPattern", "type": "Function", "tags": [], "label": "hydrateIndexPattern", "description": [], "signature": [ "((id?: string | undefined) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | null>) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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, "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 }, { "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" }, ">) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "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, "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 }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.migrationVersion", "type": "Object", "tags": [], "label": "migrationVersion", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.searchSource", "type": "Object", "tags": [], "label": "searchSource", "description": [], "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" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.searchSourceFields", "type": "Object", "tags": [], "label": "searchSourceFields", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.showInRecentlyAccessed", "type": "boolean", "tags": [], "label": "showInRecentlyAccessed", "description": [], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObject.unresolvedIndexPatternReference", "type": "Object", "tags": [], "label": "unresolvedIndexPatternReference", "description": [], "signature": [ "SavedObjectReference", " | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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, "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" }, ") => Promise<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ">) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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" } ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "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, "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, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.injectReferences", "type": "Function", "tags": [], "label": "injectReferences", "description": [], "signature": [ "((object: T, references: ", "SavedObjectReference", "[]) => void) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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, "isRequired": true }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.injectReferences.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[]" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "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, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.indexPattern", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.mapping", "type": "Object", "tags": [], "label": "mapping", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.migrationVersion", "type": "Object", "tags": [], "label": "migrationVersion", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectConfig.searchSource", "type": "CompoundType", "tags": [], "label": "searchSource", "description": [], "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" ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 } ], "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" }, "" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": 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, "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, "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, "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, "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, "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" }, "" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "deprecated": 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 }, { "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 }, { "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" }, "" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.services", "type": "Object", "tags": [], "label": "services", "description": [], "signature": [ "SavedObjectKibanaServices" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoaderFindOptions", "type": "Interface", "tags": [], "label": "SavedObjectLoaderFindOptions", "description": [], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoaderFindOptions.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoaderFindOptions.fields", "type": "Array", "tags": [], "label": "fields", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectLoaderFindOptions.hasReference", "type": "Array", "tags": [], "label": "hasReference", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, "[] | undefined" ], "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "deprecated": 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" }, "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": 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 }, { "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 }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getIconForSavedObject", "type": "Function", "tags": [], "label": "getIconForSavedObject", "description": [], "signature": [ "(savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => ", "IconType" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getIconForSavedObject.$1", "type": "Object", "tags": [], "label": "savedObject", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getTooltipForSavedObject", "type": "Function", "tags": [], "label": "getTooltipForSavedObject", "description": [], "signature": [ "((savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => string) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getTooltipForSavedObject.$1", "type": "Object", "tags": [], "label": "savedObject", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.showSavedObject", "type": "Function", "tags": [], "label": "showSavedObject", "description": [], "signature": [ "((savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => boolean) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.showSavedObject.$1", "type": "Object", "tags": [], "label": "savedObject", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getSavedObjectSubType", "type": "Function", "tags": [], "label": "getSavedObjectSubType", "description": [], "signature": [ "((savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => string) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": false, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectMetaData.getSavedObjectSubType.$1", "type": "Object", "tags": [], "label": "savedObject", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "deprecated": 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 } ], "initialIsOpen": false }, { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectSaveOpts", "type": "Interface", "tags": [], "label": "SavedObjectSaveOpts", "description": [], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": 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 }, { "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 }, { "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, "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 } ], "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, "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 }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 } ], "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, "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, "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" }, "" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjects", "id": "def-public.services", "type": "Object", "tags": [], "label": "services", "description": [], "signature": [ "SavedObjectKibanaServices" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": 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, "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, "children": [ { "parentPluginId": "savedObjects", "id": "def-public.SavedObjectsStart.SavedObjectClass", "type": "Object", "tags": [ "deprecated" ], "label": "SavedObjectClass", "description": [], "signature": [ "new (raw: Record) => ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" } ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": true, "references": [ { "plugin": "discover", "path": "src/plugins/discover/public/saved_searches/_saved_search.ts" }, { "plugin": "visualizations", "path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" } ] }, { "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, "references": [ { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx" } ] } ], "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, "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" }, ") => void" ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": 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" }, "" ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": 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, "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, "initialIsOpen": false } ], "objects": [] } }