UNPKG

reaviz

Version:

Data Visualization using React

86 lines (85 loc) 2.28 kB
import { FC, ReactElement } from 'react'; import { ChartShallowDataShape } from '../../common'; import { ColorSchemeType } from '../../common/color'; import { RadialGaugeArc, RadialGaugeArcProps } from './RadialGaugeArc'; import { RadialGaugeLabel, RadialGaugeLabelProps } from './RadialGaugeLabel'; import { RadialGaugeValueLabel, RadialGaugeValueLabelProps } from './RadialGaugeValueLabel'; export interface RadialGaugeSeriesProps { /** * Unique id for the series. */ id?: string; /** * Data to render set by `RadialGauge` component. */ data: ChartShallowDataShape[]; /** * D3 scale function set by `RadialGauge` component. */ scale: any; /** * Start angle set by `RadialGauge` component. */ startAngle: number; /** * Start angle set by `RadialGauge` component. */ endAngle: number; /** * The "thickness" of the arcs * * @default 5 */ arcWidth?: number; /** * Width set by `RadialGauge` component. */ width: number; /** * Height set by `RadialGauge` component. */ height: number; /** * Padding between each gauge. * * @default 20 */ padding: number; /** * Color scheme to apply. * * @default ['#00ECB1'] */ colorScheme: ColorSchemeType; /** * Arc component. * * @default `<RadialGaugeArc />` */ innerArc: ReactElement<RadialGaugeArcProps, typeof RadialGaugeArc>; /** * Outer arc component. This is the 'fill' element. * * @default `<RadialGaugeOuterArc />` */ outerArc: ReactElement<RadialGaugeArcProps, typeof RadialGaugeArc> | null; /** * Label component. * * @default `<RadialGaugeLabel />` */ label: ReactElement<RadialGaugeLabelProps, typeof RadialGaugeLabel> | null; /** * Value label component. * * @default `<RadialGaugeValueLabel />` */ valueLabel: ReactElement<RadialGaugeValueLabelProps, typeof RadialGaugeValueLabel> | null; /** * Min width for a gauge. Only applicable in multi-series gauges. * * @default 50 */ minGaugeWidth: number; } export declare const RadialGaugeSeries: FC<Partial<RadialGaugeSeriesProps>>;