@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
36 lines • 1.42 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 { ChartProps } from '../utils/chart-types';
type UseChartZoomParams = {
callbacks: ChartProps['callbacks'];
isChartZoomDisabled: boolean;
};
/**
* Owns ECharts zoom interactions and forwards zoom changes to consumers.
*
* The hook subscribes to ECharts `datazoom` events, enables drag-to-zoom through
* ECharts' global cursor API, resets zoom on double click, and clears ECharts'
* SVG cursor override after mouse movement so Needle's default cursor styling is
* preserved.
*/
export declare function useChartZoom({ callbacks, isChartZoomDisabled, }: UseChartZoomParams): void;
export {};
//# sourceMappingURL=use-chart-zoom.d.ts.map