@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
57 lines • 2.4 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 './chart-types';
import type { NormalizedThresholdLine } from './threshold';
type BuildChartOptionParams = {
dataZoom: EChartsOption['dataZoom'];
dataset: ChartProps['dataset'];
hasCategoryXAxis: boolean;
hasSliderZoom: boolean;
legendSelected: Record<string, boolean>;
propsSeries: ChartProps['series'];
series: EchartsSeries;
thresholdLines: NormalizedThresholdLine[];
toolboxOptions: EChartsOption['toolbox'];
userOption: ChartProps['option'];
xAxis: EChartsOption['xAxis'];
yAxis: EChartsOption['yAxis'];
hasMarkArea: boolean;
};
/**
* Slider zoom needs extra bottom grid space for ECharts' slider control.
*/
export declare function hasSliderDataZoom(dataZoom: EChartsOption['dataZoom']): boolean;
/**
* Mark area needs extra top grid space to fit inside the chart.
*/
export declare const hasMarkAreaInSeries: (series: EchartsSeries) => boolean;
/**
* Category x-axes use slightly wider grid padding to avoid clipped labels.
*/
export declare function hasCategoryXAxis(xAxis: EChartsOption['xAxis']): boolean;
/**
* Builds the ECharts option object from Needle chart props and derived values.
* Applying the option to an ECharts instance happens in `useChartOption`.
*/
export declare function buildChartOption({ dataZoom, dataset, hasCategoryXAxis, hasSliderZoom, legendSelected, propsSeries, series, thresholdLines, toolboxOptions, userOption, xAxis, yAxis, hasMarkArea, }: BuildChartOptionParams): EChartsOption;
export {};
//# sourceMappingURL=build-chart-option.d.ts.map