{ "id": "visTypeXy", "client": { "classes": [], "functions": [ { "parentPluginId": "visTypeXy", "id": "def-public.getAggId", "type": "Function", "tags": [], "label": "getAggId", "description": [ "\nGet agg id from accessor\n\nFor now this is determined by the esaggs column name. Could be cleaned up in the future." ], "signature": [ "(accessor: string) => string" ], "path": "src/plugins/vis_types/xy/public/config/get_agg_id.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.getAggId.$1", "type": "string", "tags": [], "label": "accessor", "description": [], "signature": [ "string" ], "path": "src/plugins/vis_types/xy/public/config/get_agg_id.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.getPositions", "type": "Function", "tags": [], "label": "getPositions", "description": [], "signature": [ "() => ({ text: string; value: \"top\"; } | { text: string; value: \"left\"; } | { text: string; value: \"right\"; } | { text: string; value: \"bottom\"; })[]" ], "path": "src/plugins/vis_types/xy/public/editor/positions.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.getScaleTypes", "type": "Function", "tags": [], "label": "getScaleTypes", "description": [], "signature": [ "() => { text: string; value: ", { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.ScaleType", "text": "ScaleType" }, "; }[]" ], "path": "src/plugins/vis_types/xy/public/editor/scale_types.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.TruncateLabelsOption", "type": "Function", "tags": [], "label": "TruncateLabelsOption", "description": [], "signature": [ "({ disabled, value = null, setValue }: ", "TruncateLabelsOptionProps", ") => JSX.Element" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/truncate_labels.tsx", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.TruncateLabelsOption.$1", "type": "Object", "tags": [], "label": "{ disabled, value = null, setValue }", "description": [], "signature": [ "TruncateLabelsOptionProps" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/truncate_labels.tsx", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis", "type": "Interface", "tags": [], "label": "CategoryAxis", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.labels", "type": "Object", "tags": [], "label": "labels", "description": [], "signature": [ { "pluginId": "charts", "scope": "common", "docId": "kibChartsPluginApi", "section": "def-common.Labels", "text": "Labels" } ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.position", "type": "CompoundType", "tags": [], "label": "position", "description": [], "signature": [ "\"top\" | \"bottom\" | \"left\" | \"right\"" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.scale", "type": "Object", "tags": [], "label": "scale", "description": [], "signature": [ "Scale" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.show", "type": "boolean", "tags": [], "label": "show", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.title", "type": "Object", "tags": [], "label": "title", "description": [], "signature": [ "{ text?: string | undefined; }" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.type", "type": "Enum", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.AxisType", "text": "AxisType" } ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.CategoryAxis.style", "type": "Object", "tags": [], "label": "style", "description": [ "\nUsed only for heatmap, here for consistent types when used in vis_type_vislib\n\nremove with vis_type_vislib\nhttps://github.com/elastic/kibana/issues/56143" ], "signature": [ "Partial<", { "pluginId": "charts", "scope": "common", "docId": "kibChartsPluginApi", "section": "def-common.Style", "text": "Style" }, "> | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions", "type": "Interface", "tags": [], "label": "Dimensions", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.x", "type": "CompoundType", "tags": [], "label": "x", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, " | null" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.y", "type": "Array", "tags": [], "label": "y", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[]" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.z", "type": "Array", "tags": [], "label": "z", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[] | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.width", "type": "Array", "tags": [], "label": "width", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[] | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.series", "type": "Array", "tags": [], "label": "series", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[] | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.splitRow", "type": "Array", "tags": [], "label": "splitRow", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[] | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Dimensions.splitColumn", "type": "Array", "tags": [], "label": "splitColumn", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.Dimension", "text": "Dimension" }, "[] | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Grid", "type": "Interface", "tags": [], "label": "Grid", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.Grid.categoryLines", "type": "boolean", "tags": [], "label": "categoryLines", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.Grid.valueAxis", "type": "string", "tags": [], "label": "valueAxis", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam", "type": "Interface", "tags": [], "label": "SeriesParam", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.data", "type": "Object", "tags": [], "label": "data", "description": [], "signature": [ "{ label: string; id: string; }" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.drawLinesBetweenPoints", "type": "CompoundType", "tags": [], "label": "drawLinesBetweenPoints", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.interpolate", "type": "CompoundType", "tags": [], "label": "interpolate", "description": [], "signature": [ "InterpolationMode", " | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.lineWidth", "type": "number", "tags": [], "label": "lineWidth", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.mode", "type": "Enum", "tags": [], "label": "mode", "description": [], "signature": [ "ChartMode" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.show", "type": "boolean", "tags": [], "label": "show", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.showCircles", "type": "boolean", "tags": [], "label": "showCircles", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.circlesRadius", "type": "number", "tags": [], "label": "circlesRadius", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.type", "type": "Enum", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "common", "docId": "kibVisTypeXyPluginApi", "section": "def-common.ChartType", "text": "ChartType" } ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.SeriesParam.valueAxis", "type": "string", "tags": [], "label": "valueAxis", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine", "type": "Interface", "tags": [], "label": "ThresholdLine", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine.show", "type": "boolean", "tags": [], "label": "show", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "number | null" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine.width", "type": "CompoundType", "tags": [], "label": "width", "description": [], "signature": [ "number | null" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine.style", "type": "Enum", "tags": [], "label": "style", "description": [], "signature": [ "ThresholdLineStyle" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ThresholdLine.color", "type": "string", "tags": [], "label": "color", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ValidationVisOptionsProps", "type": "Interface", "tags": [], "label": "ValidationVisOptionsProps", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.ValidationVisOptionsProps", "text": "ValidationVisOptionsProps" }, " extends ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisEditorOptionsProps", "text": "VisEditorOptionsProps" }, "" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/validation_wrapper.tsx", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.ValidationVisOptionsProps.setMultipleValidity", "type": "Function", "tags": [], "label": "setMultipleValidity", "description": [], "signature": [ "(paramName: string, isValid: boolean) => void" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/validation_wrapper.tsx", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.ValidationVisOptionsProps.setMultipleValidity.$1", "type": "string", "tags": [], "label": "paramName", "description": [], "signature": [ "string" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/validation_wrapper.tsx", "deprecated": false, "isRequired": true }, { "parentPluginId": "visTypeXy", "id": "def-public.ValidationVisOptionsProps.setMultipleValidity.$2", "type": "boolean", "tags": [], "label": "isValid", "description": [], "signature": [ "boolean" ], "path": "src/plugins/vis_types/xy/public/editor/components/common/validation_wrapper.tsx", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ValueAxis", "type": "Interface", "tags": [], "label": "ValueAxis", "description": [], "signature": [ { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.ValueAxis", "text": "ValueAxis" }, " extends ", { "pluginId": "visTypeXy", "scope": "public", "docId": "kibVisTypeXyPluginApi", "section": "def-public.CategoryAxis", "text": "CategoryAxis" } ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "children": [ { "parentPluginId": "visTypeXy", "id": "def-public.ValueAxis.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "visTypeXy", "id": "def-public.AxisType", "type": "Enum", "tags": [], "label": "AxisType", "description": [], "path": "src/plugins/vis_types/xy/public/types/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ChartType", "type": "Enum", "tags": [], "label": "ChartType", "description": [ "\nType of charts able to render" ], "path": "src/plugins/vis_types/xy/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.ScaleType", "type": "Enum", "tags": [], "label": "ScaleType", "description": [], "path": "src/plugins/vis_types/xy/public/types/constants.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "visTypeXy", "id": "def-public.Dimension", "type": "Type", "tags": [], "label": "Dimension", "description": [], "signature": [ "Pick<", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.SchemaConfig", "text": "SchemaConfig" }, ", \"label\" | \"format\" | \"accessor\" | \"aggType\"> & { params: {} | ", "DateHistogramParams", " | ", "HistogramParams", " | ", "FakeParams", "; }" ], "path": "src/plugins/vis_types/xy/public/types/param.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "visTypeXy", "id": "def-public.XyVisType", "type": "Type", "tags": [], "label": "XyVisType", "description": [ "\nType of xy visualizations" ], "signature": [ { "pluginId": "visTypeXy", "scope": "common", "docId": "kibVisTypeXyPluginApi", "section": "def-common.ChartType", "text": "ChartType" }, " | \"horizontal_bar\"" ], "path": "src/plugins/vis_types/xy/common/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "visTypeXy", "id": "def-public.VisTypeXyPluginSetup", "type": "Interface", "tags": [], "label": "VisTypeXyPluginSetup", "description": [], "path": "src/plugins/vis_types/xy/public/plugin.ts", "deprecated": false, "children": [], "lifecycle": "setup", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [ { "parentPluginId": "visTypeXy", "id": "def-common.ChartType", "type": "Enum", "tags": [], "label": "ChartType", "description": [ "\nType of charts able to render" ], "path": "src/plugins/vis_types/xy/common/index.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "visTypeXy", "id": "def-common.XyVisType", "type": "Type", "tags": [], "label": "XyVisType", "description": [ "\nType of xy visualizations" ], "signature": [ { "pluginId": "visTypeXy", "scope": "common", "docId": "kibVisTypeXyPluginApi", "section": "def-common.ChartType", "text": "ChartType" }, " | \"horizontal_bar\"" ], "path": "src/plugins/vis_types/xy/common/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] } }