UNPKG

reaviz

Version:

Data Visualization using React

49 lines (48 loc) 1.73 kB
import { ReactElement, FC } from 'react'; import { LinearAxisProps, LinearAxis } from '../common/Axis'; import { BarSeries, BarSeriesProps } from './BarSeries'; import { ChartDataShape } from '../common/data'; import { GridlineSeries, GridlineSeriesProps } from '../common/Gridline'; import { ChartBrushProps, ChartBrush } from '../common/Brush'; import { ChartProps } from '../common/containers/ChartContainer'; export interface BarChartProps extends ChartProps { /** * Data the chart will receive to render. * * @default [] */ data: ChartDataShape[]; /** * The series component that renders the bar components. * * @default `<BarSeries />` */ series: ReactElement<BarSeriesProps, typeof BarSeries>; /** * The linear axis component for the Y Axis of the chart. * * @default `<LinearYAxis type="value" />` */ yAxis: ReactElement<LinearAxisProps, typeof LinearAxis>; /** * The linear axis component for the X Axis of the chart. * * @default `<LinearXAxis type="category" tickSeries={<LinearXAxisTickSeries tickSize={20} />} />` */ xAxis: ReactElement<LinearAxisProps, typeof LinearAxis>; /** * The chart's background gridlines component. * * @default `<GridlineSeries />` */ gridlines: ReactElement<GridlineSeriesProps, typeof GridlineSeries> | null; /** * The chart's brush component. */ brush: ReactElement<ChartBrushProps, typeof ChartBrush> | null; /** * Any secondary axis components. Useful for multi-axis charts. */ secondaryAxis?: ReactElement<LinearAxisProps, typeof LinearAxis>[]; } export declare const BarChart: FC<Partial<BarChartProps>>;