@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
49 lines • 2.2 kB
TypeScript
/**
*
* 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 type { EChartsOption } from 'echarts';
import type { ChartProps, EchartsSeries } from '../utils/chart-types';
import type { NormalizedThresholdLine } from '../utils/threshold';
export type UseChartOptionParams = {
dataZoom: EChartsOption['dataZoom'];
dataset: ChartProps['dataset'];
hasCategoryXAxis: boolean;
hasSliderZoom: boolean;
propsSeries: ChartProps['series'];
series: EchartsSeries;
settings: ChartProps['settings'];
thresholdLines: NormalizedThresholdLine[];
toolboxOptions: EChartsOption['toolbox'];
userOption: ChartProps['option'];
xAxis: EChartsOption['xAxis'];
yAxis: EChartsOption['yAxis'];
hasMarkArea: boolean;
};
/**
* 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 declare function useChartOption({ dataZoom, dataset, hasCategoryXAxis, hasSliderZoom, propsSeries, series, settings, thresholdLines, toolboxOptions, userOption, xAxis, yAxis, hasMarkArea, }: UseChartOptionParams): EChartsOption | undefined;
//# sourceMappingURL=use-chart-option.d.ts.map