reaviz
Version:
Data Visualization using React
43 lines (42 loc) • 1.21 kB
TypeScript
import { FC, ReactElement } from 'react';
import { ChartDataShape } from '../common/data';
import { RadialBarSeries, RadialBarSeriesProps } from './RadialBarSeries';
import { ChartProps } from '../common/containers';
import { RadialAxis, RadialAxisProps } from '../common/Axis/RadialAxis';
export interface RadialBarChartProps extends ChartProps {
/**
* Data the chart will receive to render.
*/
data: ChartDataShape[];
/**
* The series component that renders the bar components.
*
* @default `<RadialBarSeries />`
*/
series: ReactElement<RadialBarSeriesProps, typeof RadialBarSeries>;
/**
* The radial axis component for the chart.
*
* @default `<RadialAxis />`
*/
axis: ReactElement<RadialAxisProps, typeof RadialAxis> | null;
/**
* The inner radius for the chart center.
*
* @default 10
*/
innerRadius: number;
/**
* Start angle for the first value.
*
* @default 0
*/
startAngle?: number;
/**
* End angle for the last value.
*
* @default 2 * Math.PI
*/
endAngle?: number;
}
export declare const RadialBarChart: FC<Partial<RadialBarChartProps>>;