@react-fabric/chart 1.0.0-beta.9 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/{src/wrapper/Chart.module.css → css/_chart.css} +11 -11
  2. package/css/styles.css +24 -0
  3. package/dist/cjs/charts/ActivityMap.js +70 -36
  4. package/dist/cjs/charts/CountSeries.js +67 -35
  5. package/dist/cjs/charts/DataSeries.js +75 -40
  6. package/dist/cjs/charts/Generic.js +41 -19
  7. package/dist/cjs/charts/MapSeries.js +41 -17
  8. package/dist/cjs/charts/TimeSeries.js +73 -40
  9. package/dist/cjs/charts/TimeSlider.js +40 -21
  10. package/dist/cjs/charts/WordBubble.js +65 -29
  11. package/dist/cjs/index.js +28 -0
  12. package/dist/cjs/theme/darkBase.js +13 -10
  13. package/dist/cjs/theme/index.js +43 -23
  14. package/dist/cjs/theme/lightBase.js +18 -15
  15. package/dist/cjs/theme/palettes.js +5 -54
  16. package/dist/cjs/types/charts.js +4 -2
  17. package/dist/cjs/types/utils.js +6 -9
  18. package/dist/cjs/wrapper/ChartContainer.js +26 -18
  19. package/dist/cjs/wrapper/ChartToolbar.js +4 -5
  20. package/dist/cjs/wrapper/ChartWrapper.js +4 -5
  21. package/dist/cjs/wrapper/PaletteSelect.js +31 -18
  22. package/dist/esm/charts/ActivityMap.js +71 -37
  23. package/dist/esm/charts/CountSeries.js +68 -36
  24. package/dist/esm/charts/DataSeries.js +76 -41
  25. package/dist/esm/charts/Generic.js +43 -21
  26. package/dist/esm/charts/MapSeries.js +41 -17
  27. package/dist/esm/charts/TimeSeries.js +74 -41
  28. package/dist/esm/charts/TimeSlider.js +41 -22
  29. package/dist/esm/charts/WordBubble.js +67 -31
  30. package/dist/esm/index.js +30 -0
  31. package/dist/esm/theme/darkBase.js +13 -10
  32. package/dist/esm/theme/index.js +43 -23
  33. package/dist/esm/theme/lightBase.js +18 -15
  34. package/dist/esm/theme/palettes.js +5 -54
  35. package/dist/esm/types/charts.js +4 -2
  36. package/dist/esm/types/utils.js +6 -9
  37. package/dist/esm/wrapper/ChartContainer.js +27 -19
  38. package/dist/esm/wrapper/ChartToolbar.js +4 -5
  39. package/dist/esm/wrapper/ChartWrapper.js +4 -5
  40. package/dist/esm/wrapper/PaletteSelect.js +32 -19
  41. package/dist/types/charts/ActivityMap.d.ts +20 -4
  42. package/dist/types/charts/CountSeries.d.ts +25 -3
  43. package/dist/types/charts/DataSeries.d.ts +26 -1
  44. package/dist/types/charts/Generic.d.ts +36 -52
  45. package/dist/types/charts/MapSeries.d.ts +31 -3
  46. package/dist/types/charts/TimeSeries.d.ts +24 -1
  47. package/dist/types/charts/TimeSlider.d.ts +19 -5
  48. package/dist/types/charts/WordBubble.d.ts +28 -5
  49. package/dist/types/index.d.ts +26 -0
  50. package/dist/types/theme/darkBase.d.ts +8 -5
  51. package/dist/types/theme/index.d.ts +3 -2
  52. package/dist/types/theme/lightBase.d.ts +8 -5
  53. package/dist/types/types/charts.d.ts +2 -1
  54. package/dist/types/types/index.d.ts +30 -12
  55. package/dist/types/types/world.svg.d.ts +1 -1
  56. package/dist/types/wrapper/ChartContainer.d.ts +7 -7
  57. package/dist/types/wrapper/ChartToolbar.d.ts +2 -3
  58. package/dist/types/wrapper/ChartWrapper.d.ts +3 -5
  59. package/dist/types/wrapper/PaletteSelect.d.ts +6 -1
  60. package/package.json +17 -21
  61. package/src/charts/ActivityMap.tsx +95 -94
  62. package/src/charts/CountSeries.tsx +73 -65
  63. package/src/charts/DataSeries.tsx +104 -98
  64. package/src/charts/Generic.tsx +56 -86
  65. package/src/charts/MapSeries.tsx +153 -151
  66. package/src/charts/TimeSeries.tsx +96 -79
  67. package/src/charts/TimeSlider.tsx +194 -195
  68. package/src/charts/WordBubble.tsx +97 -62
  69. package/src/index.ts +22 -17
  70. package/src/theme/darkBase.ts +12 -9
  71. package/src/theme/index.ts +92 -30
  72. package/src/theme/lightBase.ts +17 -14
  73. package/src/theme/palettes.ts +1 -52
  74. package/src/types/charts.ts +6 -2
  75. package/src/types/index.ts +40 -4
  76. package/src/types/utils.ts +18 -30
  77. package/src/wrapper/ChartContainer.tsx +48 -79
  78. package/src/wrapper/ChartToolbar.tsx +5 -12
  79. package/src/wrapper/ChartWrapper.tsx +5 -10
  80. package/src/wrapper/PaletteSelect.tsx +43 -40
  81. package/dist/cjs/wrapper/Chart.module.css +0 -1
  82. package/dist/esm/wrapper/Chart.module.css +0 -1
@@ -21,15 +21,9 @@
21
21
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
22
  */
23
23
 
24
- import {
25
- Button,
26
- CoreIcons,
27
- Divider,
28
- ToggleButtonGroup,
29
- useMemoDebugger,
30
- } from "@react-fabric/core";
24
+ import { Button, Divider, ToggleButtonGroup, useMemoDebugger } from "@react-fabric/core";
31
25
  import { isEmpty } from "@react-fabric/utilities";
32
- import { type EChartOption, type EChartsType } from "echarts";
26
+ import { type EChartsOption, type EChartsType } from "echarts";
33
27
  import { memo, useEffect, useRef, useState, type FC } from "react";
34
28
  import { type BaseChart, type SeriesType } from "../types";
35
29
  import { seriesRenderer } from "../types/utils";
@@ -38,43 +32,41 @@ import { ChartWrapper } from "../wrapper/ChartWrapper";
38
32
  import { PaletteSelect } from "../wrapper/PaletteSelect";
39
33
 
40
34
  export interface DataSeriesProps extends BaseChart, SeriesType {
41
- type?:
42
- | "column"
43
- | "line"
44
- | "bar"
45
- | "radar"
46
- | "line-stacked"
47
- | "column-stacked"
48
- | "bar-stacked";
35
+ type?: "column" | "line" | "bar" | "radar" | "line-stacked" | "column-stacked" | "bar-stacked";
49
36
  onClick?: (data: { category: string; series: string }) => void;
50
37
  }
51
38
 
52
39
  const DataSeriesChart: FC<DataSeriesProps> = memo(
53
40
  ({
54
- data,
41
+ series: _series,
55
42
  onExport,
56
43
  categories,
57
44
  categoryAxisName,
58
45
  valueAxisName,
59
46
  title,
47
+ options: optionOverride,
48
+ showThemeSelector,
49
+ showTypeSelector,
60
50
  theme: chartTheme,
61
51
  type: chartType = "column",
62
52
  onClick,
63
53
  }: DataSeriesProps) => {
64
54
  const chartRef = useRef<EChartsType>(null);
65
- const [type, setType] = useState(chartType);
66
- const [theme, setTheme] = useState(chartTheme);
55
+ const [type, setType] = useState(() => chartType);
56
+ const [theme, setTheme] = useState(() => chartTheme);
67
57
 
68
58
  useEffect(() => {
59
+ // eslint-disable-next-line @eslint-react/set-state-in-effect
69
60
  setType(chartType);
70
61
  }, [chartType]);
71
62
  useEffect(() => {
63
+ // eslint-disable-next-line @eslint-react/set-state-in-effect
72
64
  setTheme(chartTheme);
73
65
  }, [chartTheme]);
74
66
 
75
- const options = useMemoDebugger<EChartOption>(
67
+ const options = useMemoDebugger<EChartsOption>(
76
68
  () => {
77
- if (isEmpty(data)) {
69
+ if (isEmpty(_series)) {
78
70
  chartRef.current?.clear();
79
71
  return {};
80
72
  }
@@ -82,10 +74,12 @@ const DataSeriesChart: FC<DataSeriesProps> = memo(
82
74
  const stack = type.includes("stacked") ? "stack" : undefined;
83
75
 
84
76
  const [_type, stacked] = type.split("-");
85
- const categoryAxis: AnyObject =
77
+ const categoryAxis = Object.assign(
78
+ {},
79
+ optionOverride?.xAxis,
86
80
  _type === "radar"
87
81
  ? undefined
88
- : ({
82
+ : {
89
83
  name: categoryAxisName,
90
84
  type: "category",
91
85
  nameGap: 32,
@@ -94,27 +88,31 @@ const DataSeriesChart: FC<DataSeriesProps> = memo(
94
88
  show: false,
95
89
  },
96
90
  data: categories,
97
- } as EChartOption.XAxis);
98
- const valueAxis: AnyObject =
91
+ },
92
+ );
93
+ const valueAxis = Object.assign(
94
+ {},
95
+ optionOverride?.yAxis,
99
96
  _type === "radar"
100
97
  ? undefined
101
- : ({
98
+ : {
102
99
  name: valueAxisName,
103
100
  type: "value",
104
101
  nameGap: 32,
105
102
  nameLocation: "center",
106
- } as EChartOption.YAxis);
103
+ },
104
+ );
107
105
  const radar =
108
106
  _type !== "radar"
109
107
  ? undefined
110
- : ({
108
+ : Object.assign({}, optionOverride?.radar, {
111
109
  shape: "circle",
112
110
  indicator: categories?.map((c) => ({ name: c })),
113
- } as AnyObject);
111
+ });
114
112
 
115
- const series = data?.map((item, index) => ({
116
- id: item.id,
117
- stack,
113
+ const series = _series?.map((item) => ({
114
+ ...item,
115
+ stack: item.stack ?? stack,
118
116
  areaStyle: stacked ? {} : undefined,
119
117
  type: _type === "column" ? "bar" : _type,
120
118
  name: item.label ?? item.id,
@@ -123,27 +121,32 @@ const DataSeriesChart: FC<DataSeriesProps> = memo(
123
121
  _type === "radar"
124
122
  ? [
125
123
  {
126
- value: item.values,
124
+ value: item.data,
127
125
  id: item.id,
128
- name: item.label ?? item.id,
126
+ name: item.name ?? item.id,
129
127
  },
130
128
  ]
131
- : item.values,
129
+ : item.data,
132
130
  }));
133
131
 
134
132
  return {
133
+ ...optionOverride,
135
134
  xAxis: type.startsWith("bar") ? valueAxis : categoryAxis,
136
135
  yAxis: type.startsWith("bar") ? categoryAxis : valueAxis,
137
136
  radar,
138
137
  series,
139
- tooltip: {
140
- trigger: _type === "radar" ? "item" : "axis",
141
- confine: true,
142
- position: "top",
143
- } as AnyObject,
138
+ tooltip: Object.assign(
139
+ {
140
+ trigger: _type === "radar" ? "item" : "axis",
141
+ confine: true,
142
+ position: "top",
143
+ appendToBody: true,
144
+ },
145
+ optionOverride?.tooltip,
146
+ ),
144
147
  };
145
148
  },
146
- [data, type, categories, categoryAxisName, valueAxisName],
149
+ [_series, type, categories, categoryAxisName, valueAxisName, optionOverride],
147
150
  "DataChart options",
148
151
  );
149
152
 
@@ -154,64 +157,42 @@ const DataSeriesChart: FC<DataSeriesProps> = memo(
154
157
  theme={theme}
155
158
  options={options}
156
159
  chartRef={chartRef}
157
- isEmpty={isEmpty(data)}
158
- emptyIcon={CoreIcons.chartColumn}
160
+ isEmpty={isEmpty(_series)}
161
+ emptyIcon="icon-[mdi--chart-bar]"
159
162
  dataTableRenderer={seriesRenderer}
160
- onClick={(e) => onClick?.({ category: e.name, series: e.seriesId })}
163
+ onClick={(e) => onClick?.({ category: e.name, series: e.seriesId ?? "" })}
161
164
  >
162
- <ToggleButtonGroup value={type} onChange={setType as AnyObject}>
163
- <Button
164
- size="sm"
165
- variant="link"
166
- icon={CoreIcons.chartLine}
167
- aria-label="line"
168
- value="line"
169
- />
170
- <Button
171
- size="sm"
172
- variant="link"
173
- icon={CoreIcons.chartColumn}
174
- aria-label="column"
175
- value="column"
176
- />
177
- <Button
178
- size="sm"
179
- variant="link"
180
- icon={CoreIcons.chartBar}
181
- aria-label="bar"
182
- value="bar"
183
- />
184
- <Button
185
- size="sm"
186
- variant="link"
187
- icon={CoreIcons.chartRadar}
188
- aria-label="radar"
189
- value="radar"
190
- />
191
- <Button
192
- size="sm"
193
- variant="link"
194
- icon={CoreIcons.chartLineStacked}
195
- aria-label="line-stacked"
196
- value="line-stacked"
197
- />
198
- <Button
199
- size="sm"
200
- variant="link"
201
- icon={CoreIcons.chartColumnStacked}
202
- aria-label="column-stacked"
203
- value="column-stacked"
204
- />
205
- <Button
206
- size="sm"
207
- variant="link"
208
- icon={CoreIcons.chartBarStacked}
209
- aria-label="bar-stacked"
210
- value="bar-stacked"
211
- />
212
- </ToggleButtonGroup>
213
- <Divider vertical />
214
- <PaletteSelect theme={theme} onClick={setTheme} />
165
+ {showTypeSelector && (
166
+ <ToggleButtonGroup value={type} onChange={setType}>
167
+ <Button size="sm" variant="link" icon="icon-[mdi--chart-line]" aria-label="line" value="line" />
168
+ <Button size="sm" variant="link" icon="icon-[mdi--chart-bar]" aria-label="column" value="column" />
169
+ <Button size="sm" variant="link" icon="icon-[mdi--chart-bar] rotate-90 -scale-x-100" aria-label="bar" value="bar" />
170
+ <Button size="sm" variant="link" icon="icon-[mdi--radar]" aria-label="radar" value="radar" />
171
+ <Button
172
+ size="sm"
173
+ variant="link"
174
+ icon="icon-[mdi--chart-line-stacked]"
175
+ aria-label="line-stacked"
176
+ value="line-stacked"
177
+ />
178
+ <Button
179
+ size="sm"
180
+ variant="link"
181
+ icon="icon-[mdi--chart-bar-stacked]"
182
+ aria-label="column-stacked"
183
+ value="column-stacked"
184
+ />
185
+ <Button
186
+ size="sm"
187
+ variant="link"
188
+ icon="icon-[mdi--chart-bar-stacked] rotate-90 -scale-x-100"
189
+ aria-label="bar-stacked"
190
+ value="bar-stacked"
191
+ />
192
+ </ToggleButtonGroup>
193
+ )}
194
+ {showTypeSelector && showThemeSelector && <Divider vertical />}
195
+ {showThemeSelector && <PaletteSelect theme={theme} onClick={setTheme} />}
215
196
  </ChartContainer>
216
197
  );
217
198
  },
@@ -219,7 +200,32 @@ const DataSeriesChart: FC<DataSeriesProps> = memo(
219
200
  DataSeriesChart.displayName = "DataSeriesChart";
220
201
 
221
202
  /**
222
- * Chart to display simple data category series
203
+ * DataSeries component renders a chart for visualizing data series.
204
+ * It supports various chart types such as column, line, bar, radar, and stacked variants.
205
+ * It allows users to click on data points to trigger custom actions.
206
+ *
207
+ * @param {DataSeriesProps} props - The properties for the DataSeries component.
208
+ * @returns {React.ReactElement} The rendered DataSeries component.
209
+ *
210
+ * @example
211
+ * ```jsx
212
+ * <DataSeries
213
+ * data={[{ id: "1", label: "Series 1", values: [10, 20, 30] }]}
214
+ * categories={["Category 1", "Category 2", "Category 3"]}
215
+ * categoryAxisName="Categories"
216
+ * valueAxisName="Values"
217
+ * title="Data Series Example"
218
+ * type="column"
219
+ * onClick={(data) => console.log("Clicked data:", data)}
220
+ * onExport={() => console.log("Exporting chart data")}
221
+ * theme="light"
222
+ * />
223
+ * ```
224
+ *
225
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/charts-dataseries--docs} for more details on the properties.
226
+ * @see {@link https://echarts.apache.org/en/option.html#series-bar} for ECharts bar series options.
227
+ * @see {@link https://echarts.apache.org/en/option.html#series-line} for ECharts line series options.
228
+ * @see {@link https://echarts.apache.org/en/option.html#series-radar} for ECharts radar series options.
223
229
  */
224
230
  export const DataSeries: FC<DataSeriesProps> = (props) => (
225
231
  <ChartWrapper>
@@ -21,82 +21,48 @@
21
21
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
22
  */
23
23
 
24
- import { type EChartOption, type EChartsType } from "echarts";
25
- import {
26
- memo,
27
- useEffect,
28
- useImperativeHandle,
29
- useRef,
30
- type FC,
31
- type RefObject,
32
- } from "react";
33
- import { type BaseChart } from "../types";
24
+ import type { ECElementEvent, EChartsOption, EChartsType } from "echarts";
25
+ import { memo, useEffect, useImperativeHandle, useRef, useState, type Ref } from "react";
26
+ import { type Theme } from "../types";
34
27
  import { ChartContainer } from "../wrapper/ChartContainer";
35
28
  import { ChartWrapper } from "../wrapper/ChartWrapper";
29
+ import { PaletteSelect } from "../wrapper/PaletteSelect";
36
30
 
37
- export interface GenericProps extends BaseChart {
38
- chartRef?: RefObject<EChartsType>;
31
+ export interface GenericProps extends Omit<EChartsOption, "title"> {
32
+ chartRef?: Ref<EChartsType>;
39
33
 
40
- legend?: EChartOption["legend"];
41
- toolbox?: EChartOption["toolbox"];
42
- tooltip?: EChartOption["tooltip"];
34
+ title?: string;
43
35
 
44
- actions?: JSX.Element;
36
+ actions?: React.ReactElement;
45
37
 
46
38
  /**
47
- * 2d axis
39
+ * The theme to be applied to the chart.
40
+ * This can be one of the predefined themes or a custom theme object.
41
+ * Predefined themes include "default", "activity", "cloud", "qualitative", "diverging", "sequential",
42
+ * "spectral", "uber", "fireice", "warming", "sunrise", "ocean", "wine", "red", "green", and "blue".
48
43
  */
49
- xAxis?: EChartOption["xAxis"];
44
+ theme?: Theme;
50
45
  /**
51
- * 2d axis
46
+ * Whether to show the theme selector in the chart.
47
+ * This is useful for allowing users to switch between different themes.
48
+ * If set to true, the chart will render a toggle button group to select the theme.
52
49
  */
53
- yAxis?: EChartOption["yAxis"];
54
- /**
55
- * chart series
56
- */
57
- series?: EChartOption["series"];
58
-
59
- /**
60
- * polar series
61
- */
62
- polar?: EChartOption["polar"];
63
- /**
64
- * polar axis
65
- */
66
- angleAxis?: EChartOption["angleAxis"];
67
- /**
68
- * polar axis
69
- */
70
- radiusAxis?: EChartOption["radiusAxis"];
71
-
72
- /**
73
- * radar series
74
- */
75
- radar?: EChartOption["radar"];
76
-
77
- /**
78
- * paarllel series
79
- */
80
- parallel?: EChartOption["parallel"];
81
- /**
82
- * parallel axis
83
- */
84
- parallelAxis?: EChartOption["parallelAxis"];
50
+ showThemeSelector?: boolean;
85
51
 
86
- onClick?: (e: KeyValue) => void;
87
- onRendered?: (e: KeyValue) => void;
52
+ onClick?: (e: ECElementEvent) => void;
53
+ onRendered?: () => void;
88
54
 
89
- onBrush?: (e: KeyValue) => void;
90
- onBrushEnd?: (e: KeyValue) => void;
91
- onBrushSelected?: (e: KeyValue) => void;
55
+ onBrush?: () => void;
56
+ onBrushEnd?: () => void;
57
+ onBrushSelected?: () => void;
92
58
 
93
59
  /**
94
60
  * Data table renderer that returns HTML string
95
61
  */
96
- dataTableRenderer?: (chartOption: EChartOption) => string;
62
+ dataTableRenderer?: (chartOption: EChartsOption) => string;
97
63
  }
98
64
 
99
- const GenericChartBase: FC<GenericProps> = memo(
65
+ const GenericChartBase = memo(
100
66
  ({
101
67
  chartRef: _ref,
102
68
  onBrush,
@@ -105,86 +71,90 @@ const GenericChartBase: FC<GenericProps> = memo(
105
71
  dataTableRenderer,
106
72
  onClick,
107
73
  onRendered,
74
+ showThemeSelector,
108
75
  actions,
109
76
  title,
110
- theme,
77
+ theme: chartTheme,
111
78
  ...options
112
79
  }: GenericProps) => {
113
80
  const chartRef = useRef<EChartsType>(null);
81
+ const [theme, setTheme] = useState(() => chartTheme);
114
82
 
115
- useImperativeHandle<EChartsType | null, EChartsType | null>(
116
- _ref,
117
- () => chartRef.current,
118
- [chartRef.current],
119
- );
83
+ useImperativeHandle<EChartsType | null, EChartsType | null>(_ref, () => chartRef.current, []);
120
84
 
121
85
  useEffect(() => {
122
86
  const chart = chartRef.current;
123
87
  if (chart && onRendered) {
124
88
  chart.on("finished", onRendered);
125
89
  return () => {
126
- !chart.isDisposed() && chart.off("finished");
90
+ if (!chart.isDisposed()) chart.off("finished");
127
91
  };
128
92
  }
129
- }, [chartRef.current, onRendered]);
93
+ }, [onRendered]);
130
94
 
131
95
  useEffect(() => {
132
96
  const chart = chartRef.current;
133
97
  if (chart && onClick) {
134
98
  chart.on("click", onClick);
135
99
  return () => {
136
- !chart.isDisposed() && chart.off("click");
100
+ if (!chart.isDisposed()) chart.off("click");
137
101
  };
138
102
  }
139
- }, [chartRef.current, onClick]);
103
+ }, [onClick]);
140
104
 
141
105
  useEffect(() => {
142
106
  const chart = chartRef.current;
143
107
  if (chart && onBrush) {
144
108
  chart.on("brush", onBrush);
145
109
  return () => {
146
- !chart.isDisposed() && chart.off("brush");
110
+ if (!chart.isDisposed()) chart.off("brush");
147
111
  };
148
112
  }
149
- }, [chartRef.current, onBrush]);
113
+ }, [onBrush]);
150
114
 
151
115
  useEffect(() => {
152
116
  const chart = chartRef.current;
153
117
  if (chart && onBrushEnd) {
154
118
  chart.on("brushend", onBrushEnd);
155
119
  return () => {
156
- !chart.isDisposed() && chart.off("brushend");
120
+ if (!chart.isDisposed()) chart.off("brushend");
157
121
  };
158
122
  }
159
- }, [chartRef.current, onBrushEnd]);
123
+ }, [onBrushEnd]);
160
124
 
161
125
  useEffect(() => {
162
126
  const chart = chartRef.current;
163
127
  if (chart && onBrushSelected) {
164
128
  chart.on("brushselected", onBrushSelected);
165
129
  return () => {
166
- !chart.isDisposed() && chart.off("brushselected");
130
+ if (!chart.isDisposed()) chart.off("brushselected");
167
131
  };
168
132
  }
169
- }, [chartRef.current, onBrushSelected]);
133
+ }, [onBrushSelected]);
170
134
 
171
135
  return (
172
- <ChartContainer
173
- theme={theme}
174
- options={options}
175
- chartRef={chartRef}
176
- title={title}
177
- dataTableRenderer={dataTableRenderer}
178
- >
136
+ <ChartContainer options={options} chartRef={chartRef} theme={theme} title={title} dataTableRenderer={dataTableRenderer}>
179
137
  {actions}
138
+ {showThemeSelector && <PaletteSelect theme={theme} onClick={setTheme} />}
180
139
  </ChartContainer>
181
140
  );
182
141
  },
183
142
  );
184
143
  GenericChartBase.displayName = "GenericChart";
185
144
 
186
- export const GenericChart: FC<GenericProps> = (props) => (
187
- <ChartWrapper>
188
- <GenericChartBase {...props} />
189
- </ChartWrapper>
190
- );
145
+ /**
146
+ * GenericChart component renders a generic chart using ECharts.
147
+ * It accepts various chart options and configurations, allowing for flexible chart rendering.
148
+ * It supports click events, brush events, and custom actions.
149
+ * It can be used to create a wide range of chart types by passing the appropriate ECharts options.
150
+ *
151
+ * @see {@link https://echarts.apache.org/en/option.html} for ECharts options documentation.
152
+ * @see {@link https://echarts.apache.org/en/api.html#echartsInstance} for ECharts instance methods and properties.
153
+ */
154
+ export function GenericChart(props: GenericProps) {
155
+ return (
156
+ <ChartWrapper>
157
+ <GenericChartBase {...props} />
158
+ </ChartWrapper>
159
+ );
160
+ }