{ "id": "savedObjectsTaggingOss", "client": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.GetSearchBarFilterOptions", "type": "Interface", "tags": [], "label": "GetSearchBarFilterOptions", "description": [ "\nOptions for the {@link SavedObjectsTaggingApiUi.getSearchBarFilter | getSearchBarFilter api}\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.GetSearchBarFilterOptions.useName", "type": "CompoundType", "tags": [], "label": "useName", "description": [ "\nIf set to true, will use the tag's `name` instead of `id` for the tag field clause, which is recommended\nfor a better end-user experience.\n\nDefaults to true.\n" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.GetSearchBarFilterOptions.tagField", "type": "string", "tags": [], "label": "tagField", "description": [ "\nThe tag clause field name to generate the query. Defaults to `tag`.\n" ], "signature": [ "string | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ITagsCache", "type": "Interface", "tags": [], "label": "ITagsCache", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ITagsCache.getState", "type": "Function", "tags": [], "label": "getState", "description": [ "\nReturn the current state of the cache" ], "signature": [ "() => ", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, "[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ITagsCache.getState$", "type": "Function", "tags": [], "label": "getState$", "description": [ "\nReturn an observable that will emit everytime the cache's state mutates." ], "signature": [ "() => ", "Observable", "<", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, "[]>" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParsedSearchQuery", "type": "Interface", "tags": [], "label": "ParsedSearchQuery", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParsedSearchQuery.searchTerm", "type": "string", "tags": [], "label": "searchTerm", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParsedSearchQuery.tagReferences", "type": "Array", "tags": [], "label": "tagReferences", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, "[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParsedSearchQuery.valid", "type": "boolean", "tags": [], "label": "valid", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParseSearchQueryOptions", "type": "Interface", "tags": [], "label": "ParseSearchQueryOptions", "description": [ "\nOptions for the {@link SavedObjectsTaggingApiUi.parseSearchQuery | parseSearchQuery api}\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParseSearchQueryOptions.useName", "type": "CompoundType", "tags": [], "label": "useName", "description": [ "\nIf set to true, will assume the tag clause is using tag names instead of ids.\nIn that case, will perform a reverse lookup from the client-side tag cache to resolve tag ids from names.\n\nDefaults to true.\n" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.ParseSearchQueryOptions.tagField", "type": "string", "tags": [], "label": "tagField", "description": [ "\nThe tag clause field name to extract the tags from. Defaults to `tag`.\n" ], "signature": [ "string | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectSaveModalTagSelectorComponentProps", "type": "Interface", "tags": [], "label": "SavedObjectSaveModalTagSelectorComponentProps", "description": [ "\nProps type for the {@link SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector | SavedObjectSaveModalTagSelector component}\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectSaveModalTagSelectorComponentProps.initialSelection", "type": "Array", "tags": [], "label": "initialSelection", "description": [ "\nIds of the initially selected tags.\nChanging the value of this prop after initial mount will not rerender the component (see component description for more details)" ], "signature": [ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectSaveModalTagSelectorComponentProps.onTagsSelected", "type": "Function", "tags": [], "label": "onTagsSelected", "description": [ "\ntags selection callback" ], "signature": [ "(ids: string[]) => void" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectSaveModalTagSelectorComponentProps.onTagsSelected.$1", "type": "Array", "tags": [], "label": "ids", "description": [], "signature": [ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApi", "type": "Interface", "tags": [], "label": "SavedObjectsTaggingApi", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApi.client", "type": "Object", "tags": [], "label": "client", "description": [ "\nThe client to perform tag-related operations on the server-side" ], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.ITagsClient", "text": "ITagsClient" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApi.cache", "type": "Object", "tags": [], "label": "cache", "description": [ "\nA client-side auto-refreshing cache of the existing tags. Can be used\nto synchronously access the list of tags." ], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.ITagsCache", "text": "ITagsCache" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApi.ui", "type": "Object", "tags": [], "label": "ui", "description": [ "\nUI API to use to add tagging capabilities to an application" ], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectsTaggingApiUi", "text": "SavedObjectsTaggingApiUi" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi", "type": "Interface", "tags": [], "label": "SavedObjectsTaggingApiUi", "description": [ "\nReact components and utility methods to use the SO tagging feature\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTag", "type": "Function", "tags": [], "label": "getTag", "description": [ "\nReturn a Tag from an ID\n" ], "signature": [ "(tagId: string) => ", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTag.$1", "type": "string", "tags": [], "label": "tagId", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.hasTagDecoration", "type": "Function", "tags": [], "label": "hasTagDecoration", "description": [ "\nType-guard to safely manipulate tag-enhanced `SavedObject` from the `savedObject` plugin.\n" ], "signature": [ "(object: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ") => object is ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.TagDecoratedSavedObject", "text": "TagDecoratedSavedObject" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.hasTagDecoration.$1", "type": "Object", "tags": [], "label": "object", "description": [], "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getSearchBarFilter", "type": "Function", "tags": [], "label": "getSearchBarFilter", "description": [ "\nReturn a filter that can be used to filter by tag with `EuiSearchBar` or EUI tables using `EuiSearchBar`.\n" ], "signature": [ "(options?: ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.GetSearchBarFilterOptions", "text": "GetSearchBarFilterOptions" }, " | undefined) => ", "SearchFilterConfig" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getSearchBarFilter.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.GetSearchBarFilterOptions", "text": "GetSearchBarFilterOptions" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTableColumnDefinition", "type": "Function", "tags": [], "label": "getTableColumnDefinition", "description": [ "\nReturn the column definition to be used to display the tags in a EUI table.\nThe table's items must be of the `SavedObject` type (or at least have their references available\nvia the `references` field)\n" ], "signature": [ "() => ", "EuiTableFieldDataColumnType", "<", "SavedObject", ">" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.convertNameToReference", "type": "Function", "tags": [], "label": "convertNameToReference", "description": [ "\nConvert given tag name to a {@link SavedObjectsFindOptionsReference | reference }\nto be used to search using the savedObjects `_find` API. Will return `undefined`\nif the given name does not match any existing tag." ], "signature": [ "(tagName: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.convertNameToReference.$1", "type": "string", "tags": [], "label": "tagName", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.parseSearchQuery", "type": "Function", "tags": [], "label": "parseSearchQuery", "description": [ "\nParse given query using EUI's `Query` syntax, and return the search term and the tag references\nto be used when using the `_find` API to retrieve the filtered objects.\n" ], "signature": [ "(query: string, options?: ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.ParseSearchQueryOptions", "text": "ParseSearchQueryOptions" }, " | undefined) => ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.ParsedSearchQuery", "text": "ParsedSearchQuery" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$1", "type": "string", "tags": [], "label": "query", "description": [ "The query to parse" ], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$2", "type": "Object", "tags": [], "label": "options", "description": [ "see {@link ParseSearchQueryOptions}" ], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.ParseSearchQueryOptions", "text": "ParseSearchQueryOptions" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTagIdsFromReferences", "type": "Function", "tags": [], "label": "getTagIdsFromReferences", "description": [ "\nReturns the object ids for the tag references from given references array" ], "signature": [ "(references: (", "SavedObjectReference", " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, ")[]) => string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTagIdsFromReferences.$1", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "(", "SavedObjectReference", " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, ")[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTagIdFromName", "type": "Function", "tags": [], "label": "getTagIdFromName", "description": [ "\nReturns the id for given tag name. Will return `undefined`\nif the given name does not match any existing tag." ], "signature": [ "(tagName: string) => string | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.getTagIdFromName.$1", "type": "string", "tags": [], "label": "tagName", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.updateTagsReferences", "type": "Function", "tags": [], "label": "updateTagsReferences", "description": [ "\nReturns a new references array that replace the old tag references with references to the\nnew given tag ids, while preserving all non-tag references." ], "signature": [ "(references: ", "SavedObjectReference", "[], newTagIds: string[]) => ", "SavedObjectReference", "[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$1", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$2", "type": "Array", "tags": [], "label": "newTagIds", "description": [], "signature": [ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUi.components", "type": "Object", "tags": [], "label": "components", "description": [ "\n{@link SavedObjectsTaggingApiUiComponent | React components} to support the tagging feature." ], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectsTaggingApiUiComponent", "text": "SavedObjectsTaggingApiUiComponent" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent", "type": "Interface", "tags": [], "label": "SavedObjectsTaggingApiUiComponent", "description": [ "\nReact UI components to be used to display the tagging feature in any application.\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagList", "type": "Function", "tags": [], "label": "TagList", "description": [ "\nDisplays the tags for given saved object." ], "signature": [ "React.FunctionComponent<", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.TagListComponentProps", "text": "TagListComponentProps" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagList.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagList.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagSelector", "type": "Function", "tags": [], "label": "TagSelector", "description": [ "\nWidget to select tags." ], "signature": [ "React.FunctionComponent<", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.TagSelectorComponentProps", "text": "TagSelectorComponentProps" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagSelector.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.TagSelector.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector", "type": "Function", "tags": [], "label": "SavedObjectSaveModalTagSelector", "description": [ "\nComponent to be used with the `options` property of the `SavedObjectSaveModal` or `SavedObjectSaveModalOrigin`\nmodals from the `savedObjects` plugin. It displays the whole field row and handles the 'stateless' nature\nof props passed to inline components" ], "signature": [ "React.FunctionComponent<", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectSaveModalTagSelectorComponentProps", "text": "SavedObjectSaveModalTagSelectorComponentProps" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagListComponentProps", "type": "Interface", "tags": [], "label": "TagListComponentProps", "description": [ "\nProps type for the {@link SavedObjectsTaggingApiUiComponent.TagList | TagList component}\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagListComponentProps.object", "type": "Object", "tags": [], "label": "object", "description": [ "\nThe object to display tags for." ], "signature": [ "SavedObject", "" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagSelectorComponentProps", "type": "Interface", "tags": [], "label": "TagSelectorComponentProps", "description": [ "\nProps type for the {@link SavedObjectsTaggingApiUiComponent.TagSelector | TagSelector component}\n" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagSelectorComponentProps.selected", "type": "Array", "tags": [], "label": "selected", "description": [ "\nIds of the currently selected tags" ], "signature": [ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagSelectorComponentProps.onTagsSelected", "type": "Function", "tags": [], "label": "onTagsSelected", "description": [ "\ntags selection callback" ], "signature": [ "(ids: string[]) => void" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagSelectorComponentProps.onTagsSelected.$1", "type": "Array", "tags": [], "label": "ids", "description": [], "signature": [ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTagDecoratorTypeGuard", "type": "Type", "tags": [], "label": "SavedObjectTagDecoratorTypeGuard", "description": [], "signature": [ "(object: ", { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, ") => object is ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.TagDecoratedSavedObject", "text": "TagDecoratedSavedObject" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTagDecoratorTypeGuard.$1", "type": "Object", "tags": [], "label": "object", "description": [], "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" } ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.TagDecoratedSavedObject", "type": "Type", "tags": [], "label": "TagDecoratedSavedObject", "description": [], "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" }, " & { getTags(): string[]; setTags(tags: string[]): void; }" ], "path": "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginSetup", "type": "Interface", "tags": [], "label": "SavedObjectTaggingOssPluginSetup", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginSetup.registerTaggingApi", "type": "Function", "tags": [], "label": "registerTaggingApi", "description": [ "\nRegister a provider for the tagging API.\n\nOnly one provider can be registered, subsequent calls to this method will fail.\n" ], "signature": [ "(provider: Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, ">) => void" ], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginSetup.registerTaggingApi.$1", "type": "Object", "tags": [], "label": "provider", "description": [], "signature": [ "Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginStart", "type": "Interface", "tags": [], "label": "SavedObjectTaggingOssPluginStart", "description": [], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginStart.isTaggingAvailable", "type": "Function", "tags": [], "label": "isTaggingAvailable", "description": [ "\nReturns true if the tagging feature is available (if a provider registered the API)" ], "signature": [ "() => boolean" ], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-public.SavedObjectTaggingOssPluginStart.getTaggingApi", "type": "Function", "tags": [], "label": "getTaggingApi", "description": [ "\nReturns the tagging API, if registered.\nThis will always returns a value if `isTaggingAvailable` returns true, and undefined otherwise." ], "signature": [ "() => ", { "pluginId": "savedObjectsTaggingOss", "scope": "public", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/types.ts", "deprecated": false, "children": [], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.GetAllTagsOptions", "type": "Interface", "tags": [], "label": "GetAllTagsOptions", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.GetAllTagsOptions.asSystemRequest", "type": "CompoundType", "tags": [], "label": "asSystemRequest", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient", "type": "Interface", "tags": [], "label": "ITagsClient", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.create", "type": "Function", "tags": [], "label": "create", "description": [], "signature": [ "(attributes: ", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.create.$1", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.getAll", "type": "Function", "tags": [], "label": "getAll", "description": [], "signature": [ "(options?: ", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined) => Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, "[]>" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.getAll.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.delete", "type": "Function", "tags": [], "label": "delete", "description": [], "signature": [ "(id: string) => Promise" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.delete.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(id: string, attributes: ", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.update.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.ITagsClient.update.$2", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ { "pluginId": "savedObjectsTaggingOss", "scope": "common", "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } ], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.Tag", "type": "Interface", "tags": [], "label": "Tag", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.Tag.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.Tag.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.Tag.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.Tag.color", "type": "string", "tags": [], "label": "color", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.TagAttributes", "type": "Interface", "tags": [], "label": "TagAttributes", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.TagAttributes.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.TagAttributes.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false }, { "parentPluginId": "savedObjectsTaggingOss", "id": "def-common.TagAttributes.color", "type": "string", "tags": [], "label": "color", "description": [], "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] } }