@lightningchart/react-time-series-chart/dist/types/index.d.ts

A React component for interactive, heavy-duty Time Series Charts

import React from 'react';
import { AppDeploymentLicenseInformation, Theme, Point, ChartXY, LineSeries } from '@lightningchart/lcjs';

interface LightningChartXYProps {
    /**
     * ID of the Chart's HTML div.
     * This DIV is automatically created.
     */
    id: string;
    /**
     * Class of the Chart's HTML div.
     */
    className?: string;
    /**
     * License key.
     */
    license?: string;
    /**
     * License information.
     */
    licenseInformation?: AppDeploymentLicenseInformation;
    /**
     * ***LCJS*** theme for the Chart.
     */
    theme?: Theme;
    /**
     * Data points array for each series in the Chart.
     */
    data: Point[][];
    /**
     * Callback function for Chart configuration.
     */
    chartConfiguration?: (chart: ChartXY) => void;
    /**
     * Callback function for series configuration.
     */
    seriesConfiguration?: (seriesList: LineSeries[]) => void;
}
/**
 * React component for interactive, high performance Time series Line chart.
 *
 * @example
 * ```ts
 * 	<LightningChartXY
 * 		id='chart'
 * 		data={[
 * 			[
 * 				{ x: Date.UTC(2023, 0, 1), y: 1 },
 * 				{ x: Date.UTC(2023, 0, 2), y: 2 },
 * 				{ x: Date.UTC(2023, 0, 3), y: 3 },
 * 				{ x: Date.UTC(2023, 0, 4), y: 4 },
 * 				{ x: Date.UTC(2023, 0, 5), y: 4.5 },
 * 			]
 * 		]}
 * 	/>
 * ```
 *
 * For documentation and more information, please see [react-time-series-chart GitHub repository](https://github.com/Arction/lcjs-react-template/tree/master/react-time-series-chart)
 */
declare function LightningChartXY(props: LightningChartXYProps): React.JSX.Element;

export { LightningChartXY, type LightningChartXYProps };