@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
78 lines • 2.89 kB
JavaScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { getInstanceByDom } from 'echarts';
import { useEffect, useState } from 'react';
import { buildChartOption } from '../utils/build-chart-option';
import { useChartRefsContext } from './use-chart-refs';
/**
* Builds, applies, and exposes the ECharts option for the current React props.
*
* `buildChartOption` merges Needle defaults, normalized axes/series, threshold
* lines, zoom settings, toolbox options, user overrides, and the current legend
* selection. After `setOption`, the hook returns ECharts' normalized option so
* downstream code, especially the custom legend, can read the final series and
* dataset shape ECharts is actually using.
*/
export function useChartOption({ dataZoom, dataset, hasCategoryXAxis, hasSliderZoom, propsSeries, series, settings, thresholdLines, toolboxOptions, userOption, xAxis, yAxis, hasMarkArea, }) {
const { chartEchartRef, legendSelectedRef } = useChartRefsContext();
const [chartOption, setChartOption] = useState();
useEffect(() => {
if (chartEchartRef.current === null) {
return;
}
const chart = getInstanceByDom(chartEchartRef.current);
const option = buildChartOption({
dataZoom,
dataset,
hasCategoryXAxis,
hasMarkArea,
hasSliderZoom,
legendSelected: legendSelectedRef.current || {},
propsSeries,
series,
thresholdLines,
toolboxOptions,
userOption,
xAxis,
yAxis,
});
chart === null || chart === void 0 ? void 0 : chart.setOption(option, settings);
setChartOption(chart === null || chart === void 0 ? void 0 : chart.getOption());
}, [
chartEchartRef,
dataZoom,
dataset,
hasCategoryXAxis,
hasMarkArea,
hasSliderZoom,
legendSelectedRef,
propsSeries,
series,
settings,
thresholdLines,
toolboxOptions,
userOption,
xAxis,
yAxis,
]);
return chartOption;
}
//# sourceMappingURL=use-chart-option.js.map