{ "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": "packages/kbn-unified-doc-viewer/src/services/doc_views_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/unified-doc-viewer", "id": "def-common.DocViewsRegistry.addDocView", "type": "Function", "tags": [], "label": "addDocView", "description": [ "\nExtends and adds the given doc view to the registry array" ], "signature": [ "(docViewRaw: ", "DocViewInput", " | ", "DocViewInputFn", ") => void" ], "path": "packages/kbn-unified-doc-viewer/src/services/doc_views_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/unified-doc-viewer", "id": "def-common.DocViewsRegistry.addDocView.$1", "type": "CompoundType", "tags": [], "label": "docViewRaw", "description": [], "signature": [ "DocViewInput", " | ", "DocViewInputFn" ], "path": "packages/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.getDocViewsSorted", "type": "Function", "tags": [], "label": "getDocViewsSorted", "description": [ "\nReturns a sorted array of doc_views for rendering tabs" ], "signature": [ "(hit: ", "DataTableRecord", ") => ", "DocView", "[]" ], "path": "packages/kbn-unified-doc-viewer/src/services/doc_views_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/unified-doc-viewer", "id": "def-common.DocViewsRegistry.getDocViewsSorted.$1", "type": "Object", "tags": [], "label": "hit", "description": [], "signature": [ "DataTableRecord" ], "path": "packages/kbn-unified-doc-viewer/src/services/doc_views_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "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", ") => JSX.Element | null" ], "path": "packages/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": "packages/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) => JSX.Element" ], "path": "packages/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": "packages/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": "packages/kbn-unified-doc-viewer/src/services/doc_views_registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [], "objects": [] } }