kibana/api_docs/saved_objects_finder.devdocs.json

596 lines
No EOL
20 KiB
JSON

{
"id": "savedObjectsFinder",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.getSavedObjectFinder",
"type": "Function",
"tags": [],
"label": "getSavedObjectFinder",
"description": [],
"signature": [
"(contentClient: ",
{
"pluginId": "contentManagement",
"scope": "public",
"docId": "kibContentManagementPluginApi",
"section": "def-public.ContentClient",
"text": "ContentClient"
},
", uiSettings: ",
"IUiSettingsClient",
", savedObjectsTagging?: ",
{
"pluginId": "savedObjectsTaggingOss",
"scope": "public",
"docId": "kibSavedObjectsTaggingOssPluginApi",
"section": "def-public.SavedObjectsTaggingApi",
"text": "SavedObjectsTaggingApi"
},
" | undefined) => (props: ",
{
"pluginId": "@kbn/shared-ux-table-persist",
"scope": "common",
"docId": "kibKbnSharedUxTablePersistPluginApi",
"section": "def-common.HOCProps",
"text": "HOCProps"
},
"<",
"SavedObjectFinderItem",
", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
},
">) => React.JSX.Element"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.getSavedObjectFinder.$1",
"type": "Object",
"tags": [],
"label": "contentClient",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "public",
"docId": "kibContentManagementPluginApi",
"section": "def-public.ContentClient",
"text": "ContentClient"
}
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.getSavedObjectFinder.$2",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
"IUiSettingsClient"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.getSavedObjectFinder.$3",
"type": "Object",
"tags": [],
"label": "savedObjectsTagging",
"description": [],
"signature": [
{
"pluginId": "savedObjectsTaggingOss",
"scope": "public",
"docId": "kibSavedObjectsTaggingOssPluginApi",
"section": "def-public.SavedObjectsTaggingApi",
"text": "SavedObjectsTaggingApi"
},
" | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectFinder",
"type": "Function",
"tags": [],
"label": "SavedObjectFinder",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/shared-ux-table-persist",
"scope": "common",
"docId": "kibKbnSharedUxTablePersistPluginApi",
"section": "def-common.HOCProps",
"text": "HOCProps"
},
"<",
"SavedObjectFinderItem",
", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
},
">) => React.JSX.Element"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectFinder.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/shared-ux-table-persist",
"scope": "common",
"docId": "kibKbnSharedUxTablePersistPluginApi",
"section": "def-common.HOCProps",
"text": "HOCProps"
},
"<",
"SavedObjectFinderItem",
", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
},
">"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData",
"type": "Interface",
"tags": [],
"label": "SavedObjectMetaData",
"description": [],
"signature": [
{
"pluginId": "savedObjectsFinder",
"scope": "public",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-public.SavedObjectMetaData",
"text": "SavedObjectMetaData"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getIconForSavedObject",
"type": "Function",
"tags": [],
"label": "getIconForSavedObject",
"description": [],
"signature": [
"(savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>) => ",
"IconType"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getIconForSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getTooltipForSavedObject",
"type": "Function",
"tags": [],
"label": "getTooltipForSavedObject",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>) => string) | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getTooltipForSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.showSavedObject",
"type": "Function",
"tags": [],
"label": "showSavedObject",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>) => boolean) | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.showSavedObject.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getSavedObjectSubType",
"type": "Function",
"tags": [],
"label": "getSavedObjectSubType",
"description": [],
"signature": [
"((savedObject: ",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>) => string) | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.getSavedObjectSubType.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectMetaData.includeFields",
"type": "Array",
"tags": [
"deprecated"
],
"label": "includeFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "visualizations",
"path": "src/platform/plugins/shared/visualizations/public/wizard/search_selection/search_selection.tsx"
},
{
"plugin": "graph",
"path": "x-pack/platform/plugins/private/graph/public/components/source_picker.tsx"
}
]
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-public.SavedObjectFinderProps",
"type": "Type",
"tags": [],
"label": "SavedObjectFinderProps",
"description": [],
"signature": [
"SavedObjectFinderFixedPage | SavedObjectFinderInitialPageSize"
],
"path": "src/platform/plugins/shared/saved_objects_finder/public/finder/saved_object_finder.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.FinderAttributes",
"type": "Interface",
"tags": [],
"label": "FinderAttributes",
"description": [],
"path": "src/platform/plugins/shared/saved_objects_finder/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.FinderAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.FinderAttributes.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.FinderAttributes.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_objects_finder/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.LISTING_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "LISTING_LIMIT_SETTING",
"description": [],
"signature": [
"\"savedObjects:listingLimit\""
],
"path": "src/platform/packages/private/kbn-saved-objects-settings/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.PER_PAGE_SETTING",
"type": "string",
"tags": [],
"label": "PER_PAGE_SETTING",
"description": [],
"signature": [
"\"savedObjects:perPage\""
],
"path": "src/platform/packages/private/kbn-saved-objects-settings/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedObjectsFinder",
"id": "def-common.SavedObjectCommon",
"type": "Type",
"tags": [],
"label": "SavedObjectCommon",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.SOWithMetadata",
"text": "SOWithMetadata"
},
"<T>"
],
"path": "src/platform/plugins/shared/saved_objects_finder/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}