{ "id": "savedObjects", "client": { "classes": [ { "id": "def-public.SavedObjectFinderUi", "type": "Class", "tags": [], "label": "SavedObjectFinderUi", "description": [], "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectFinderUi", "text": "SavedObjectFinderUi" }, " extends React.Component<", "SavedObjectFinderUiProps", ", SavedObjectFinderState, any>" ], "children": [ { "id": "def-public.SavedObjectFinderUi.propTypes", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.onChoose", "type": "Function", "label": "onChoose", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 108 }, "signature": [ "Requireable", "<(...args: any[]) => any>" ] }, { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.noItemsMessage", "type": "Function", "label": "noItemsMessage", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 109 }, "signature": [ "Requireable", "<", "ReactNodeLike", ">" ] }, { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.savedObjectMetaData", "type": "Function", "label": "savedObjectMetaData", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 110 }, "signature": [ "Validator", "" ] }, { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.initialPageSize", "type": "Function", "label": "initialPageSize", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 111 }, "signature": [ "Requireable", "" ] }, { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.fixedPageSize", "type": "Function", "label": "fixedPageSize", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 112 }, "signature": [ "Requireable", "" ] }, { "tags": [], "id": "def-public.SavedObjectFinderUi.propTypes.showFilter", "type": "Function", "label": "showFilter", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 113 }, "signature": [ "Requireable", "" ] } ], "description": [], "label": "propTypes", "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 107 } }, { "id": "def-public.SavedObjectFinderUi.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectFinderUiProps", "text": "SavedObjectFinderUiProps" } ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 173 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 173 } }, { "id": "def-public.SavedObjectFinderUi.componentWillUnmount", "type": "Function", "label": "componentWillUnmount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 188 } }, { "id": "def-public.SavedObjectFinderUi.componentDidMount", "type": "Function", "label": "componentDidMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 193 } }, { "id": "def-public.SavedObjectFinderUi.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 198 } } ], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 103 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectLoader", "type": "Class", "tags": [ "deprecated" ], "label": "SavedObjectLoader", "description": [], "children": [ { "tags": [], "id": "def-public.SavedObjectLoader.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 35 } }, { "tags": [], "id": "def-public.SavedObjectLoader.lowercaseType", "type": "string", "label": "lowercaseType", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 36 } }, { "tags": [], "id": "def-public.SavedObjectLoader.loaderProperties", "type": "Object", "label": "loaderProperties", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 37 }, "signature": [ "Record" ] }, { "id": "def-public.SavedObjectLoader.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Any", "label": "SavedObjectClass", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 40 } }, { "type": "Object", "label": "savedObjectsClient", "isRequired": true, "signature": [ "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 41 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 39 } }, { "id": "def-public.SavedObjectLoader.get", "type": "Function", "label": "get", "signature": [ "(opts?: string | Record | undefined) => Promise" ], "description": [ "\nRetrieve a saved object by id or create new one.\nReturns a promise that completes when the object finishes\ninitializing." ], "children": [ { "type": "CompoundType", "label": "opts", "isRequired": false, "signature": [ "string | Record | undefined" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 61 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 61 } }, { "id": "def-public.SavedObjectLoader.urlFor", "type": "Function", "label": "urlFor", "signature": [ "(id: string) => string" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 69 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 69 } }, { "id": "def-public.SavedObjectLoader.delete", "type": "Function", "label": "delete", "signature": [ "(ids: string | string[]) => Promise" ], "description": [], "children": [ { "type": "CompoundType", "label": "ids", "isRequired": true, "signature": [ "string | string[]" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 73 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 73 } }, { "id": "def-public.SavedObjectLoader.mapHitSource", "type": "Function", "label": "mapHitSource", "signature": [ "(source: Record, id: string, references?: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => Record" ], "description": [ "\nUpdates source to contain an id, url and references fields, and returns the updated\nsource object." ], "children": [ { "type": "Object", "label": "source", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 93 } }, { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 94 } }, { "type": "Array", "label": "references", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 95 } } ], "tags": [], "returnComment": [ "The modified source object, with an id and url field." ], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 92 } }, { "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits", "type": "Function", "label": "mapSavedObjectApiHits", "signature": [ "({ attributes, id, references, }: { attributes: Record; id: string; references?: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[] | undefined; }) => Record" ], "description": [ "\nUpdates hit.attributes to contain an id and url field, and returns the updated\nattributes object." ], "children": [ { "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }", "type": "Object", "label": "{\n attributes,\n id,\n references = [],\n }", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.attributes", "type": "Object", "label": "attributes", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 114 }, "signature": [ "Record" ] }, { "tags": [], "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 115 } }, { "tags": [], "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.references", "type": "Array", "label": "references", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 116 }, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[] | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 113 } } ], "tags": [], "returnComment": [ "The modified hit.attributes object, with an id and url field." ], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 109 } }, { "id": "def-public.SavedObjectLoader.find", "type": "Function", "label": "find", "signature": [ "(search?: string, sizeOrOptions?: number | ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectLoaderFindOptions", "text": "SavedObjectLoaderFindOptions" }, ") => Promise<{ total: number; hits: Record[]; }>" ], "description": [], "children": [ { "type": "string", "label": "search", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 153 } }, { "type": "CompoundType", "label": "sizeOrOptions", "isRequired": true, "signature": [ "number | ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectLoaderFindOptions", "text": "SavedObjectLoaderFindOptions" } ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 153 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 153 } } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 33 }, "initialIsOpen": false }, { "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" ], "children": [ { "id": "def-public.SavedObjectSaveModal.state", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectSaveModal.state.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 73 } }, { "tags": [], "id": "def-public.SavedObjectSaveModal.state.copyOnSave", "type": "boolean", "label": "copyOnSave", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 74 } }, { "tags": [], "id": "def-public.SavedObjectSaveModal.state.isTitleDuplicateConfirmed", "type": "boolean", "label": "isTitleDuplicateConfirmed", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 75 } }, { "tags": [], "id": "def-public.SavedObjectSaveModal.state.hasTitleDuplicate", "type": "boolean", "label": "hasTitleDuplicate", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 76 } }, { "tags": [], "id": "def-public.SavedObjectSaveModal.state.isLoading", "type": "boolean", "label": "isLoading", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 77 } }, { "tags": [], "id": "def-public.SavedObjectSaveModal.state.visualizationDescription", "type": "string", "label": "visualizationDescription", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 78 } } ], "description": [], "label": "state", "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 72 } }, { "id": "def-public.SavedObjectSaveModal.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 81 } } ], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 70 }, "initialIsOpen": false } ], "functions": [ { "id": "def-public.checkForDuplicateTitle", "type": "Function", "label": "checkForDuplicateTitle", "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" ], "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" ], "children": [ { "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ "Pick<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ", \"title\" | \"id\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "lineNumber": 24 } }, { "type": "boolean", "label": "isTitleDuplicateConfirmed", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "lineNumber": 28 } }, { "type": "Function", "label": "onTitleDuplicate", "isRequired": false, "signature": [ "(() => void) | undefined" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "lineNumber": 29 } }, { "type": "Object", "label": "services", "isRequired": true, "signature": [ "Pick<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectKibanaServices", "text": "SavedObjectKibanaServices" }, ", \"savedObjectsClient\" | \"overlays\">" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "lineNumber": 30 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/check_for_duplicate_title.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.getSavedObjectFinder", "type": "Function", "children": [ { "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsStart", "text": "SavedObjectsStart" } ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 526 } }, { "type": "Object", "label": "uiSettings", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 526 } } ], "signature": [ "(savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsStart", "text": "SavedObjectsStart" }, ", uiSettings: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" }, ") => (props: ", "SavedObjectFinderProps", ") => JSX.Element" ], "description": [], "label": "getSavedObjectFinder", "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 526 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isErrorNonFatal", "type": "Function", "label": "isErrorNonFatal", "signature": [ "(error: { message: string; }) => boolean" ], "description": [], "children": [ { "id": "def-public.isErrorNonFatal.error", "type": "Object", "label": "error", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.isErrorNonFatal.error.message", "type": "string", "label": "message", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts", "lineNumber": 23 } } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts", "lineNumber": 23 } } ], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_saved_object.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectSaveModalOrigin", "type": "Function", "label": "SavedObjectSaveModalOrigin", "signature": [ "(props: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.OriginSaveModalProps", "text": "OriginSaveModalProps" }, ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.OriginSaveModalProps", "text": "OriginSaveModalProps" } ], "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 34 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.saveWithConfirmation", "type": "Function", "label": "saveWithConfirmation", "signature": [ "(source: ", "SavedObjectAttributes", ", savedObject: { getEsType(): string; title: string; displayName: string; }, options: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, ", services: { savedObjectsClient: Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">; overlays: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayStart", "text": "OverlayStart" }, "; }) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" } ], "description": [ "\nAttempts to create the current object using the serialized source. If an object already\nexists, a warning message requests an overwrite confirmation." ], "children": [ { "type": "Object", "label": "source", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectAttributes", "text": "SavedObjectAttributes" } ], "description": [ "- serialized version of this object what will be indexed into elasticsearch." ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 34 } }, { "id": "def-public.saveWithConfirmation.savedObject", "type": "Object", "label": "savedObject", "tags": [], "description": [], "children": [ { "id": "def-public.saveWithConfirmation.savedObject.getEsType", "type": "Function", "label": "getEsType", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 36 } }, { "tags": [], "id": "def-public.saveWithConfirmation.savedObject.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 37 } }, { "tags": [], "id": "def-public.saveWithConfirmation.savedObject.displayName", "type": "string", "label": "displayName", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 38 } } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 35 } }, { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" } ], "description": [ "- options to pass to the saved object create method" ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 40 } }, { "id": "def-public.saveWithConfirmation.services", "type": "Object", "label": "services", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.saveWithConfirmation.services.savedObjectsClient", "type": "Object", "label": "savedObjectsClient", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 41 }, "signature": [ "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" ] }, { "tags": [], "id": "def-public.saveWithConfirmation.services.overlays", "type": "Object", "label": "overlays", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 41 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayStart", "text": "OverlayStart" } ] } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 41 } } ], "tags": [ "resolved" ], "returnComment": [ "- A promise that is resolved with the objects id if the object is\nsuccessfully indexed. If the overwrite confirmation was rejected, an error is thrown with\na confirmRejected = true parameter so that case can be handled differently than\na create or index error." ], "source": { "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "lineNumber": 33 }, "initialIsOpen": false }, { "id": "def-public.showSaveModal", "type": "Function", "label": "showSaveModal", "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" ], "description": [], "children": [ { "type": "Object", "label": "saveModal", "isRequired": true, "signature": [ "React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "lineNumber": 33 } }, { "type": "Function", "label": "I18nContext", "isRequired": true, "signature": [ "({ children }: { children: React.ReactNode; }) => JSX.Element" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "lineNumber": 34 } }, { "type": "Function", "label": "Wrapper", "isRequired": false, "signature": [ "React.FC<{}> | undefined" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "lineNumber": 35 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "lineNumber": 32 }, "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.OnSaveProps", "type": "Interface", "label": "OnSaveProps", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.OnSaveProps.newTitle", "type": "string", "label": "newTitle", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 35 } }, { "tags": [], "id": "def-public.OnSaveProps.newCopyOnSave", "type": "boolean", "label": "newCopyOnSave", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 36 } }, { "tags": [], "id": "def-public.OnSaveProps.isTitleDuplicateConfirmed", "type": "boolean", "label": "isTitleDuplicateConfirmed", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 37 } }, { "tags": [], "id": "def-public.OnSaveProps.onTitleDuplicate", "type": "Function", "label": "onTitleDuplicate", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 38 }, "signature": [ "() => void" ] }, { "tags": [], "id": "def-public.OnSaveProps.newDescription", "type": "string", "label": "newDescription", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 39 } } ], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.OriginSaveModalProps", "type": "Interface", "label": "OriginSaveModalProps", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.OriginSaveModalProps.originatingApp", "type": "string", "label": "originatingApp", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 23 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.getAppNameFromId", "type": "Function", "label": "getAppNameFromId", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 24 }, "signature": [ "((appId: string) => string | undefined) | undefined" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.originatingAppName", "type": "string", "label": "originatingAppName", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 25 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.returnToOriginSwitchLabel", "type": "string", "label": "returnToOriginSwitchLabel", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 26 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.documentInfo", "type": "Object", "label": "documentInfo", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 27 }, "signature": [ "SaveModalDocumentInfo" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.objectType", "type": "string", "label": "objectType", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 28 } }, { "tags": [], "id": "def-public.OriginSaveModalProps.onClose", "type": "Function", "label": "onClose", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 29 }, "signature": [ "() => void" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.options", "type": "CompoundType", "label": "options", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 30 }, "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" ] }, { "tags": [], "id": "def-public.OriginSaveModalProps.onSave", "type": "Function", "label": "onSave", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 31 }, "signature": [ "(props: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.OnSaveProps", "text": "OnSaveProps" }, " & { returnToOrigin: boolean; }) => void" ] } ], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "lineNumber": 22 }, "initialIsOpen": false }, { "id": "def-public.SavedObject", "type": "Interface", "label": "SavedObject", "description": [], "tags": [ "deprecated" ], "children": [ { "tags": [], "id": "def-public.SavedObject._serialize", "type": "Function", "label": "_serialize", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 26 }, "signature": [ "() => { attributes: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectAttributes", "text": "SavedObjectAttributes" }, "; references: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ] }, { "tags": [], "id": "def-public.SavedObject._source", "type": "Object", "label": "_source", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 27 }, "signature": [ "Record" ] }, { "tags": [], "id": "def-public.SavedObject.applyESResp", "type": "Function", "label": "applyESResp", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 28 }, "signature": [ "(resp: Record) => Promise<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ">" ] }, { "tags": [], "id": "def-public.SavedObject.copyOnSave", "type": "boolean", "label": "copyOnSave", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 29 } }, { "tags": [], "id": "def-public.SavedObject.creationOpts", "type": "Function", "label": "creationOpts", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 30 }, "signature": [ "(opts: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectCreationOpts", "text": "SavedObjectCreationOpts" }, ") => Record" ] }, { "tags": [], "id": "def-public.SavedObject.defaults", "type": "Any", "label": "defaults", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 31 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.SavedObject.delete", "type": "Function", "label": "delete", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 32 }, "signature": [ "(() => Promise<{}>) | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.destroy", "type": "Function", "label": "destroy", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 33 }, "signature": [ "() => void" ] }, { "tags": [], "id": "def-public.SavedObject.getDisplayName", "type": "Function", "label": "getDisplayName", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 34 }, "signature": [ "() => string" ] }, { "tags": [], "id": "def-public.SavedObject.getEsType", "type": "Function", "label": "getEsType", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 35 }, "signature": [ "() => string" ] }, { "tags": [], "id": "def-public.SavedObject.getFullPath", "type": "Function", "label": "getFullPath", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 36 }, "signature": [ "() => string" ] }, { "tags": [], "id": "def-public.SavedObject.hydrateIndexPattern", "type": "Function", "label": "hydrateIndexPattern", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 37 }, "signature": [ "((id?: string | undefined) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IIndexPattern", "text": "IIndexPattern" }, " | null>) | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 38 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.init", "type": "Function", "label": "init", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 39 }, "signature": [ "(() => Promise<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ">) | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.isSaving", "type": "boolean", "label": "isSaving", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 40 } }, { "tags": [], "id": "def-public.SavedObject.isTitleChanged", "type": "Function", "label": "isTitleChanged", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 41 }, "signature": [ "() => boolean" ] }, { "tags": [], "id": "def-public.SavedObject.lastSavedTitle", "type": "string", "label": "lastSavedTitle", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 42 } }, { "tags": [], "id": "def-public.SavedObject.migrationVersion", "type": "Object", "label": "migrationVersion", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 43 }, "signature": [ "Record | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.save", "type": "Function", "label": "save", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 44 }, "signature": [ "(saveOptions: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectSaveOpts", "text": "SavedObjectSaveOpts" }, ") => Promise" ] }, { "tags": [], "id": "def-public.SavedObject.searchSource", "type": "Object", "label": "searchSource", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 45 }, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.searchSourceFields", "type": "Object", "label": "searchSourceFields", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 46 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ] }, { "tags": [], "id": "def-public.SavedObject.showInRecentlyAccessed", "type": "boolean", "label": "showInRecentlyAccessed", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 47 } }, { "tags": [], "id": "def-public.SavedObject.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 48 } }, { "tags": [], "id": "def-public.SavedObject.unresolvedIndexPatternReference", "type": "Object", "label": "unresolvedIndexPatternReference", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 49 }, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, " | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 25 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectConfig", "type": "Interface", "label": "SavedObjectConfig", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectConfig.afterESResp", "type": "Function", "label": "afterESResp", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 79 }, "signature": [ "((savedObject: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ") => Promise<", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ">) | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.defaults", "type": "Any", "label": "defaults", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 80 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.extractReferences", "type": "Function", "label": "extractReferences", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 81 }, "signature": [ "((opts: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectAttributesAndRefs", "text": "SavedObjectAttributesAndRefs" }, ") => ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectAttributesAndRefs", "text": "SavedObjectAttributesAndRefs" }, ") | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.injectReferences", "type": "Function", "label": "injectReferences", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 82 }, "signature": [ "((object: T, references: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => void) | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 83 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.init", "type": "Function", "label": "init", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 84 }, "signature": [ "(() => void) | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.indexPattern", "type": "Object", "label": "indexPattern", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 85 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IIndexPattern", "text": "IIndexPattern" }, " | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.mapping", "type": "Object", "label": "mapping", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 86 }, "signature": [ "Record | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.migrationVersion", "type": "Object", "label": "migrationVersion", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 87 }, "signature": [ "Record | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.path", "type": "string", "label": "path", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 88 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.searchSource", "type": "CompoundType", "label": "searchSource", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 89 }, "signature": [ "boolean | Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectConfig.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 90 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 77 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectDecorator", "type": "Interface", "label": "SavedObjectDecorator", "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectDecorator", "text": "SavedObjectDecorator" }, "" ], "description": [], "tags": [], "children": [ { "id": "def-public.SavedObjectDecorator.getId", "type": "Function", "label": "getId", "signature": [ "() => string" ], "description": [ "\nId of the decorator" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-public.SavedObjectDecorator.decorateConfig", "type": "Function", "label": "decorateConfig", "description": [ "\nDecorate the saved object provided config. This can be used to enhance or alter the object's provided\nconfiguration." ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "lineNumber": 21 }, "signature": [ "(config: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectConfig", "text": "SavedObjectConfig" }, ") => void" ] }, { "tags": [], "id": "def-public.SavedObjectDecorator.decorateObject", "type": "Function", "label": "decorateObject", "description": [ "\nDecorate the saved object instance. Can be used to add additional methods to it.\n" ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "lineNumber": 28 }, "signature": [ "(object: T) => void" ] } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectDecoratorConfig", "type": "Interface", "label": "SavedObjectDecoratorConfig", "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectDecoratorConfig", "text": "SavedObjectDecoratorConfig" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectDecoratorConfig.id", "type": "string", "label": "id", "description": [ "\nThe id of the decorator" ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-public.SavedObjectDecoratorConfig.priority", "type": "number", "label": "priority", "description": [ "\nHighest priority will be called **last**\n(the decoration will be at the highest level)" ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "lineNumber": 22 } }, { "tags": [], "id": "def-public.SavedObjectDecoratorConfig.factory", "type": "Function", "label": "factory", "description": [ "\nThe factory to use to create the decorator" ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "lineNumber": 26 }, "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectDecoratorFactory", "text": "SavedObjectDecoratorFactory" }, "" ] } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts", "lineNumber": 13 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectLoaderFindOptions", "type": "Interface", "label": "SavedObjectLoaderFindOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectLoaderFindOptions.size", "type": "number", "label": "size", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 19 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectLoaderFindOptions.fields", "type": "Array", "label": "fields", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 20 }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectLoaderFindOptions.hasReference", "type": "Array", "label": "hasReference", "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 21 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, "[] | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectMetaData", "type": "Interface", "label": "SavedObjectMetaData", "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectMetaData", "text": "SavedObjectMetaData" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectMetaData.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 44 } }, { "tags": [], "id": "def-public.SavedObjectMetaData.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 45 } }, { "id": "def-public.SavedObjectMetaData.getIconForSavedObject", "type": "Function", "label": "getIconForSavedObject", "signature": [ "(savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => ", "IconType" ], "description": [], "children": [ { "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 46 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 46 } }, { "id": "def-public.SavedObjectMetaData.getTooltipForSavedObject", "type": "Function", "label": "getTooltipForSavedObject", "signature": [ "((savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => string) | undefined" ], "description": [], "children": [ { "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 47 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 47 } }, { "id": "def-public.SavedObjectMetaData.showSavedObject", "type": "Function", "label": "showSavedObject", "signature": [ "((savedObject: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, ") => boolean) | undefined" ], "description": [], "children": [ { "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, "" ], "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 48 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 48 } }, { "tags": [], "id": "def-public.SavedObjectMetaData.includeFields", "type": "Array", "label": "includeFields", "description": [], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 49 }, "signature": [ "string[] | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", "lineNumber": 43 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectSaveOpts", "type": "Interface", "label": "SavedObjectSaveOpts", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectSaveOpts.confirmOverwrite", "type": "CompoundType", "label": "confirmOverwrite", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 53 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectSaveOpts.isTitleDuplicateConfirmed", "type": "CompoundType", "label": "isTitleDuplicateConfirmed", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 54 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectSaveOpts.onTitleDuplicate", "type": "Function", "label": "onTitleDuplicate", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 55 }, "signature": [ "(() => void) | undefined" ] }, { "tags": [], "id": "def-public.SavedObjectSaveOpts.returnToOrigin", "type": "CompoundType", "label": "returnToOrigin", "description": [], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 56 }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/saved_objects/public/types.ts", "lineNumber": 52 }, "initialIsOpen": false }, { "id": "def-public.SaveModalState", "type": "Interface", "label": "SaveModalState", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SaveModalState.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 59 } }, { "tags": [], "id": "def-public.SaveModalState.copyOnSave", "type": "boolean", "label": "copyOnSave", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 60 } }, { "tags": [], "id": "def-public.SaveModalState.isTitleDuplicateConfirmed", "type": "boolean", "label": "isTitleDuplicateConfirmed", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 61 } }, { "tags": [], "id": "def-public.SaveModalState.hasTitleDuplicate", "type": "boolean", "label": "hasTitleDuplicate", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 62 } }, { "tags": [], "id": "def-public.SaveModalState.isLoading", "type": "boolean", "label": "isLoading", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 63 } }, { "tags": [], "id": "def-public.SaveModalState.visualizationDescription", "type": "string", "label": "visualizationDescription", "description": [], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 64 } } ], "source": { "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "lineNumber": 58 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "tags": [], "id": "def-public.LISTING_LIMIT_SETTING", "type": "string", "label": "LISTING_LIMIT_SETTING", "description": [], "source": { "path": "src/plugins/saved_objects/common/index.ts", "lineNumber": 10 }, "signature": [ "\"savedObjects:listingLimit\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.PER_PAGE_SETTING", "type": "string", "label": "PER_PAGE_SETTING", "description": [], "source": { "path": "src/plugins/saved_objects/common/index.ts", "lineNumber": 9 }, "signature": [ "\"savedObjects:perPage\"" ], "initialIsOpen": false }, { "id": "def-public.SavedObjectDecoratorFactory", "type": "Type", "label": "SavedObjectDecoratorFactory", "tags": [], "description": [], "source": { "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "lineNumber": 31 }, "signature": [ "(services: ", "SavedObjectKibanaServices", ") => ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectDecorator", "text": "SavedObjectDecorator" }, "" ], "initialIsOpen": false }, { "id": "def-public.SaveResult", "type": "Type", "label": "SaveResult", "tags": [], "description": [ "\nRepresents the result of trying to persist the saved object.\nContains `error` prop if something unexpected happened (e.g. network error).\nContains an `id` if persisting was successful. If `id` and\n`error` are undefined, persisting was not successful, but the\nmodal can still recover (e.g. the name of the saved object was already taken)." ], "source": { "path": "src/plugins/saved_objects/public/save_modal/show_saved_object_save_modal.tsx", "lineNumber": 21 }, "signature": [ "{ id?: string | undefined; } | { error: Error; }" ], "initialIsOpen": false } ], "objects": [], "start": { "id": "def-public.SavedObjectsStart", "type": "Interface", "label": "SavedObjectsStart", "description": [], "tags": [], "children": [ { "tags": [ "deprecated" ], "id": "def-public.SavedObjectsStart.SavedObjectClass", "type": "Object", "label": "SavedObjectClass", "description": [], "source": { "path": "src/plugins/saved_objects/public/plugin.ts", "lineNumber": 27 }, "signature": [ "new (raw: Record) => ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" } ] }, { "tags": [ "deprecated" ], "id": "def-public.SavedObjectsStart.settings", "type": "Object", "label": "settings", "description": [], "source": { "path": "src/plugins/saved_objects/public/plugin.ts", "lineNumber": 29 }, "signature": [ "{ getPerPage: () => number; getListingLimit: () => number; }" ] } ], "source": { "path": "src/plugins/saved_objects/public/plugin.ts", "lineNumber": 25 }, "lifecycle": "start", "initialIsOpen": true }, "setup": { "id": "def-public.SavedObjectSetup", "type": "Interface", "label": "SavedObjectSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectSetup.registerDecorator", "type": "Function", "label": "registerDecorator", "description": [], "source": { "path": "src/plugins/saved_objects/public/plugin.ts", "lineNumber": 22 }, "signature": [ "(config: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectDecoratorConfig", "text": "SavedObjectDecoratorConfig" }, ") => void" ] } ], "source": { "path": "src/plugins/saved_objects/public/plugin.ts", "lineNumber": 21 }, "lifecycle": "setup", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "tags": [], "id": "def-common.LISTING_LIMIT_SETTING", "type": "string", "label": "LISTING_LIMIT_SETTING", "description": [], "source": { "path": "src/plugins/saved_objects/common/index.ts", "lineNumber": 10 }, "signature": [ "\"savedObjects:listingLimit\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.PER_PAGE_SETTING", "type": "string", "label": "PER_PAGE_SETTING", "description": [], "source": { "path": "src/plugins/saved_objects/common/index.ts", "lineNumber": 9 }, "signature": [ "\"savedObjects:perPage\"" ], "initialIsOpen": false } ], "objects": [] } }