mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
1840 lines
No EOL
68 KiB
JSON
1840 lines
No EOL
68 KiB
JSON
{
|
|
"id": "@kbn/presentation-containers",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanAddNewPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiCanAddNewPanel",
|
|
"description": [
|
|
"\nA type guard which can be used to determine if a given API can add a new panel."
|
|
],
|
|
"signature": [
|
|
"(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.CanAddNewPanel",
|
|
"text": "CanAddNewPanel"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanAddNewPanel.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanDuplicatePanels",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiCanDuplicatePanels",
|
|
"description": [],
|
|
"signature": [
|
|
"(unknownApi: unknown) => unknownApi is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.CanDuplicatePanels",
|
|
"text": "CanDuplicatePanels"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanDuplicatePanels.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "unknownApi",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanExpandPanels",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiCanExpandPanels",
|
|
"description": [],
|
|
"signature": [
|
|
"(unknownApi: unknown) => unknownApi is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.CanExpandPanels",
|
|
"text": "CanExpandPanels"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiCanExpandPanels.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "unknownApi",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasRuntimeChildState",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "apiHasRuntimeChildState",
|
|
"description": [],
|
|
"signature": [
|
|
"<RuntimeState extends object = object>(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasRuntimeChildState",
|
|
"text": "HasRuntimeChildState"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "embeddable",
|
|
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx"
|
|
},
|
|
{
|
|
"plugin": "embeddable",
|
|
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasRuntimeChildState.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasSaveNotification",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiHasSaveNotification",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSaveNotification",
|
|
"text": "HasSaveNotification"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/has_save_notification.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasSaveNotification.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/has_save_notification.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasSerializedChildState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiHasSerializedChildState",
|
|
"description": [],
|
|
"signature": [
|
|
"<SerializedState extends object = object>(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSerializedChildState",
|
|
"text": "HasSerializedChildState"
|
|
},
|
|
"<SerializedState>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiHasSerializedChildState.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiIsPresentationContainer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiIsPresentationContainer",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiIsPresentationContainer.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiPublishesSettings",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiPublishesSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"(unknownApi: unknown) => unknownApi is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PublishesSettings",
|
|
"text": "PublishesSettings"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/publishes_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.apiPublishesSettings.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "unknownApi",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/publishes_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.canTrackContentfulRender",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "canTrackContentfulRender",
|
|
"description": [],
|
|
"signature": [
|
|
"(root: unknown) => root is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.TrackContentfulRender",
|
|
"text": "TrackContentfulRender"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/performance_trackers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.canTrackContentfulRender.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "root",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/performance_trackers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.childrenUnsavedChanges$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "childrenUnsavedChanges$",
|
|
"description": [
|
|
"\n Create an observable stream of unsaved changes from all react embeddable children"
|
|
],
|
|
"signature": [
|
|
"(children$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<{ [key: string]: unknown; }>) => ",
|
|
"Observable",
|
|
"<{ [key: string]: object; } | undefined>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/children_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.childrenUnsavedChanges$.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "children$",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<{ [key: string]: unknown; }>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/children_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "combineCompatibleChildrenApis",
|
|
"description": [],
|
|
"signature": [
|
|
"<ApiType extends unknown, PublishingSubjectType>(api: unknown, observableKey: keyof ApiType, isCompatible: (api: unknown) => api is ApiType, emptyState: PublishingSubjectType, flattenMethod?: ((array: PublishingSubjectType[]) => PublishingSubjectType) | undefined) => ",
|
|
"Observable",
|
|
"<PublishingSubjectType>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "observableKey",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof ApiType"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCompatible",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => api is ApiType"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis.$4",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "emptyState",
|
|
"description": [],
|
|
"signature": [
|
|
"PublishingSubjectType"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.combineCompatibleChildrenApis.$5",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "flattenMethod",
|
|
"description": [],
|
|
"signature": [
|
|
"((array: PublishingSubjectType[]) => PublishingSubjectType) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.getContainerParentFromAPI",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getContainerParentFromAPI",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.getContainerParentFromAPI.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.initializeUnsavedChanges",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "initializeUnsavedChanges",
|
|
"description": [],
|
|
"signature": [
|
|
"<RuntimeState extends {} = {}>(initialLastSavedState: RuntimeState, parentApi: unknown, comparators: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.StateComparators",
|
|
"text": "StateComparators"
|
|
},
|
|
"<RuntimeState>) => { api: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesUnsavedChanges",
|
|
"text": "PublishesUnsavedChanges"
|
|
},
|
|
"<RuntimeState> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasSnapshottableState",
|
|
"text": "HasSnapshottableState"
|
|
},
|
|
"<RuntimeState>; cleanup: () => void; }"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.initializeUnsavedChanges.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "initialLastSavedState",
|
|
"description": [],
|
|
"signature": [
|
|
"RuntimeState"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.initializeUnsavedChanges.$2",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "parentApi",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.initializeUnsavedChanges.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "comparators",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.StateComparators",
|
|
"text": "StateComparators"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.listenForCompatibleApi",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listenForCompatibleApi",
|
|
"description": [],
|
|
"signature": [
|
|
"<ApiType extends unknown>(parent: unknown, isCompatible: (api: unknown) => api is ApiType, apiFound: (api: ApiType | undefined) => void | (() => void)) => () => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.listenForCompatibleApi.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.listenForCompatibleApi.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCompatible",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => api is ApiType"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.listenForCompatibleApi.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiFound",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: ApiType | undefined) => void | (() => void)"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.tracksOverlays",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "tracksOverlays",
|
|
"description": [],
|
|
"signature": [
|
|
"(root: unknown) => root is ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.TracksOverlays",
|
|
"text": "TracksOverlays"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.tracksOverlays.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "root",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanAddNewPanel",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CanAddNewPanel",
|
|
"description": [
|
|
"\nThis API can add a new panel as a child."
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanAddNewPanel.addNewPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addNewPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"<SerializedState extends object, ApiType extends unknown = unknown>(panel: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<SerializedState, object>, displaySuccessMessage?: boolean | undefined) => Promise<ApiType | undefined>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanAddNewPanel.addNewPanel.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panel",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<SerializedState, object>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanAddNewPanel.addNewPanel.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "displaySuccessMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/can_add_new_panel.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanDuplicatePanels",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CanDuplicatePanels",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanDuplicatePanels.duplicatePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "duplicatePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(panelId: string) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanDuplicatePanels.duplicatePanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanExpandPanels",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CanExpandPanels",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanExpandPanels.expandPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "expandPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(panelId: string) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanExpandPanels.expandPanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.CanExpandPanels.expandedPanelId$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "expandedPanelId$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: string | undefined; error: (err: any) => void; forEach: { (next: (value: string | undefined) => void): Promise<void>; (next: (value: string | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => string | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<string | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; operator: ",
|
|
"Operator",
|
|
"<any, string | undefined> | undefined; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<string | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<string | undefined>> | ((value: string | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: string | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<string | undefined>; (PromiseCtor: PromiseConstructor): Promise<string | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string | undefined>; }; observers: ",
|
|
"Observer",
|
|
"<string | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<string | undefined>; }"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/panel_management.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasRuntimeChildState",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "HasRuntimeChildState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasRuntimeChildState",
|
|
"text": "HasRuntimeChildState"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasRuntimeChildState.getRuntimeStateForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRuntimeStateForChild",
|
|
"description": [],
|
|
"signature": [
|
|
"(childId: string) => Partial<RuntimeState> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasRuntimeChildState.getRuntimeStateForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "childId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasSaveNotification",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HasSaveNotification",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/has_save_notification.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasSaveNotification.saveNotification$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "saveNotification$",
|
|
"description": [],
|
|
"signature": [
|
|
"Subject",
|
|
"<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/has_save_notification.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasSerializedChildState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HasSerializedChildState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSerializedChildState",
|
|
"text": "HasSerializedChildState"
|
|
},
|
|
"<SerializedState>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasSerializedChildState.getSerializedStateForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSerializedStateForChild",
|
|
"description": [],
|
|
"signature": [
|
|
"(childId: string) => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.HasSerializedChildState.getSerializedStateForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "childId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/child_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PanelPackage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PanelPackage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<SerializedStateType, RuntimeStateType>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PanelPackage.panelType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelType",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PanelPackage.serializedState",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serializedState",
|
|
"description": [
|
|
"\nThe serialized state of this panel."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedStateType> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PanelPackage.initialState",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "initialState",
|
|
"description": [
|
|
"\nThe runtime state of this panel. @deprecated Use `serializedState` instead."
|
|
],
|
|
"signature": [
|
|
"RuntimeStateType | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PresentationContainer",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.CanAddNewPanel",
|
|
"text": "CanAddNewPanel"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.removePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removePanel",
|
|
"description": [
|
|
"\nRemoves a panel from the container."
|
|
],
|
|
"signature": [
|
|
"(panelId: string) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.removePanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.canRemovePanels",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "canRemovePanels",
|
|
"description": [
|
|
"\nDetermines whether or not a container is capable of removing panels."
|
|
],
|
|
"signature": [
|
|
"(() => boolean) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.replacePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replacePanel",
|
|
"description": [
|
|
"\nReplaces a panel in the container with a new panel."
|
|
],
|
|
"signature": [
|
|
"<SerializedState extends object = object>(idToRemove: string, newPanel: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<SerializedState, object>) => Promise<string>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.replacePanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "idToRemove",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.replacePanel.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newPanel",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<SerializedState, object>"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.getPanelCount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPanelCount",
|
|
"description": [
|
|
"\nReturns the number of panels in the container."
|
|
],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PresentationContainer.children$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "children$",
|
|
"description": [
|
|
"\nA publishing subject containing the child APIs of the container. Note that\nchildren are created asynchronously. This means that the children$ observable might\ncontain fewer children than the actual number of panels in the container."
|
|
],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: { [key: string]: unknown; }; error: (err: any) => void; forEach: { (next: (value: { [key: string]: unknown; }) => void): Promise<void>; (next: (value: { [key: string]: unknown; }) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => { [key: string]: unknown; }; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<{ [key: string]: unknown; }>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<{ [key: string]: unknown; }, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; operator: ",
|
|
"Operator",
|
|
"<any, { [key: string]: unknown; }> | undefined; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<{ [key: string]: unknown; }, R>) => ",
|
|
"Observable",
|
|
"<R>; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<{ [key: string]: unknown; }>> | ((value: { [key: string]: unknown; }) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: { [key: string]: unknown; }) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<{ [key: string]: unknown; } | undefined>; (PromiseCtor: PromiseConstructor): Promise<{ [key: string]: unknown; } | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<{ [key: string]: unknown; } | undefined>; }; observers: ",
|
|
"Observer",
|
|
"<{ [key: string]: unknown; }>[]; isStopped: boolean; hasError: boolean; thrownError: any; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<{ [key: string]: unknown; }>; }"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/presentation_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PublishesSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublishesSettings",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/publishes_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.PublishesSettings.settings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settings",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<boolean | undefined>; }"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/publishes_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TrackContentfulRender",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TrackContentfulRender",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/performance_trackers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TrackContentfulRender.trackContentfulRender",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackContentfulRender",
|
|
"description": [
|
|
"\nA way to report that the contentful render has been completed"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/performance_trackers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TracksOverlays",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TracksOverlays",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TracksOverlays.openOverlay",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openOverlay",
|
|
"description": [],
|
|
"signature": [
|
|
"(ref: ",
|
|
"OverlayRef",
|
|
", options?: ",
|
|
"TracksOverlaysOptions",
|
|
" | undefined) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TracksOverlays.openOverlay.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ref",
|
|
"description": [],
|
|
"signature": [
|
|
"OverlayRef"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TracksOverlays.openOverlay.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"TracksOverlaysOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/presentation-containers",
|
|
"id": "def-public.TracksOverlays.clearOverlays",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearOverlays",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/packages/shared/presentation/presentation_containers/interfaces/tracks_overlays.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |