reaviz
Version:
Data Visualization using React
112 lines (111 loc) • 2.62 kB
TypeScript
import { FC, ReactElement } from 'react';
import { ArcData } from '..';
import { PieArc, PieArcProps } from './PieArc';
import { PieArcLabel, PieArcLabelProps } from './PieArcLabel';
import { ColorSchemeType } from '../../common/color';
export interface PieArcSeriesProps {
/**
* Unique id for the series.
*/
id?: string;
/**
* Animated set by the `PieArc` components.
*
* @default true
*/
animated: boolean;
/**
* Outer radius set by the parent component.
*/
outerRadius: number;
/**
* Inner radius set by the parent component.
*
* @default 0
*/
innerRadius: number;
/**
* Pad Angle between adjacent arcs, see https://github.com/d3/d3-shape#arc_padAngle
*
* @default 0
*/
padAngle: number;
/**
* Pad Radius between adjacent arcs, see https://github.com/d3/d3-shape#arc_padRadius
*
* @default 0
*/
padRadius: number;
/**
* Corner Radius of the arcs, see https://github.com/d3/d3-shape#arc_cornerRadius
*
* @default 0
*/
cornerRadius: number;
/**
* Data set by the parent component.
*/
data: ArcData[];
/**
* Width of the arc
*
* @default 0.25
*/
arcWidth: number;
/**
* Doughnut, render as a donut shape
*/
doughnut: boolean;
/**
* Explode: OuterRadius will be adjusted by the data property
*
* @default false
*/
explode: boolean;
/**
* Display all labels shows labels even if there is little space
*
* @default false
*/
displayAllLabels: boolean;
/**
* Label component
*
* @default `<PieArcLabel />`
*/
label?: ReactElement<PieArcLabelProps, typeof PieArcLabel> | null;
/**
* Arc Component
*
* @default `<PieArc />`
*/
arc: ReactElement<PieArcProps, typeof PieArc>;
/**
* Color scheme
*
* @default 'cybertron'
*/
colorScheme: ColorSchemeType;
/**
* Height set by the parent component
*/
height: number;
/**
* Width set by the parent component
*/
width: number;
}
export declare const PieArcSeries: FC<Partial<PieArcSeriesProps>>;
export declare const PIE_ARC_SERIES_DEFAULT_PROPS: {
animated: boolean;
colorScheme: string;
innerRadius: number;
cornerRadius: number;
padAngle: number;
padRadius: number;
explode: boolean;
displayAllLabels: boolean;
arcWidth: number;
label: import("react/jsx-runtime").JSX.Element;
arc: import("react/jsx-runtime").JSX.Element;
};