@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
38 lines • 1.6 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 ReactNode } from 'react';
export type ChartRefs = {
chartEchartRef: React.RefObject<HTMLDivElement | null>;
legendColorCacheRef: React.RefObject<Map<string, string>>;
legendSelectedRef: React.RefObject<Record<string, boolean>>;
};
/**
* Creates the mutable refs shared between `ChartRender` and legend components.
*
* `chartEchartRef` points at the ECharts host element, while the legend refs act
* as a bridge for state that ECharts needs synchronously during option rebuilds
* without forcing extra React renders.
*/
export declare function ChartRefsProvider({ children }: {
children: ReactNode;
}): import("react").FunctionComponentElement<import("react").ProviderProps<ChartRefs | undefined>>;
export declare function useChartRefsContext(): ChartRefs;
//# sourceMappingURL=use-chart-refs.d.ts.map