PeriodSelector
PeriodSelector, PeriodSelectorProps: generated from the source of active-charts.
Exported by @workspace/. Generated from the package source; part of the index of every export.
Period Selector#
Props
datarequired
- Type
ChartDatum[]
Full dataset.
date Keyrequired
- Type
string
Key for the date field in the data.
- Type
Period- Default
'MAX'
Default period. Default: 'MAX'.
- Type
ChartTranslate Fn
The host translator for the period labels. When omitted, <Chart supplies it; with neither, the selector throws a configuration error (no English fallback, ADR-028).
Takes only the props listed.
Types#
The props of Period, each described in its prop list on this page.
interface PeriodSelectorProps {
data: ChartDatum[];
dateKey: string;
defaultPeriod?: Period;
t?: ChartTranslateFn;
children: (filteredData: ChartDatum[]) => ReactNode;
}