github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/unified_histogram.devdocs.json

1995 lines
No EOL
74 KiB
JSON
Raw Permalink Blame History

{
"id": "unifiedHistogram",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.canImportVisContext",
"type": "Function",
"tags": [],
"label": "canImportVisContext",
"description": [],
"signature": [
"(visContext: unknown) => boolean"
],
"path": "src/platform/plugins/shared/unified_histogram/public/utils/external_vis_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.canImportVisContext.$1",
"type": "Unknown",
"tags": [],
"label": "visContext",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/plugins/shared/unified_histogram/public/utils/external_vis_context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getBreakdownField",
"type": "Function",
"tags": [],
"label": "getBreakdownField",
"description": [
"\nGet the breakdown field from local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string) => string | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getBreakdownField.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getBreakdownField.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getChartHidden",
"type": "Function",
"tags": [],
"label": "getChartHidden",
"description": [
"\nGet the chart hidden state from local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string) => boolean | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getChartHidden.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getChartHidden.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getTopPanelHeight",
"type": "Function",
"tags": [],
"label": "getTopPanelHeight",
"description": [
"\nGet the top panel height from local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string) => number | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getTopPanelHeight.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.getTopPanelHeight.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setBreakdownField",
"type": "Function",
"tags": [],
"label": "setBreakdownField",
"description": [
"\nSet the breakdown field in local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string, breakdownField: string | undefined) => false | void"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setBreakdownField.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setBreakdownField.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setBreakdownField.$3",
"type": "string",
"tags": [],
"label": "breakdownField",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setChartHidden",
"type": "Function",
"tags": [],
"label": "setChartHidden",
"description": [
"\nSet the chart hidden state in local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string, chartHidden: boolean | undefined) => false | void"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setChartHidden.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setChartHidden.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setChartHidden.$3",
"type": "CompoundType",
"tags": [],
"label": "chartHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setTopPanelHeight",
"type": "Function",
"tags": [],
"label": "setTopPanelHeight",
"description": [
"\nSet the top panel height in local storage"
],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", localStorageKeyPrefix: string, topPanelHeight: number | undefined) => false | void"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setTopPanelHeight.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setTopPanelHeight.$2",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.setTopPanelHeight.$3",
"type": "number",
"tags": [],
"label": "topPanelHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/utils/local_storage_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedBreakdownFieldSelector",
"type": "Function",
"tags": [],
"label": "UnifiedBreakdownFieldSelector",
"description": [
"\nA resizable layout component with two panels that renders a histogram with a hits\ncounter in the top panel, and a main display (data table, etc.) in the bottom panel."
],
"signature": [
"React.ForwardRefExoticComponent<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.BreakdownFieldSelectorProps",
"text": "BreakdownFieldSelectorProps"
},
" & ",
{
"pluginId": "@kbn/shared-ux-utility",
"scope": "common",
"docId": "kibKbnSharedUxUtilityPluginApi",
"section": "def-common.WithSuspenseExtendedDeps",
"text": "WithSuspenseExtendedDeps"
},
" & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedBreakdownFieldSelector.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramContainer",
"type": "Function",
"tags": [],
"label": "UnifiedHistogramContainer",
"description": [
"\nA resizable layout component with two panels that renders a histogram with a hits\ncounter in the top panel, and a main display (data table, etc.) in the bottom panel."
],
"signature": [
"React.ForwardRefExoticComponent<{ getCreationOptions?: (() => ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramCreationOptions",
"text": "UnifiedHistogramCreationOptions"
},
" | Promise<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramCreationOptions",
"text": "UnifiedHistogramCreationOptions"
},
">) | undefined; searchSessionId?: string | undefined; requestAdapter?: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestAdapter",
"text": "RequestAdapter"
},
" | undefined; isChartLoading?: boolean | undefined; breakdownField?: string | undefined; onBreakdownFieldChange?: ((breakdownField: string | undefined) => void) | undefined; onVisContextChanged?: ((nextVisContext: ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramVisContext",
"text": "UnifiedHistogramVisContext"
},
" | undefined, externalVisContextStatus: ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramExternalVisContextStatus",
"text": "UnifiedHistogramExternalVisContextStatus"
},
") => void) | undefined; } & Pick<",
"UnifiedHistogramLayoutProps",
", \"className\" | \"children\" | \"columns\" | \"timeRange\" | \"query\" | \"filters\" | \"services\" | \"table\" | \"dataView\" | \"container\" | \"onBrushEnd\" | \"abortController\" | \"withDefaultActions\" | \"disabledActions\" | \"onFilter\" | \"relativeTimeRange\" | \"renderCustomChartToggleActions\" | \"externalVisContext\"> & ",
{
"pluginId": "@kbn/shared-ux-utility",
"scope": "common",
"docId": "kibKbnSharedUxUtilityPluginApi",
"section": "def-common.WithSuspenseExtendedDeps",
"text": "WithSuspenseExtendedDeps"
},
" & React.RefAttributes<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramApi",
"text": "UnifiedHistogramApi"
},
">>"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramContainer.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps",
"type": "Interface",
"tags": [],
"label": "BreakdownFieldSelectorProps",
"description": [],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps.breakdown",
"type": "Object",
"tags": [],
"label": "breakdown",
"description": [],
"signature": [
"UnifiedHistogramBreakdownContext"
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps.esqlColumns",
"type": "Array",
"tags": [],
"label": "esqlColumns",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"[] | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps.onBreakdownFieldChange",
"type": "Function",
"tags": [],
"label": "onBreakdownFieldChange",
"description": [],
"signature": [
"((breakdownField: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | undefined) => void) | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.BreakdownFieldSelectorProps.onBreakdownFieldChange.$1",
"type": "Object",
"tags": [],
"label": "breakdownField",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/chart/breakdown_field_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramChartLoadEvent",
"type": "Interface",
"tags": [],
"label": "UnifiedHistogramChartLoadEvent",
"description": [
"\nEmitted when the histogram loading status changes"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramChartLoadEvent.adapters",
"type": "Object",
"tags": [],
"label": "adapters",
"description": [
"\nInspector adapters for the request"
],
"signature": [
"{ requests?: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestAdapter",
"text": "RequestAdapter"
},
" | undefined; tables?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.TablesAdapter",
"text": "TablesAdapter"
},
" | undefined; expression?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionsInspectorAdapter",
"text": "ExpressionsInspectorAdapter"
},
" | undefined; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramChartLoadEvent.dataLoading$",
"type": "Object",
"tags": [],
"label": "dataLoading$",
"description": [
"\nObservable for the data change subscription"
],
"signature": [
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined> | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices",
"type": "Interface",
"tags": [],
"label": "UnifiedHistogramServices",
"description": [
"\nThe services required by the Unified Histogram components"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly hasTrigger: (triggerId: string) => boolean; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerActionAsync: <Context extends object>(id: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>>) => void; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly addTriggerActionAsync: (triggerId: string, actionId: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>>) => void; readonly getAction: (id: string) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>>; readonly getTriggerActions: (triggerId: string) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly getFrequentlyChangingActionsForTrigger: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.FrequentCompatibilityChangeAction",
"text": "FrequentCompatibilityChangeAction"
},
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
"; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.uiSettings",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
"IUiSettingsClient"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.fieldFormats",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
", \"init\" | \"register\"> & { deserialize: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FormatFactory",
"text": "FormatFactory"
},
"; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.lens",
"type": "Object",
"tags": [],
"label": "lens",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensPublicStart",
"text": "LensPublicStart"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.storage",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.expressions",
"type": "Object",
"tags": [],
"label": "expressions",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "public",
"docId": "kibExpressionsPluginApi",
"section": "def-public.ExpressionsStart",
"text": "ExpressionsStart"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramServices.capabilities",
"type": "CompoundType",
"tags": [],
"label": "capabilities",
"description": [],
"signature": [
"{ [key: string]: Record<string, boolean | Record<string, boolean>>; navLinks: Record<string, boolean>; management: { [sectionId: string]: Record<string, boolean>; }; catalogue: Record<string, boolean>; } & { discover?: {} | undefined; dashboard?: {} | undefined; maps?: {} | undefined; visualize?: {} | undefined; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState",
"type": "Interface",
"tags": [],
"label": "UnifiedHistogramState",
"description": [
"\nThe current state of the container"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.currentSuggestionContext",
"type": "Object",
"tags": [],
"label": "currentSuggestionContext",
"description": [
"\nThe current Lens suggestion"
],
"signature": [
"UnifiedHistogramSuggestionContext",
" | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.chartHidden",
"type": "boolean",
"tags": [],
"label": "chartHidden",
"description": [
"\nWhether or not the chart is hidden"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.lensRequestAdapter",
"type": "Object",
"tags": [],
"label": "lensRequestAdapter",
"description": [
"\nThe current Lens request adapter"
],
"signature": [
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestAdapter",
"text": "RequestAdapter"
},
" | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.lensAdapters",
"type": "Object",
"tags": [],
"label": "lensAdapters",
"description": [
"\nThe current Lens adapters"
],
"signature": [
"Partial<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DefaultInspectorAdapters",
"text": "DefaultInspectorAdapters"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.dataLoading$",
"type": "Object",
"tags": [],
"label": "dataLoading$",
"description": [
"\nLens embeddable output observable"
],
"signature": [
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined> | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.timeInterval",
"type": "string",
"tags": [],
"label": "timeInterval",
"description": [
"\nThe current time interval of the chart"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.topPanelHeight",
"type": "number",
"tags": [],
"label": "topPanelHeight",
"description": [
"\nThe current top panel height"
],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.totalHitsStatus",
"type": "Enum",
"tags": [],
"label": "totalHitsStatus",
"description": [
"\nThe current fetch status of the hits count request"
],
"signature": [
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramFetchStatus",
"text": "UnifiedHistogramFetchStatus"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramState.totalHitsResult",
"type": "CompoundType",
"tags": [],
"label": "totalHitsResult",
"description": [
"\nThe current result of the hits count request"
],
"signature": [
"number | Error | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramStateOptions",
"type": "Interface",
"tags": [],
"label": "UnifiedHistogramStateOptions",
"description": [
"\nThe options used to initialize the comntainer state"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramStateOptions.services",
"type": "Object",
"tags": [],
"label": "services",
"description": [
"\nThe services required by the Unified Histogram components"
],
"signature": [
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramServices",
"text": "UnifiedHistogramServices"
}
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramStateOptions.localStorageKeyPrefix",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [
"\nThe prefix for the keys used in local storage -- leave undefined to avoid using local storage"
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramStateOptions.initialState",
"type": "Object",
"tags": [],
"label": "initialState",
"description": [
"\nThe initial state of the container"
],
"signature": [
"Partial<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramState",
"text": "UnifiedHistogramState"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/services/state_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramVisContext",
"type": "Interface",
"tags": [],
"label": "UnifiedHistogramVisContext",
"description": [
"\nUnified Histogram type for recreating a stored Lens vis"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramVisContext.attributes",
"type": "CompoundType",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"{ title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsXY\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYState",
"text": "XYState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsPie\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
"PieVisualizationState",
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsHeatmap\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.HeatmapVisualizationState",
"text": "HeatmapVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsGauge\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.GaugeVisualizationState",
"text": "GaugeVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsDatatable\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatatableVisualizationState",
"text": "DatatableVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsLegacyMetric\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.LegacyMetricState",
"text": "LegacyMetricState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsMetric\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MetricVisualizationState",
"text": "MetricVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: string; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
"TextBasedPersistedState",
" | undefined; }; visualization: unknown; }; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramVisContext.requestData",
"type": "Object",
"tags": [],
"label": "requestData",
"description": [],
"signature": [
"LensRequestData"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramVisContext.suggestionType",
"type": "Enum",
"tags": [],
"label": "suggestionType",
"description": [],
"signature": [
"UnifiedHistogramSuggestionType"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramExternalVisContextStatus",
"type": "Enum",
"tags": [],
"label": "UnifiedHistogramExternalVisContextStatus",
"description": [],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramFetchStatus",
"type": "Enum",
"tags": [],
"label": "UnifiedHistogramFetchStatus",
"description": [
"\nThe fetch status of a Unified Histogram request"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramAdapters",
"type": "Type",
"tags": [],
"label": "UnifiedHistogramAdapters",
"description": [
"\nThe adapters passed up from Lens"
],
"signature": [
"{ requests?: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestAdapter",
"text": "RequestAdapter"
},
" | undefined; tables?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.TablesAdapter",
"text": "TablesAdapter"
},
" | undefined; expression?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionsInspectorAdapter",
"text": "ExpressionsInspectorAdapter"
},
" | undefined; }"
],
"path": "src/platform/plugins/shared/unified_histogram/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramApi",
"type": "Type",
"tags": [],
"label": "UnifiedHistogramApi",
"description": [
"\nThe API exposed by the container"
],
"signature": [
"{ fetch: () => void; } & Pick<",
"UnifiedHistogramStateService",
", \"state$\" | \"setChartHidden\" | \"setTopPanelHeight\" | \"setTimeInterval\" | \"setTotalHits\">"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/container.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramContainerProps",
"type": "Type",
"tags": [],
"label": "UnifiedHistogramContainerProps",
"description": [
"\nThe props exposed by the container"
],
"signature": [
"{ getCreationOptions?: (() => ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramCreationOptions",
"text": "UnifiedHistogramCreationOptions"
},
" | Promise<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramCreationOptions",
"text": "UnifiedHistogramCreationOptions"
},
">) | undefined; searchSessionId?: string | undefined; requestAdapter?: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestAdapter",
"text": "RequestAdapter"
},
" | undefined; isChartLoading?: boolean | undefined; breakdownField?: string | undefined; onBreakdownFieldChange?: ((breakdownField: string | undefined) => void) | undefined; onVisContextChanged?: ((nextVisContext: ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramVisContext",
"text": "UnifiedHistogramVisContext"
},
" | undefined, externalVisContextStatus: ",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramExternalVisContextStatus",
"text": "UnifiedHistogramExternalVisContextStatus"
},
") => void) | undefined; } & Pick<",
"UnifiedHistogramLayoutProps",
", \"className\" | \"children\" | \"columns\" | \"timeRange\" | \"query\" | \"filters\" | \"services\" | \"table\" | \"dataView\" | \"container\" | \"onBrushEnd\" | \"abortController\" | \"withDefaultActions\" | \"disabledActions\" | \"onFilter\" | \"relativeTimeRange\" | \"renderCustomChartToggleActions\" | \"externalVisContext\">"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/container.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedHistogram",
"id": "def-public.UnifiedHistogramCreationOptions",
"type": "Type",
"tags": [],
"label": "UnifiedHistogramCreationOptions",
"description": [
"\nThe options used to initialize the container"
],
"signature": [
"Omit<",
{
"pluginId": "unifiedHistogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramStateOptions",
"text": "UnifiedHistogramStateOptions"
},
", \"services\"> & LayoutProps"
],
"path": "src/platform/plugins/shared/unified_histogram/public/container/container.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink