{ "id": "charts", "client": { "classes": [], "functions": [ { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" } }, { "type": "string", "label": "colorSchemaName", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/charts/public/static/colors/color_palette.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/legend_toggle.tsx#L51" }, "signature": [ "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" ], "initialIsOpen": false }, { "id": "def-public.ColorPicker", "type": "Function", "children": [ { "type": "Object", "label": "{ onChange, color: selectedColor, id, label }", "isRequired": true, "signature": [ "ColorPickerProps" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/color_picker.tsx", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83" } } ], "signature": [ "({ onChange, color: selectedColor, id, label }: ColorPickerProps) => JSX.Element" ], "description": [], "label": "ColorPicker", "source": { "path": "src/plugins/charts/public/static/components/color_picker.tsx", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.CurrentTime", "type": "Function", "children": [ { "type": "CompoundType", "label": "{ isDarkMode, domainEnd }", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/current_time.tsx", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24" } } ], "signature": [ "({ isDarkMode, domainEnd }: React.PropsWithChildren) => 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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24" }, "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" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37" } } ], "signature": [ "({ isDarkMode, domainStart, domainEnd, interval, domainMin, domainMax, hideTooltips, isFullBin, }: React.PropsWithChildren) => JSX.Element" ], "description": [], "label": "Endzones", "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L121" } }, { "type": "number", "label": "esValue", "isRequired": true, "signature": [ "number" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 122, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L122" } }, { "type": "CompoundType", "label": "esUnit", "isRequired": true, "signature": [ "moment.unitOfTime.Base" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 123, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L123" } }, { "type": "string", "label": "timeZone", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 124, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L124" } } ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L120" }, "tags": [], "returnComment": [], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L160" } }, { "type": "number", "label": "domainStart", "isRequired": false, "signature": [ "number | undefined" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 161, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L161" } }, { "type": "number", "label": "domainEnd", "isRequired": false, "signature": [ "number | undefined" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 162, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L162" } }, { "type": "Function", "label": "formatter", "isRequired": false, "signature": [ "((v: any) => string) | undefined" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 163, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L163" } }, { "type": "boolean", "label": "renderValue", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 164, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L164" } } ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L159" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L172" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L173" } }, { "type": "Object", "label": "splitSeriesAccessorFnMap", "isRequired": false, "signature": [ "Map | undefined" ], "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 174, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L174" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L175" } }, { "type": "boolean", "label": "negate", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 176, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L176" } } ], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", xAccessor: string | number | ", "AccessorFn", ", splitSeriesAccessorFnMap?: Map | 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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L171" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220" } } ], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => ({ splitAccessors, ...rest }: ", "XYChartSeriesIdentifier", ", splitSeriesAccessorFnMap?: Map | 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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L255" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L256" } } ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L254" }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.PaletteOutput", "type": "Interface", "label": "PaletteOutput", "signature": [ { "pluginId": "charts", "scope": "common", "docId": "kibChartsPluginApi", "section": "def-common.PaletteOutput", "text": "PaletteOutput" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.PaletteOutput.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29" }, "signature": [ "\"palette\"" ] }, { "tags": [], "id": "def-public.PaletteOutput.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30" } }, { "tags": [], "id": "def-public.PaletteOutput.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31" }, "signature": [ "T | undefined" ] } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14" }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-public.CustomPaletteArguments.gradient", "type": "boolean", "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15" } }, { "tags": [], "id": "def-public.CustomPaletteArguments.reverse", "type": "CompoundType", "label": "reverse", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20" }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.CustomPaletteState.gradient", "type": "boolean", "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21" } } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25" } } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L21" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L22" } } ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L20" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L26" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L27" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L28" }, "signature": [ "[number, number[]][]" ] } ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L25" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L32" }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L31" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L13" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L14" } } ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L12" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L18" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L19" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L20" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L21" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L22" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L23" }, "signature": [ "number | null | undefined" ] } ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L17" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L27" } }, { "tags": [], "id": "def-public.Style.bgColor", "type": "boolean", "label": "bgColor", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L28" } }, { "tags": [], "id": "def-public.Style.labelColor", "type": "boolean", "label": "labelColor", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L29" } }, { "tags": [], "id": "def-public.Style.subText", "type": "string", "label": "subText", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L30" } }, { "tags": [], "id": "def-public.Style.fontSize", "type": "number", "label": "fontSize", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L31" } } ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L26" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L22" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L23" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L21" }, "initialIsOpen": false }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L27" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L28" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L26" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L19" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L23" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L27" } } ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L15" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L37" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L41" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L46" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L51" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L33" }, "initialIsOpen": false }, { "id": "def-public.PaletteDefinition", "type": "Interface", "label": "PaletteDefinition", "signature": [ { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.PaletteDefinition", "text": "PaletteDefinition" }, "" ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L67" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L71" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L75" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L81" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L88" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L97" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L106" }, "signature": [ "(size: number, state?: T | undefined) => string[]" ] } ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L63" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L110" }, "signature": [ "(name: string) => ", { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.PaletteDefinition", "text": "PaletteDefinition" }, "" ] }, { "tags": [], "id": "def-public.PaletteRegistry.getAll", "type": "Function", "label": "getAll", "description": [], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 111, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L111" }, "signature": [ "() => ", { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.PaletteDefinition", "text": "PaletteDefinition" }, "[]" ] } ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 109, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L109" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L11" }, "initialIsOpen": false } ], "misc": [ { "tags": [], "id": "def-public.paletteIds", "type": "Array", "label": "paletteIds", "description": [], "source": { "path": "src/plugins/charts/common/constants.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10" }, "signature": [ "string[]" ], "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": 3160, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L3160" }, "signature": [ { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.ColorSchema", "text": "ColorSchema" }, "[]" ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L26" }, "signature": [ { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.ColorSchema", "text": "ColorSchema" }, "[]" ], "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/seed_colors.ts#L14" }, "signature": [ "string[]" ], "initialIsOpen": false }, { "id": "def-public.ColorMode", "type": "Type", "label": "ColorMode", "tags": [], "description": [], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L17" }, "signature": [ "\"Background\" | \"Labels\" | \"None\"" ], "initialIsOpen": false }, { "id": "def-public.LabelRotation", "type": "Type", "label": "LabelRotation", "tags": [], "description": [], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L24" }, "signature": [ "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.defaultCountLabel", "type": "string", "label": "defaultCountLabel", "description": [], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L26" }, "initialIsOpen": false } ], "objects": [ { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L38" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L39" } }, { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L42" }, "signature": [ "[number, number[]][]" ] } ], "description": [ "// Sequential" ], "label": "[ColorSchemas.Blues]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L37" } }, { "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": 558, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L558" }, "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": 559, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L559" } }, { "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": 562, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L562" }, "signature": [ "[number, number[]][]" ] } ], "description": [], "label": "[ColorSchemas.Greens]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 557, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L557" } }, { "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": 1078, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1078" }, "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": 1079, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1079" } }, { "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": 1082, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1082" }, "signature": [ "[number, number[]][]" ] } ], "description": [], "label": "[ColorSchemas.Greys]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 1077, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1077" } }, { "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": 1598, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1598" }, "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": 1599, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1599" } }, { "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": 1602, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1602" }, "signature": [ "[number, number[]][]" ] } ], "description": [], "label": "[ColorSchemas.Reds]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 1597, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1597" } }, { "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": 2118, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2118" }, "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": 2119, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2119" } }, { "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": 2122, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2122" }, "signature": [ "[number, number[]][]" ] } ], "description": [], "label": "[ColorSchemas.YellowToRed]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 2117, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2117" } }, { "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": 2639, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2639" }, "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": 2640, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2640" } }, { "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": 2643, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2643" }, "signature": [ "[number, number[]][]" ] } ], "description": [], "label": "[ColorSchemas.GreenToRed]", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 2638, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2638" } } ], "description": [], "label": "vislibColorMaps", "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L35" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L11" }, "initialIsOpen": false }, { "tags": [], "id": "def-public.ColorMode", "type": "Object", "label": "ColorMode", "description": [], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L12" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L19" }, "signature": [ "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" ], "initialIsOpen": false } ], "start": { "id": "def-public.ChartsPluginStart", "type": "Type", "label": "ChartsPluginStart", "tags": [ "public" ], "description": [], "source": { "path": "src/plugins/charts/public/plugin.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/plugin.ts#L31" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L53" }, "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" }, ", ", { "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L119" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14" }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-common.CustomPaletteArguments.gradient", "type": "boolean", "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15" } }, { "tags": [], "id": "def-common.CustomPaletteArguments.reverse", "type": "CompoundType", "label": "reverse", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20" }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.CustomPaletteState.gradient", "type": "boolean", "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21" } } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25" } } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" }, "initialIsOpen": false }, { "id": "def-common.PaletteOutput", "type": "Interface", "label": "PaletteOutput", "signature": [ { "pluginId": "charts", "scope": "common", "docId": "kibChartsPluginApi", "section": "def-common.PaletteOutput", "text": "PaletteOutput" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.PaletteOutput.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29" }, "signature": [ "\"palette\"" ] }, { "tags": [], "id": "def-common.PaletteOutput.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30" } }, { "tags": [], "id": "def-common.PaletteOutput.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31" }, "signature": [ "T | undefined" ] } ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/index.ts#L9" }, "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, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L33" }, "signature": [ "string[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.paletteIds", "type": "Array", "label": "paletteIds", "description": [], "source": { "path": "src/plugins/charts/common/constants.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10" }, "signature": [ "string[]" ], "initialIsOpen": false } ], "objects": [] } }