kibana/api_docs/kbn_unified_doc_viewer.devdocs.json

342 lines
No EOL
12 KiB
JSON

{
"id": "@kbn/unified-doc-viewer",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry",
"type": "Class",
"tags": [],
"label": "DocViewsRegistry",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "initialValue",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-doc-viewer",
"scope": "common",
"docId": "kibKbnUnifiedDocViewerPluginApi",
"section": "def-common.DocViewsRegistry",
"text": "DocViewsRegistry"
},
" | ",
"DocView",
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => ",
"DocView",
"[]"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(docViewRaw: ",
"DocView",
" | ",
"DocViewFactory",
") => void"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.add.$1",
"type": "CompoundType",
"tags": [],
"label": "docViewRaw",
"description": [],
"signature": [
"DocView",
" | ",
"DocViewFactory"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.removeById",
"type": "Function",
"tags": [],
"label": "removeById",
"description": [],
"signature": [
"(id: string) => void"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.removeById.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.enableById",
"type": "Function",
"tags": [],
"label": "enableById",
"description": [],
"signature": [
"(id: string) => void"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.enableById.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.disableById",
"type": "Function",
"tags": [],
"label": "disableById",
"description": [],
"signature": [
"(id: string) => void"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.disableById.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewsRegistry.clone",
"type": "Function",
"tags": [],
"label": "clone",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/unified-doc-viewer",
"scope": "common",
"docId": "kibKbnUnifiedDocViewerPluginApi",
"section": "def-common.DocViewsRegistry",
"text": "DocViewsRegistry"
}
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewer",
"type": "Function",
"tags": [],
"label": "DocViewer",
"description": [
"\nRendering tabs with different views of 1 Elasticsearch hit in Discover.\nThe tabs are provided by the `docs_views` registry.\nA view can contain a React `component`, or any JS framework by using\na `render` function."
],
"signature": [
"({ docViews, ...renderProps }: ",
"DocViewerProps",
") => React.JSX.Element | null"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/components/doc_viewer/doc_viewer.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.DocViewer.$1",
"type": "Object",
"tags": [],
"label": "{ docViews, ...renderProps }",
"description": [],
"signature": [
"DocViewerProps"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/components/doc_viewer/doc_viewer.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.FieldName",
"type": "Function",
"tags": [],
"label": "FieldName",
"description": [],
"signature": [
"({\n fieldName,\n fieldMapping,\n fieldType,\n fieldIconProps,\n scripted = false,\n highlight = '',\n}: Props) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/components/field_name/field_name.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.FieldName.$1",
"type": "Object",
"tags": [],
"label": "{\n fieldName,\n fieldMapping,\n fieldType,\n fieldIconProps,\n scripted = false,\n highlight = '',\n}",
"description": [],
"signature": [
"Props"
],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/components/field_name/field_name.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"parentPluginId": "@kbn/unified-doc-viewer",
"id": "def-common.ElasticRequestState",
"type": "Enum",
"tags": [],
"label": "ElasticRequestState",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-doc-viewer/src/services/doc_views_registry.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": []
}
}