@redsift/charts 10.0.0 → 10.1.0-alpha.1

package/index.d.ts

@@ -59,6 +59,7 @@ interface AxisProps extends Omit<ComponentProps<'g'>, 'scale'> {
     tickRotation?: number;
     tickSize?: number;
     tickValues?: TicksSpec;
+    tickRemodelling?: (tickValues: any[]) => any[];
     /** Variant. */
     variant?: AxisVariant;
     /** X position. */
@@ -96,6 +97,12 @@ type ChartAxesProps = {
     xAxisTickSize?: AxisProps['tickSize'];
     /** X axis tick values. */
     xAxisTickValues?: AxisProps['tickValues'];
+    /** X axis min value. */
+    xAxisMinValue?: number | string;
+    /** X axis min value. */
+    xAxisMaxValue?: number | string;
+    /** Y axis tick remodelling. */
+    xAxisTickRemodelling?: (tickValues: any[]) => any[];
     /** Y axis variant. */
     yAxisVariant?: AxisVariant;
     /** Y axis placement. */
@@ -110,6 +117,12 @@ type ChartAxesProps = {
     yAxisTickSize?: AxisProps['tickSize'];
     /** Y axis tick values. */
     yAxisTickValues?: AxisProps['tickValues'];
+    /** Y axis min value. */
+    yAxisMinValue?: number | string;
+    /** Y axis min value. */
+    yAxisMaxValue?: number | string;
+    /** Y axis tick remodelling. */
+    yAxisTickRemodelling?: (tickValues: any[]) => any[];
 };
 
 type JSONValue = string | number | boolean | Date | {
@@ -130,19 +143,24 @@ type EmptyDatum<T> = {
     percent?: number;
 };
 type CategoryDim = string;
-type TwoCategoryDim = [number | string | Date, string | undefined | null];
-type CoordinatesCategoryDim = [number, number, string | undefined | null];
+type LinearDim = number | Date | string;
+type CategoricalOrLinearDim = CategoryDim | LinearDim;
+type TwoCategoryDim = [CategoricalOrLinearDim, CategoryDim | undefined | null];
+type CoordinatesCategoryDim = [number, number, CategoryDim | undefined | null];
 type CategoryDatum = Datum<CategoryDim>;
+type LinearDatum = Datum<LinearDim>;
 type TwoCategoryDatum = EmptyDatum<TwoCategoryDim>;
 type CoordinatesCategoryDatum = Datum<CoordinatesCategoryDim>;
 type CategoryData = CategoryDatum[];
+type LinearData = LinearDatum[];
 type TwoCategoryData = TwoCategoryDatum[];
 type CoordinatesCategoryData = CoordinatesCategoryDatum[];
 type ArcDatum = PieArcDatum<CategoryDatum>;
 type BarDatum = {
-    data: CategoryDatum;
+    data: CategoryDatum | LinearDatum | Datum<TwoCategoryDim>;
     height?: number;
     width?: number;
+    category?: string | null;
 };
 type DotDatum = {
     data: EmptyDatum<CoordinatesCategoryDim | TwoCategoryDim>;
@@ -297,6 +315,7 @@ declare const useColor: ({ data, colorTheme, category, theme }: UseColorProps) =
 
 type SortingMethod = 'none' | 'asc-key' | 'desc-key' | 'asc-value' | 'desc-value' | string[] | ((a: CategoryDatum, b: CategoryDatum) => 1 | -1);
 declare const getSortingMethod: (sortingMethod: SortingMethod) => (a: CategoryDatum, b: CategoryDatum) => 1 | -1;
+declare const isValidDate: (value: string) => boolean;
 
 interface UseFormatCategoricalDataProps {
     /** Dataset to use to generate the chart, should be a list of objects containing a key and a value. */
@@ -484,10 +503,12 @@ interface BarProps extends DataPointProps<BarDatum> {
     orientation?: BarOrientation;
     /** A linear continuous scale defined over a numeric domain used to determine the width or height of the bar (depending on the orientation). */
     scale: ScaleLinear$1<number, number, never>;
+    /** A scale defined over a numeric/time/ordinal domain used to determine the position of the bar. */
+    scalePosition: ScaleLinear$1<number, number, never> | ScaleTime$2<number, number, never> | ScalePoint$2<string>;
     /** Width of the bar in vertical orientation. */
     width?: number;
 }
-type StyledBarProps = StyledDataPointProps & Omit<BarProps, 'scale'> & {
+type StyledBarProps = StyledDataPointProps & Omit<BarProps, 'scale' | 'scalePosition'> & {
     $theme: Theme;
 };
 
@@ -498,7 +519,7 @@ declare const Bar: Comp<BarProps, SVGGElement>;
  */
 declare const StyledBar: styled_components.StyledComponent<_redsift_design_system.Comp<DataPointProps<any>, SVGGElement>, any, Omit<DataPointProps<any>, "data"> & {
     $clickable: boolean;
-} & Omit<BarProps, "scale"> & {
+} & Omit<BarProps, "scale" | "scalePosition"> & {
     $theme: Theme;
 }, never>;
 
@@ -557,7 +578,7 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
     /** Number of categories to use, the rest being put into a new category called "Others". */
     caping?: number;
     /** Dataset to use to generate the chart, should be a list of objects containing a key and a value. */
-    data?: CategoryData;
+    data?: CategoryData | LinearData | TwoCategoryData;
     /** Component to use if the chart is empty (replacing the default one). */
     emptyComponent?: ReactNode;
     /** Method to determine whether a slice is selected or not. */
@@ -623,7 +644,7 @@ type DotVariant = ValueOf<typeof DotVariant>;
  * Component props.
  */
 interface DotProps extends DataPointProps<DotDatum> {
-    /** A linear continuous scale defined over a numeric domain used to determine the x position based on the coordinates. */
+    /** A scale defined over a numeric/time/ordinal domain used to determine the x position based on the coordinates. */
     scaleX: ScaleLinear$1<number, number, never> | ScaleTime$2<number, number, never> | ScalePoint$2<string>;
     /** A linear continuous scale defined over a numeric domain used to determine the y position based on the coordinates. */
     scaleY: ScaleLinear$1<number, number, never>;
@@ -1025,4 +1046,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, 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, 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, monochrome, scheme, successDangerScheme, useBrush, useColor, useFormatCategoricalData, useZoom };
+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 };