kibana/api_docs/charts.json
2021-03-24 11:44:23 +01:00

2486 lines
75 KiB
JSON

{
"id": "charts",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.ColorPicker",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n}",
"isRequired": true,
"signature": [
"ColorPickerProps"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 111
}
}
],
"signature": [
"({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, }: ColorPickerProps) => JSX.Element"
],
"description": [],
"label": "ColorPicker",
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 111
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.createColorPalette",
"type": "Function",
"label": "createColorPalette",
"signature": [
"(num: number) => string[]"
],
"description": [
"\nGenerates an array of hex colors the length of the input number.\nIf the number is greater than the length of seed colors available,\nnew colors are generated up to the value of the input number."
],
"children": [
{
"type": "number",
"label": "num",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/colors/color_palette.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/charts/public/static/colors/color_palette.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-public.CurrentTime",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "{ isDarkMode, domainEnd }",
"isRequired": true,
"signature": [
"React.PropsWithChildren<CurrentTimeProps>"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/current_time.tsx",
"lineNumber": 24
}
}
],
"signature": [
"({ isDarkMode, domainEnd }: React.PropsWithChildren<CurrentTimeProps>) => JSX.Element"
],
"description": [
"\nRender current time line annotation on @elastic/charts `Chart`"
],
"label": "CurrentTime",
"source": {
"path": "src/plugins/charts/public/static/components/current_time.tsx",
"lineNumber": 24
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.Endzones",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "{\n isDarkMode,\n domainStart,\n domainEnd,\n interval,\n domainMin,\n domainMax,\n hideTooltips = true,\n isFullBin = false,\n}",
"isRequired": true,
"signature": [
"React.PropsWithChildren<EndzonesProps>"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 37
}
}
],
"signature": [
"({ isDarkMode, domainStart, domainEnd, interval, domainMin, domainMax, hideTooltips, isFullBin, }: React.PropsWithChildren<EndzonesProps>) => JSX.Element"
],
"description": [],
"label": "Endzones",
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 37
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getAdjustedInterval",
"type": "Function",
"children": [
{
"type": "Array",
"label": "xValues",
"isRequired": true,
"signature": [
"number[]"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 121
}
},
{
"type": "number",
"label": "esValue",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 122
}
},
{
"type": "CompoundType",
"label": "esUnit",
"isRequired": true,
"signature": [
"moment.unitOfTime.Base"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 123
}
},
{
"type": "string",
"label": "timeZone",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 124
}
}
],
"signature": [
"(xValues: number[], esValue: number, esUnit: moment.unitOfTime.Base, timeZone: string) => number"
],
"description": [
"\nReturns the adjusted interval based on the data\n"
],
"label": "getAdjustedInterval",
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 120
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getBrushFromChartBrushEventFn",
"type": "Function",
"children": [
{
"type": "Object",
"label": "table",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 255
}
},
{
"type": "CompoundType",
"label": "xAccessor",
"isRequired": true,
"signature": [
"string | number | ",
"AccessorFn"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 256
}
}
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", xAccessor: string | number | ",
"AccessorFn",
") => ({ x: selectedRange }: ",
"XYBrushArea",
") => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.BrushTriggerEvent",
"text": "BrushTriggerEvent"
}
],
"description": [
"\nHelper function to transform `@elastic/charts` brush event into brush action event"
],
"label": "getBrushFromChartBrushEventFn",
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 254
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getFilterFromChartClickEventFn",
"type": "Function",
"children": [
{
"type": "Object",
"label": "table",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 172
}
},
{
"type": "CompoundType",
"label": "xAccessor",
"isRequired": true,
"signature": [
"string | number | ",
"AccessorFn"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 173
}
},
{
"type": "Object",
"label": "splitSeriesAccessorFnMap",
"isRequired": false,
"signature": [
"Map<React.ReactText, ",
"AccessorFn",
"> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 174
}
},
{
"type": "CompoundType",
"label": "splitChartAccessor",
"isRequired": false,
"signature": [
"string | number | ",
"AccessorFn",
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 175
}
},
{
"type": "boolean",
"label": "negate",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 176
}
}
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", xAccessor: string | number | ",
"AccessorFn",
", splitSeriesAccessorFnMap?: Map<React.ReactText, ",
"AccessorFn",
"> | undefined, splitChartAccessor?: string | number | ",
"AccessorFn",
" | undefined, negate?: boolean) => (points: [",
"GeometryValue"
],
"description": [
"\nHelper function to transform `@elastic/charts` click event into filter action event\n"
],
"label": "getFilterFromChartClickEventFn",
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 171
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getFilterFromSeriesFn",
"type": "Function",
"children": [
{
"type": "Object",
"label": "table",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 220
}
}
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
") => ({ splitAccessors, ...rest }: ",
"XYChartSeriesIdentifier",
", splitSeriesAccessorFnMap?: Map<React.ReactText, ",
"AccessorFn",
"> | undefined, splitChartAccessor?: string | number | ",
"AccessorFn",
" | undefined, negate?: boolean) => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ClickTriggerEvent",
"text": "ClickTriggerEvent"
}
],
"description": [
"\nHelper function to get filter action event from series"
],
"label": "getFilterFromSeriesFn",
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 220
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getHeatmapColors",
"type": "Function",
"label": "getHeatmapColors",
"signature": [
"(value: any, colorSchemaName: string) => string"
],
"description": [],
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts",
"lineNumber": 47
}
},
{
"type": "string",
"label": "colorSchemaName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts",
"lineNumber": 47
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.LegendToggle",
"type": "Function",
"label": "LegendToggle",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/legend_toggle.tsx",
"lineNumber": 51
},
"signature": [
"React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>"
],
"initialIsOpen": false
},
{
"id": "def-public.renderEndzoneTooltip",
"type": "Function",
"children": [
{
"type": "number",
"label": "xInterval",
"isRequired": false,
"signature": [
"number | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 160
}
},
{
"type": "number",
"label": "domainStart",
"isRequired": false,
"signature": [
"number | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 161
}
},
{
"type": "number",
"label": "domainEnd",
"isRequired": false,
"signature": [
"number | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 162
}
},
{
"type": "Function",
"label": "formatter",
"isRequired": false,
"signature": [
"((v: any) => string) | undefined"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 163
}
},
{
"type": "boolean",
"label": "renderValue",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 164
}
}
],
"signature": [
"(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ",
"TooltipValue",
") => string | JSX.Element"
],
"description": [],
"label": "renderEndzoneTooltip",
"source": {
"path": "src/plugins/charts/public/static/components/endzones.tsx",
"lineNumber": 159
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.BrushTriggerEvent",
"type": "Interface",
"label": "BrushTriggerEvent",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.BrushTriggerEvent.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 27
},
"signature": [
"\"brush\""
]
},
{
"tags": [],
"id": "def-public.BrushTriggerEvent.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 28
},
"signature": [
"{ table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; column: number; range: number[]; timeFieldName?: string | undefined; }"
]
}
],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.ChartColorConfiguration",
"type": "Interface",
"label": "ChartColorConfiguration",
"description": [
"\nInformation about the structure of a chart to determine the color of a series within it."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ChartColorConfiguration.totalSeries",
"type": "number",
"label": "totalSeries",
"description": [
"\nOverall number of series in the current chart"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 37
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.ChartColorConfiguration.maxDepth",
"type": "number",
"label": "maxDepth",
"description": [
"\nMax nesting depth of the series tree"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 41
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.ChartColorConfiguration.behindText",
"type": "CompoundType",
"label": "behindText",
"description": [
"\nFlag whether the color will be used behind text. The palette can use this information to\nadjust colors for better a11y. Might be ignored depending on the palette."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 46
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.ChartColorConfiguration.syncColors",
"type": "CompoundType",
"label": "syncColors",
"description": [
"\nFlag whether a color assignment to a given key should be remembered and re-used the next time the key shows up.\nThis setting might be ignored based on the palette."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 51
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-public.ClickTriggerEvent",
"type": "Interface",
"label": "ClickTriggerEvent",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ClickTriggerEvent.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 22
},
"signature": [
"\"filterBucket\""
]
},
{
"tags": [],
"id": "def-public.ClickTriggerEvent.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 23
},
"signature": [
"{ data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
]
}
],
"source": {
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.ColorMap",
"type": "Interface",
"label": "ColorMap",
"description": [],
"tags": [],
"children": [
{
"id": "def-public.ColorMap.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 32
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-public.ColorSchema",
"type": "Interface",
"label": "ColorSchema",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ColorSchema.value",
"type": "Enum",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 21
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
}
]
},
{
"tags": [],
"id": "def-public.ColorSchema.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-public.ColorSchemaParams",
"type": "Interface",
"label": "ColorSchemaParams",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ColorSchemaParams.colorSchema",
"type": "Enum",
"label": "colorSchema",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 13
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
}
]
},
{
"tags": [],
"id": "def-public.ColorSchemaParams.invertColors",
"type": "boolean",
"label": "invertColors",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 14
}
}
],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.CustomPaletteArguments",
"type": "Interface",
"label": "CustomPaletteArguments",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CustomPaletteArguments.color",
"type": "Array",
"label": "color",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 14
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.CustomPaletteArguments.gradient",
"type": "boolean",
"label": "gradient",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-public.CustomPaletteArguments.reverse",
"type": "CompoundType",
"label": "reverse",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 16
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-public.CustomPaletteState",
"type": "Interface",
"label": "CustomPaletteState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CustomPaletteState.colors",
"type": "Array",
"label": "colors",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 20
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.CustomPaletteState.gradient",
"type": "boolean",
"label": "gradient",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 21
}
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-public.Labels",
"type": "Interface",
"label": "Labels",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Labels.color",
"type": "string",
"label": "color",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.Labels.filter",
"type": "CompoundType",
"label": "filter",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 19
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.Labels.overwriteColor",
"type": "CompoundType",
"label": "overwriteColor",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 20
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.Labels.rotate",
"type": "number",
"label": "rotate",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 21
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.Labels.show",
"type": "CompoundType",
"label": "show",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.Labels.truncate",
"type": "CompoundType",
"label": "truncate",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 23
},
"signature": [
"number | null | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-public.PaletteDefinition",
"type": "Interface",
"label": "PaletteDefinition",
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.PaletteDefinition",
"text": "PaletteDefinition"
},
"<T>"
],
"description": [
"\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PaletteDefinition.id",
"type": "string",
"label": "id",
"description": [
"\nUnique id of the palette (this will be persisted along with the visualization state)"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 67
}
},
{
"tags": [],
"id": "def-public.PaletteDefinition.title",
"type": "string",
"label": "title",
"description": [
"\nUser facing title (should be i18n-ized)"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 71
}
},
{
"tags": [],
"id": "def-public.PaletteDefinition.internal",
"type": "CompoundType",
"label": "internal",
"description": [
"\nFlag indicating whether users should be able to pick this palette manually."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 75
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.PaletteDefinition.toExpression",
"type": "Function",
"label": "toExpression",
"description": [
"\nSerialize the internal state of the palette into an expression function.\nThis function should be used to pass the palette to the expression function applying color and other styles"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 81
},
"signature": [
"(state?: T | undefined) => ",
"Ast"
]
},
{
"tags": [],
"id": "def-public.PaletteDefinition.renderEditor",
"type": "Function",
"label": "renderEditor",
"description": [
"\nRenders the UI for editing the internal state of the palette.\nNot each palette has to feature an internal state, so this is an optional property."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 88
},
"signature": [
"((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.PaletteDefinition.getColor",
"type": "Function",
"label": "getColor",
"description": [
"\nColor a series according to the internal rules of the palette."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 97
},
"signature": [
"(series: ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.SeriesLayer",
"text": "SeriesLayer"
},
"[], chartConfiguration?: ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartColorConfiguration",
"text": "ChartColorConfiguration"
},
" | undefined, state?: T | undefined) => string | null"
]
},
{
"tags": [],
"id": "def-public.PaletteDefinition.getColors",
"type": "Function",
"label": "getColors",
"description": [
"\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally."
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 106
},
"signature": [
"(size: number, state?: T | undefined) => string[]"
]
}
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 63
},
"initialIsOpen": false
},
{
"id": "def-public.PaletteOutput",
"type": "Interface",
"label": "PaletteOutput",
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PaletteOutput.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 29
},
"signature": [
"\"palette\""
]
},
{
"tags": [],
"id": "def-public.PaletteOutput.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-public.PaletteOutput.params",
"type": "Uncategorized",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 31
},
"signature": [
"T | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-public.PaletteRegistry",
"type": "Interface",
"label": "PaletteRegistry",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PaletteRegistry.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 110
},
"signature": [
"(name: string) => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.PaletteDefinition",
"text": "PaletteDefinition"
},
"<unknown>"
]
},
{
"tags": [],
"id": "def-public.PaletteRegistry.getAll",
"type": "Function",
"label": "getAll",
"description": [],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 111
},
"signature": [
"() => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.PaletteDefinition",
"text": "PaletteDefinition"
},
"<unknown>[]"
]
}
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 109
},
"initialIsOpen": false
},
{
"id": "def-public.RawColorSchema",
"type": "Interface",
"label": "RawColorSchema",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RawColorSchema.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
}
]
},
{
"tags": [],
"id": "def-public.RawColorSchema.label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-public.RawColorSchema.value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 28
},
"signature": [
"[number, number[]][]"
]
}
],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-public.SeriesLayer",
"type": "Interface",
"label": "SeriesLayer",
"description": [
"\nInformation about a series in a chart used to determine its color.\nSeries layers can be nested, this means each series layer can have an ancestor."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SeriesLayer.name",
"type": "string",
"label": "name",
"description": [
"\nName of the series (can be used for lookup-based coloring)"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 19
}
},
{
"tags": [],
"id": "def-public.SeriesLayer.rankAtDepth",
"type": "number",
"label": "rankAtDepth",
"description": [
"\nRank of the series compared to siblings with the same ancestor"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 23
}
},
{
"tags": [],
"id": "def-public.SeriesLayer.totalSeriesAtDepth",
"type": "number",
"label": "totalSeriesAtDepth",
"description": [
"\nTotal number of series with the same ancestor"
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 27
}
}
],
"source": {
"path": "src/plugins/charts/public/services/palettes/types.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-public.Style",
"type": "Interface",
"label": "Style",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Style.bgFill",
"type": "string",
"label": "bgFill",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-public.Style.bgColor",
"type": "boolean",
"label": "bgColor",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 28
}
},
{
"tags": [],
"id": "def-public.Style.labelColor",
"type": "boolean",
"label": "labelColor",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 29
}
},
{
"tags": [],
"id": "def-public.Style.subText",
"type": "string",
"label": "subText",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-public.Style.fontSize",
"type": "number",
"label": "fontSize",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 31
}
}
],
"source": {
"path": "src/plugins/charts/public/static/components/types.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.SystemPaletteArguments",
"type": "Interface",
"label": "SystemPaletteArguments",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SystemPaletteArguments.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 25
}
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 24
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.ColorSchemas",
"type": "Enum",
"label": "ColorSchemas",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-public.ColorMode",
"type": "Type",
"label": "ColorMode",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/collections.ts",
"lineNumber": 17
},
"signature": [
"\"Background\" | \"Labels\" | \"None\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.colorSchemas",
"type": "Array",
"label": "colorSchemas",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 174
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchema",
"text": "ColorSchema"
},
"[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.defaultCountLabel",
"type": "string",
"label": "defaultCountLabel",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/collections.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.LabelRotation",
"type": "Type",
"label": "LabelRotation",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/collections.ts",
"lineNumber": 24
},
"signature": [
"{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.paletteIds",
"type": "Array",
"label": "paletteIds",
"description": [],
"source": {
"path": "src/plugins/charts/common/constants.ts",
"lineNumber": 10
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.seedColors",
"type": "Array",
"label": "seedColors",
"description": [
"\nUsing a random color generator presented awful colors and unpredictable color schemes.\nSo we needed to come up with a color scheme of our own that creates consistent, pleasing color patterns.\nThe order allows us to guarantee that 1st, 2nd, 3rd, etc values always get the same color."
],
"source": {
"path": "src/plugins/charts/public/static/colors/seed_colors.ts",
"lineNumber": 14
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.truncatedColorSchemas",
"type": "Array",
"label": "truncatedColorSchemas",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchema",
"text": "ColorSchema"
},
"[]"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-public.ColorMode",
"type": "Object",
"label": "ColorMode",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/collections.ts",
"lineNumber": 12
},
"signature": [
"Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.LabelRotation",
"type": "Object",
"label": "LabelRotation",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/collections.ts",
"lineNumber": 19
},
"signature": [
"Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>"
],
"initialIsOpen": false
},
{
"id": "def-public.truncatedColorMaps",
"type": "Object",
"tags": [],
"children": [],
"description": [],
"label": "truncatedColorMaps",
"source": {
"path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.vislibColorMaps",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-public.vislibColorMaps.[ColorSchemas.Blues]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Blues].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".Blues"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Blues].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Blues].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 42
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [
"// Sequential"
],
"label": "[ColorSchemas.Blues]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 37
}
},
{
"id": "def-public.vislibColorMaps.[ColorSchemas.Greens]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greens].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".Greens"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greens].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 57
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greens].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 60
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [],
"label": "[ColorSchemas.Greens]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 55
}
},
{
"id": "def-public.vislibColorMaps.[ColorSchemas.Greys]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greys].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 74
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".Greys"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greys].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 75
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Greys].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 78
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [],
"label": "[ColorSchemas.Greys]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 73
}
},
{
"id": "def-public.vislibColorMaps.[ColorSchemas.Reds]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Reds].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 92
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".Reds"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Reds].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 93
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.Reds].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 96
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [],
"label": "[ColorSchemas.Reds]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 91
}
},
{
"id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 110
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".YellowToRed"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 111
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 114
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [],
"label": "[ColorSchemas.YellowToRed]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 109
}
},
{
"id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed]",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 129
},
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ColorSchemas",
"text": "ColorSchemas"
},
".GreenToRed"
]
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 130
}
},
{
"tags": [],
"id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].value",
"type": "Array",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 133
},
"signature": [
"[number, number[]][]"
]
}
],
"description": [],
"label": "[ColorSchemas.GreenToRed]",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 128
}
}
],
"description": [],
"label": "vislibColorMaps",
"source": {
"path": "src/plugins/charts/public/static/color_maps/color_maps.ts",
"lineNumber": 35
},
"initialIsOpen": false
}
],
"start": {
"id": "def-public.ChartsPluginStart",
"type": "Type",
"label": "ChartsPluginStart",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/plugin.ts",
"lineNumber": 31
},
"signature": [
"ChartsPluginSetup"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.palette",
"type": "Function",
"label": "palette",
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"palette\", null, ",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.CustomPaletteArguments",
"text": "CustomPaletteArguments"
},
", ",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.CustomPaletteState",
"text": "CustomPaletteState"
},
">, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-common.systemPalette",
"type": "Function",
"label": "systemPalette",
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"system_palette\", null, ",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.SystemPaletteArguments",
"text": "SystemPaletteArguments"
},
", ",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<unknown>, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 119
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.CustomPaletteArguments",
"type": "Interface",
"label": "CustomPaletteArguments",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CustomPaletteArguments.color",
"type": "Array",
"label": "color",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 14
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.CustomPaletteArguments.gradient",
"type": "boolean",
"label": "gradient",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.CustomPaletteArguments.reverse",
"type": "CompoundType",
"label": "reverse",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 16
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.CustomPaletteState",
"type": "Interface",
"label": "CustomPaletteState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CustomPaletteState.colors",
"type": "Array",
"label": "colors",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 20
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.CustomPaletteState.gradient",
"type": "boolean",
"label": "gradient",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 21
}
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-common.PaletteOutput",
"type": "Interface",
"label": "PaletteOutput",
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PaletteOutput.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 29
},
"signature": [
"\"palette\""
]
},
{
"tags": [],
"id": "def-common.PaletteOutput.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-common.PaletteOutput.params",
"type": "Uncategorized",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 31
},
"signature": [
"T | undefined"
]
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-common.SystemPaletteArguments",
"type": "Interface",
"label": "SystemPaletteArguments",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SystemPaletteArguments.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 25
}
}
],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 24
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.COLOR_MAPPING_SETTING",
"type": "string",
"label": "COLOR_MAPPING_SETTING",
"description": [],
"source": {
"path": "src/plugins/charts/common/index.ts",
"lineNumber": 9
},
"signature": [
"\"visualization:colorMapping\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.defaultCustomColors",
"type": "Array",
"label": "defaultCustomColors",
"description": [],
"source": {
"path": "src/plugins/charts/common/palette.ts",
"lineNumber": 33
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.paletteIds",
"type": "Array",
"label": "paletteIds",
"description": [],
"source": {
"path": "src/plugins/charts/common/constants.ts",
"lineNumber": 10
},
"signature": [
"string[]"
],
"initialIsOpen": false
}
],
"objects": []
}
}