@redsift/charts 10.3.0-alpha.8 → 10.3.0-alpha.9

package/index.d.ts

@@ -550,7 +550,7 @@ interface ChartContainerProps extends Omit<ComponentProps<'div'>, 'title'>, Cont
     /** Description that won't be visually displayed but will be used for assistive technology. If you want to display the description, use `description` instead. */
     descriptionForAssistiveTechnology?: string;
     /** Whether the chart is static or interactive. */
-    mode?: 'static' | 'interactive';
+    mode?: string;
     /** Small text explaining which kind of chart is presenting and what's its basic composition. */
     definition?: string;
     /** Small text explaining the basic composition of the x-axis, if any. */
@@ -606,7 +606,7 @@ interface LegendProps extends Omit<ComponentProps<'ul'>, 'onClick'>, ContainerPr
     data: (Statistic & {
         color: string;
     })[];
-    /** Method to determine whether a slice is selected or not. */
+    /** Method to determine whether a legend is selected or not. */
     isLegendItemSelected?: (datum: LegendItemDatum) => void;
     /** Method to override the data labels. */
     labelDecorator?: (datum: LegendItemDatum, props?: {
@@ -695,7 +695,9 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
     /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. If set to "custom", use `legendDecorator` to customize it. */
     legendVariant?: BarChartLegendVariant;
     /** Props to forward to the Legend block. Can be used to make the legend selectable. */
-    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'>;
+    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'> & {
+        extraLegendItems?: Statistics;
+    };
     /** Labels and texts. */
     localeText?: LocaleText$3;
     /** Custom margins, used to give more space for axes labels and legend for instance. */
@@ -818,7 +820,7 @@ type LineChartDimensions = ChartDimensions & {
 interface LineChartProps extends ChartContainerProps, ChartAxesProps {
     /** Dataset to use to generate the chart. */
     data?: TwoCategoryData;
-    /** Dot role. If an onClick is provided, the dots will have the role `button`. For a navigation link, please use `getSliceAnchorProps` instead. */
+    /** Dot role. If an onClick is provided, the dots will have the role `button`. For a navigation link, please use `getDotAnchorProps` instead. */
     dotRole?: DotProps['role'];
     /** Component to use if the chart is empty (replacing the default one). */
     emptyComponent?: ReactNode;
@@ -841,12 +843,14 @@ interface LineChartProps extends ChartContainerProps, ChartAxesProps {
     /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. If set to "custom", use `legendDecorator` to customize it. */
     legendVariant?: LineChartLegendVariant;
     /** Props to forward to the Legend block. Can be used to make the legend selectable. */
-    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'>;
+    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'> & {
+        extraLegendItems?: Statistics;
+    };
     /** Labels and texts. */
     localeText?: LocaleText$2;
     /** Custom margins, used to give more space for axes labels and legend for instance. */
     margins?: MarginProps;
-    /** Method to be called on a click on a dot. For a navigation link, please use `getSliceAnchorProps` instead. */
+    /** Method to be called on a click on a dot. For a navigation link, please use `getDotAnchorProps` instead. */
     onDotClick?: (datum: DotDatum) => void;
     /** LineChart size. */
     size?: ChartSize | LineChartDimensions;
@@ -942,7 +946,9 @@ interface PieChartProps extends ChartContainerProps {
     /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. If set to "custom", use `legendDecorator` to customize it. */
     legendVariant?: PieChartLegendVariant;
     /** Props to forward to the Legend block. Can be used to make the legend selectable. */
-    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant'>;
+    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant'> & {
+        extraLegendItems?: Statistics;
+    };
     /** Labels and texts. */
     localeText?: LocaleText$1;
     /** Method to be called on a click on a slice. For a navigation link, please use `getSliceAnchorProps` instead. */
@@ -1030,7 +1036,9 @@ type ScatterPlotDimensions = ChartDimensions & {
 interface ScatterPlotProps extends ChartContainerProps, ChartAxesProps {
     /** Dataset to use to generate the chart. */
     data?: CoordinatesCategoryData;
-    /** Slice role. Used to indicate that dots are to be considered buttons or links. If an onClick is provided, the dots will have the role `button` unless specifically set to `link` with this prop. */
+    /** Method used to define the anchor props to use when the dot is a navigation link. */
+    getDotAnchorProps?: (datum: DotDatum) => AnchorProps;
+    /** Dot role. If an onClick is provided, the dots will have the role `button`. For a navigation link, please use `getDotAnchorProps` instead. */
     dotRole?: DotProps['role'];
     /** Component to use if the chart is empty (replacing the default one). */
     emptyComponent?: ReactNode;
@@ -1055,7 +1063,9 @@ interface ScatterPlotProps extends ChartContainerProps, ChartAxesProps {
     /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. If set to "custom", use `legendDecorator` to customize it. */
     legendVariant?: ScatterPlotLegendVariant;
     /** Props to forward to the Legend block. Can be used to make the legend selectable. */
-    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'>;
+    legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant' | 'width'> & {
+        extraLegendItems?: Statistics;
+    };
     /** Labels and texts. */
     localeText?: LocaleText;
     /** Custom margins, used to give more space for axes labels and legend for instance. */
@@ -1064,7 +1074,7 @@ interface ScatterPlotProps extends ChartContainerProps, ChartAxesProps {
     onBrush?: (selection: [[number, number], [number, number]] | null, scaleX: ScaleLinear$1<number, number>, scaleY: ScaleLinear$1<number, number>) => void;
     /** Method called on brush end. */
     onBrushEnd?: (selection: [[number, number], [number, number]] | null, scaleX?: ScaleLinear$1<number, number>, scaleY?: ScaleLinear$1<number, number>) => void;
-    /** Method to be called on a click on a dot. */
+    /** Method to be called on a click on a dot. For a navigation link, please use `getDotAnchorProps` instead. */
     onDotClick?: (datum: DotDatum) => void;
     /** ScatterPlot size. */
     size?: ChartSize | ScatterPlotDimensions;