mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
1091 lines
No EOL
38 KiB
JSON
1091 lines
No EOL
38 KiB
JSON
{
|
|
"id": "unifiedHistogram",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildChartData",
|
|
"description": [
|
|
"\nConvert the response from the chart request into a format that can be used\nby the unified histogram chart. The returned object should be used to update\n{@link UnifiedHistogramChartContext.bucketInterval} and {@link UnifiedHistogramChartContext.data}."
|
|
],
|
|
"signature": [
|
|
"({ data, dataView, timeInterval, response, }: { data: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
},
|
|
"; dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"; timeInterval?: string | undefined; response?: ",
|
|
"SearchResponse",
|
|
"<unknown, Record<string, ",
|
|
"AggregationsAggregate",
|
|
">> | undefined; }) => { bucketInterval?: undefined; chartData?: undefined; } | { bucketInterval: ",
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramBucketInterval",
|
|
"text": "UnifiedHistogramBucketInterval"
|
|
},
|
|
" | undefined; chartData: ",
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramChartData",
|
|
"text": "UnifiedHistogramChartData"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n data,\n dataView,\n timeInterval,\n response,\n}",
|
|
"description": [],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData.$1.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData.$1.dataView",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData.$1.timeInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.buildChartData.$1.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<unknown, Record<string, ",
|
|
"AggregationsAggregate",
|
|
">> | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/build_chart_data.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.getChartAggConfigs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getChartAggConfigs",
|
|
"description": [
|
|
"\nHelper function to get the agg configs required for the unified histogram chart request"
|
|
],
|
|
"signature": [
|
|
"({\n dataView,\n timeInterval,\n data,\n}: { dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"; timeInterval: string; data: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
},
|
|
"; }) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/get_chart_agg_configs.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.getChartAggConfigs.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n dataView,\n timeInterval,\n data,\n}",
|
|
"description": [],
|
|
"path": "src/plugins/unified_histogram/public/chart/get_chart_agg_configs.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.getChartAggConfigs.$1.dataView",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/get_chart_agg_configs.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.getChartAggConfigs.$1.timeInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeInterval",
|
|
"description": [],
|
|
"path": "src/plugins/unified_histogram/public/chart/get_chart_agg_configs.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.getChartAggConfigs.$1.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/chart/get_chart_agg_configs.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramLayout",
|
|
"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.\nIf all context props are left undefined, the layout will render in a single panel\nmode including only the main display."
|
|
],
|
|
"signature": [
|
|
"React.ForwardRefExoticComponent<",
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramLayoutProps",
|
|
"text": "UnifiedHistogramLayoutProps"
|
|
},
|
|
" & React.RefAttributes<{}>>"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayout.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramBucketInterval",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramBucketInterval",
|
|
"description": [
|
|
"\nThe bucketInterval object returned by {@link buildChartData} that\nshould be used to set {@link UnifiedHistogramChartContext.bucketInterval}"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramBucketInterval.scaled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scaled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramBucketInterval.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramBucketInterval.scale",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "scale",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramChartContext",
|
|
"description": [
|
|
"\nContext object for the chart"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe fetch status of the chart request"
|
|
],
|
|
"signature": [
|
|
"\"loading\" | \"error\" | \"complete\" | \"partial\" | \"uninitialized\""
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.hidden",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hidden",
|
|
"description": [
|
|
"\nControls whether or not the chart is hidden"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.timeInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeInterval",
|
|
"description": [
|
|
"\nControls the time interval of the chart"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.bucketInterval",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bucketInterval",
|
|
"description": [
|
|
"\nThe bucketInterval object returned by {@link buildChartData}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramBucketInterval",
|
|
"text": "UnifiedHistogramBucketInterval"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [
|
|
"\nThe chartData object returned by {@link buildChartData}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramChartData",
|
|
"text": "UnifiedHistogramChartData"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartContext.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"\nError from failed chart request"
|
|
],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramChartData",
|
|
"description": [
|
|
"\nThe chartData object returned by {@link buildChartData} that\nshould be used to set {@link UnifiedHistogramChartContext.data}"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.values",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "values",
|
|
"description": [],
|
|
"signature": [
|
|
"{ x: number; y: number; }[]"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.xAxisOrderedValues",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "xAxisOrderedValues",
|
|
"description": [],
|
|
"signature": [
|
|
"number[]"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.xAxisFormat",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "xAxisFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id?: string | undefined; params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"<{ pattern: string; }> | undefined; }"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.yAxisFormat",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "yAxisFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id?: string | undefined; params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"<{ pattern: string; }> | undefined; }"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.xAxisLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "xAxisLabel",
|
|
"description": [],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.yAxisLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "yAxisLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramChartData.ordered",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ordered",
|
|
"description": [],
|
|
"signature": [
|
|
"Ordered"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramHitsContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramHitsContext",
|
|
"description": [
|
|
"\nContext object for the hits count"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramHitsContext.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe fetch status of the hits count request"
|
|
],
|
|
"signature": [
|
|
"\"loading\" | \"error\" | \"complete\" | \"partial\" | \"uninitialized\""
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramHitsContext.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [
|
|
"\nThe total number of hits"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramLayoutProps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramLayoutProps",
|
|
"text": "UnifiedHistogramLayoutProps"
|
|
},
|
|
" extends { children?: React.ReactNode; }"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramServices",
|
|
"text": "UnifiedHistogramServices"
|
|
}
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.hits",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hits",
|
|
"description": [
|
|
"\nContext object for the hits count -- leave undefined to hide the hits count"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramHitsContext",
|
|
"text": "UnifiedHistogramHitsContext"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.chart",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "chart",
|
|
"description": [
|
|
"\nContext object for the chart -- leave undefined to hide the chart"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedHistogram",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedHistogramPluginApi",
|
|
"section": "def-public.UnifiedHistogramChartContext",
|
|
"text": "UnifiedHistogramChartContext"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.resizeRef",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "resizeRef",
|
|
"description": [
|
|
"\nRef to the element wrapping the layout which will be used for resize calculations"
|
|
],
|
|
"signature": [
|
|
"React.RefObject<HTMLDivElement>"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.topPanelHeight",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "topPanelHeight",
|
|
"description": [
|
|
"\nCurrent top panel height -- leave undefined to use the default"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.appendHitsCounter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appendHitsCounter",
|
|
"description": [
|
|
"\nAppend a custom element to the right of the hits count"
|
|
],
|
|
"signature": [
|
|
"React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onTopPanelHeightChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onTopPanelHeightChange",
|
|
"description": [
|
|
"\nCallback to update the topPanelHeight prop when a resize is triggered"
|
|
],
|
|
"signature": [
|
|
"((topPanelHeight: number | undefined) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onTopPanelHeightChange.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "topPanelHeight",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onEditVisualization",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onEditVisualization",
|
|
"description": [
|
|
"\nCallback to invoke when the user clicks the edit visualization button -- leave undefined to hide the button"
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onChartHiddenChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onChartHiddenChange",
|
|
"description": [
|
|
"\nCallback to hide or show the chart -- should set {@link UnifiedHistogramChartContext.hidden} to chartHidden"
|
|
],
|
|
"signature": [
|
|
"((chartHidden: boolean) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onChartHiddenChange.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "chartHidden",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onTimeIntervalChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onTimeIntervalChange",
|
|
"description": [
|
|
"\nCallback to update the time interval -- should set {@link UnifiedHistogramChartContext.timeInterval} to timeInterval"
|
|
],
|
|
"signature": [
|
|
"((timeInterval: string) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramLayoutProps.onTimeIntervalChange.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/layout/layout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramServices",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramServices",
|
|
"description": [
|
|
"\nThe services required by the unified histogram components"
|
|
],
|
|
"path": "src/plugins/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/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramServices.theme",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly chartsDefaultTheme: ",
|
|
"RecursivePartial",
|
|
"<",
|
|
"Theme",
|
|
">; readonly chartsDefaultBaseTheme: ",
|
|
"Theme",
|
|
"; chartsTheme$: ",
|
|
"Observable",
|
|
"<",
|
|
"RecursivePartial",
|
|
"<",
|
|
"Theme",
|
|
">>; chartsBaseTheme$: ",
|
|
"Observable",
|
|
"<",
|
|
"Theme",
|
|
">; readonly darkModeEnabled$: ",
|
|
"Observable",
|
|
"<boolean>; useDarkMode: () => boolean; useChartsTheme: () => ",
|
|
"RecursivePartial",
|
|
"<",
|
|
"Theme",
|
|
">; useChartsBaseTheme: () => ",
|
|
"Theme",
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramServices.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-ui-settings-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
|
|
"section": "def-common.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "src/plugins/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/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "unifiedHistogram",
|
|
"id": "def-public.UnifiedHistogramFetchStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UnifiedHistogramFetchStatus",
|
|
"description": [
|
|
"\nThe fetch status of a unified histogram request"
|
|
],
|
|
"signature": [
|
|
"\"loading\" | \"error\" | \"complete\" | \"partial\" | \"uninitialized\""
|
|
],
|
|
"path": "src/plugins/unified_histogram/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |