@redsift/charts 10.1.0-alpha.2 → 10.1.0-alpha.4

package/index.d.ts

@@ -136,6 +136,7 @@ type Datum<T> = {
     key: T;
     value: number;
     percent?: number;
+    cumulativeValue?: number;
 };
 type EmptyDatum<T> = {
     key: T;
@@ -561,6 +562,73 @@ declare const StyledChartContainerCaption: styled_components.StyledComponent<"p"
     $theme: Theme;
 }, never>;
 
+/**
+ * Component props.
+ */
+interface LegendItemProps extends Pick<DataPointProps<LegendItemDatum>, 'color' | 'data' | 'id' | 'index' | 'isSelected' | 'labelDecorator' | 'onClick' | 'previousData' | 'role' | 'tooltipVariant'>, Omit<ComponentProps<'li'>, 'onClick' | 'role'> {
+    /** Method modifying what's displayed within the legend when the variant is "custom". */
+    legendDecorator?: (datum: LegendItemDatum, props?: {
+        index?: number;
+        isSelected?: boolean;
+        color?: string;
+    }) => string | ReactElement;
+    /** Variant. */
+    variant?: LegendVariant;
+}
+
+/**
+ * Component props.
+ */
+interface LegendProps extends Omit<ComponentProps<'ul'>, 'onClick'>, ContainerProps {
+    /** Data. */
+    data: (Statistic & {
+        color: string;
+    })[];
+    /** Method to determine whether a slice is selected or not. */
+    isLegendItemSelected?: (datum: LegendItemDatum) => void;
+    /** Method to override the data labels. */
+    labelDecorator?: (datum: LegendItemDatum, props?: {
+        index?: number;
+        isSelected?: boolean;
+        color?: string;
+    }) => string | ReactElement;
+    /** Method modifying what's displayed within the legend when the variant is "custom". */
+    legendDecorator?: (datum: LegendItemDatum, props?: {
+        index?: number;
+        isSelected?: boolean;
+        color?: string;
+    }) => string | ReactElement;
+    /** Method to be called on a click on a legend item. */
+    onLegendItemClick?: (datum: LegendItemDatum) => void;
+    /** LegendItem role. Used to indicate that legend items are to be considered buttons or links. If an onClick is provided, the legend items will have the role `button` unless specifically set to `link` with this prop. */
+    legendItemRole?: LegendItemProps['role'];
+    /** Variant. */
+    variant?: LegendVariant;
+}
+type StyledLegendProps = Omit<LegendProps, 'data'> & {
+    $width?: LegendProps['width'];
+};
+
+declare const Legend: Comp<LegendProps, HTMLUListElement>;
+
+/**
+ * Component style.
+ */
+declare const StyledLegend: styled_components.StyledComponent<"ul", any, Omit<LegendProps, "data"> & {
+    $width?: string | number | undefined;
+}, never>;
+
+/**
+ * Component's labels variant.
+ */
+declare const BarChartLegendVariant: {
+    readonly none: "none";
+    readonly externalLabel: "externalLabel";
+    readonly externalLabelValue: "externalLabelValue";
+    readonly externalLabelPercent: "externalLabelPercent";
+    readonly custom: "custom";
+};
+type BarChartLegendVariant = ValueOf<typeof BarChartLegendVariant>;
 interface LocaleText$3 {
     emptyChartText: string;
 }
@@ -589,6 +657,16 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
         isSelected?: boolean;
         color?: string;
     }) => string | ReactElement;
+    /** Method modifying what's displayed within the legend when the legendVariant is "custom". */
+    legendDecorator?: (datum: BarDatum, props?: {
+        index?: number;
+        isSelected?: boolean;
+        color?: string;
+    }) => string | ReactElement;
+    /** 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'>;
     /** Labels and texts. */
     localeText?: LocaleText$3;
     /** Custom margins, used to give more space for axes labels and legend for instance. */
@@ -668,62 +746,6 @@ declare const StyledDot: styled_components.StyledComponent<_redsift_design_syste
     $theme: _redsift_design_system.Theme;
 }, never>;
 
-/**
- * Component props.
- */
-interface LegendItemProps extends Pick<DataPointProps<LegendItemDatum>, 'color' | 'data' | 'id' | 'index' | 'isSelected' | 'labelDecorator' | 'onClick' | 'previousData' | 'role' | 'tooltipVariant'>, Omit<ComponentProps<'li'>, 'onClick' | 'role'> {
-    /** Method modifying what's displayed within the legend when the variant is "custom". */
-    legendDecorator?: (datum: LegendItemDatum, props?: {
-        index?: number;
-        isSelected?: boolean;
-        color?: string;
-    }) => string | ReactElement;
-    /** Variant. */
-    variant?: LegendVariant;
-}
-
-/**
- * Component props.
- */
-interface LegendProps extends Omit<ComponentProps<'ul'>, 'onClick'>, ContainerProps {
-    /** Data. */
-    data: (Statistic & {
-        color: string;
-    })[];
-    /** Method to determine whether a slice is selected or not. */
-    isLegendItemSelected?: (datum: LegendItemDatum) => void;
-    /** Method to override the data labels. */
-    labelDecorator?: (datum: LegendItemDatum, props?: {
-        index?: number;
-        isSelected?: boolean;
-        color?: string;
-    }) => string | ReactElement;
-    /** Method modifying what's displayed within the legend when the variant is "custom". */
-    legendDecorator?: (datum: LegendItemDatum, props?: {
-        index?: number;
-        isSelected?: boolean;
-        color?: string;
-    }) => string | ReactElement;
-    /** Method to be called on a click on a legend item. */
-    onLegendItemClick?: (datum: LegendItemDatum) => void;
-    /** LegendItem role. Used to indicate that legend items are to be considered buttons or links. If an onClick is provided, the legend items will have the role `button` unless specifically set to `link` with this prop. */
-    legendItemRole?: LegendItemProps['role'];
-    /** Variant. */
-    variant?: LegendVariant;
-}
-type StyledLegendProps = Omit<LegendProps, 'data'> & {
-    $width?: LegendProps['width'];
-};
-
-declare const Legend: Comp<LegendProps, HTMLUListElement>;
-
-/**
- * Component style.
- */
-declare const StyledLegend: styled_components.StyledComponent<"ul", any, Omit<LegendProps, "data"> & {
-    $width?: string | number | undefined;
-}, never>;
-
 /**
  * Component props.
  */
@@ -1046,4 +1068,4 @@ declare const StyledScatterPlotEmptyText: styled_components.StyledComponent<"div
     $theme: Theme;
 }, never>;
 
-export { AnyScale, Arc, ArcDatum, ArcProps, Arcs, ArcsProps, Axis, AxisPosition, AxisProps, AxisVariant, Bar, BarChart, BarChartDimensions, BarChartProps, BarDatum, BarOrientation, BarProps, CategoricalOrLinearDim, CategoryData, CategoryDatum, CategoryDim, ChartAxesProps, ChartContainer, ChartContainerProps, ChartDimensions, ChartSize, ChartTheme, ColorTheme, Coordinates, CoordinatesCategoryData, CoordinatesCategoryDatum, CoordinatesCategoryDim, CustomColorTheme, DataPoint, DataPointProps, Datum, Dot, DotDatum, DotProps, DotVariant, EmptyDatum, JSONArray, JSONObject, JSONValue, LabelVariant, Legend, LegendItemDatum, LegendProps, LegendVariant, Line, LineChart, LineChartDimensions, LineChartLegendVariant, LineChartProps, LinePointDatum, LineProps, LinearData, LinearDatum, LinearDim, MarginProps, NumericValue, PieChart, PieChartDimensions, PieChartLegendVariant, PieChartProps, PieChartVariant, Scale, ScaleBand, ScaleLinear, ScaleLog, ScalePoint, ScaleSymlog, ScaleTime, ScaleTypeToScale, ScaleValue, ScaleWithBandwidth, ScatterPlot, ScatterPlotDimensions, ScatterPlotLegendVariant, ScatterPlotProps, ScatterPlotVariant, SortingMethod, Statistic, Statistics, StringValue, StyledArc, StyledArcProps, StyledArcs, StyledArcsProps, StyledAxis, StyledAxisProps, StyledBar, StyledBarChart, StyledBarChartEmptyText, StyledBarChartProps, StyledBarProps, StyledChartContainer, StyledChartContainerCaption, StyledChartContainerProps, StyledChartContainerTitle, StyledDataPoint, StyledDataPointProps, StyledDot, StyledDotProps, StyledLegend, StyledLegendProps, StyledLine, StyledLineChart, StyledLineChartEmptyText, StyledLineChartProps, StyledLineProps, StyledPieChart, StyledPieChartCenterText, StyledPieChartEmptyText, StyledPieChartProps, StyledScatterPlot, StyledScatterPlotEmptyText, StyledScatterPlotProps, SuccessDangerColorTheme, TicksSpec, TooltipVariant, TwoCategoryData, TwoCategoryDatum, TwoCategoryDim, UseBrushProps, UseColorProps, UseFormatCategoricalDataProps, UseZoomProps, empty, getColorScale, getSortingMethod, isValidDate, monochrome, scheme, successDangerScheme, useBrush, useColor, useFormatCategoricalData, useZoom };
+export { AnyScale, Arc, ArcDatum, ArcProps, Arcs, ArcsProps, Axis, AxisPosition, AxisProps, AxisVariant, Bar, BarChart, BarChartDimensions, BarChartLegendVariant, BarChartProps, BarDatum, BarOrientation, BarProps, CategoricalOrLinearDim, CategoryData, CategoryDatum, CategoryDim, ChartAxesProps, ChartContainer, ChartContainerProps, ChartDimensions, ChartSize, ChartTheme, ColorTheme, Coordinates, CoordinatesCategoryData, CoordinatesCategoryDatum, CoordinatesCategoryDim, CustomColorTheme, DataPoint, DataPointProps, Datum, Dot, DotDatum, DotProps, DotVariant, EmptyDatum, JSONArray, JSONObject, JSONValue, LabelVariant, Legend, LegendItemDatum, LegendProps, LegendVariant, Line, LineChart, LineChartDimensions, LineChartLegendVariant, LineChartProps, LinePointDatum, LineProps, LinearData, LinearDatum, LinearDim, MarginProps, NumericValue, PieChart, PieChartDimensions, PieChartLegendVariant, PieChartProps, PieChartVariant, Scale, ScaleBand, ScaleLinear, ScaleLog, ScalePoint, ScaleSymlog, ScaleTime, ScaleTypeToScale, ScaleValue, ScaleWithBandwidth, ScatterPlot, ScatterPlotDimensions, ScatterPlotLegendVariant, ScatterPlotProps, ScatterPlotVariant, SortingMethod, Statistic, Statistics, StringValue, StyledArc, StyledArcProps, StyledArcs, StyledArcsProps, StyledAxis, StyledAxisProps, StyledBar, StyledBarChart, StyledBarChartEmptyText, StyledBarChartProps, StyledBarProps, StyledChartContainer, StyledChartContainerCaption, StyledChartContainerProps, StyledChartContainerTitle, StyledDataPoint, StyledDataPointProps, StyledDot, StyledDotProps, StyledLegend, StyledLegendProps, StyledLine, StyledLineChart, StyledLineChartEmptyText, StyledLineChartProps, StyledLineProps, StyledPieChart, StyledPieChartCenterText, StyledPieChartEmptyText, StyledPieChartProps, StyledScatterPlot, StyledScatterPlotEmptyText, StyledScatterPlotProps, SuccessDangerColorTheme, TicksSpec, TooltipVariant, TwoCategoryData, TwoCategoryDatum, TwoCategoryDim, UseBrushProps, UseColorProps, UseFormatCategoricalDataProps, UseZoomProps, empty, getColorScale, getSortingMethod, isValidDate, monochrome, scheme, successDangerScheme, useBrush, useColor, useFormatCategoricalData, useZoom };