@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
42 lines • 1.78 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 { LegendProps } from '../utils/chart-types';
type UseLegendSeriesParams = {
chartOption: EChartsOption | undefined;
isWaitingForFirstResize: boolean;
};
type LegendSeries = LegendProps['series'];
/**
* Derives Needle legend rows from ECharts' normalized option and visual state.
*
* Standard series map one-to-one with legend items. Pie charts instead create a
* legend item for each data row, so the hook reads the encoded item-name column
* from the dataset and asks ECharts for each slice color. Fresh colors are
* cached while all slices are visible because ECharts reports dimmed colors for
* deselected slices.
*
* The hook waits until the first chart resize has completed so color lookups run
* against an initialized ECharts instance.
*/
export declare function useLegendSeries({ chartOption, isWaitingForFirstResize, }: UseLegendSeriesParams): LegendSeries | undefined;
export {};
//# sourceMappingURL=use-legend-series.d.ts.map