@redsift/charts 8.0.0-alpha.0 → 8.0.0-alpha.2

package/index.d.ts

@@ -1,4 +1,4 @@
-import { ScaleLinear as ScaleLinear$1, BrushBehavior, ScaleOrdinal, Arc as Arc$1 } from 'd3';
+import { BrushBehavior, ScaleLinear as ScaleLinear$1, ScaleOrdinal, Arc as Arc$1 } from 'd3';
 import * as _redsift_design_system from '@redsift/design-system';
 import { ValueOf, Comp, StylingProps } from '@redsift/design-system';
 import { MutableRefObject, ComponentProps, ReactElement, ReactNode } from 'react';
@@ -9,6 +9,7 @@ import * as styled_components from 'styled-components';
 import * as _react_spring_web from '@react-spring/web';
 
 interface UseBrushProps {
+    brushRef: MutableRefObject<BrushBehavior<unknown> | undefined>;
     svgRef: MutableRefObject<SVGSVGElement | SVGGElement | undefined>;
     extent?: [[number, number], [number, number]];
     scaleX: ScaleLinear$1<number, number>;
@@ -18,9 +19,7 @@ interface UseBrushProps {
     onBrush?: (selection: [[number, number], [number, number]] | null, scaleX: ScaleLinear$1<number, number>, scaleY: ScaleLinear$1<number, number>) => void;
     onBrushEnd?: (selection: [[number, number], [number, number]] | null, scaleX: ScaleLinear$1<number, number>, scaleY: ScaleLinear$1<number, number>) => void;
 }
-declare const useBrush: ({ svgRef, extent, scaleX, scaleY, isBrushable, isGridded, onBrush, onBrushEnd, }: UseBrushProps) => {
-    brush: MutableRefObject<BrushBehavior<unknown> | undefined>;
-};
+declare const useBrush: ({ brushRef: propsBrushRef, svgRef, extent, scaleX, scaleY, isBrushable, isGridded, onBrush, onBrushEnd, }: UseBrushProps) => void;
 
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
@@ -248,6 +247,15 @@ type StyledDataPointProps = Omit<DataPointProps<any>, 'data'> & {
     $clickable: boolean;
 };
 
+declare const DataPoint: Comp<DataPointProps<any>, SVGGElement>;
+
+/**
+ * Component style.
+ */
+declare const StyledDataPoint: styled_components.StyledComponent<_react_spring_web.AnimatedComponent<"g">, any, Omit<DataPointProps<any>, "data"> & {
+    $clickable: boolean;
+}, never>;
+
 /**
  * Component props.
  */
@@ -293,6 +301,15 @@ declare const StyledArcs: styled_components.StyledComponent<"g", any, Omit<ArcsP
 /**
  * Component variant.
  */
+declare const AxisVariant: {
+    readonly none: "none";
+    readonly line: "line";
+    readonly lineTick: "lineTick";
+    readonly tick: "tick";
+    readonly tickValue: "tickValue";
+    readonly default: "default";
+};
+type AxisVariant = ValueOf<typeof AxisVariant>;
 declare const AxisPosition: {
     top: string;
     right: string;
@@ -319,6 +336,8 @@ interface AxisProps extends Omit<ComponentProps<'g'>, 'scale'> {
     tickRotation?: number;
     tickSize?: number;
     tickValues?: TicksSpec;
+    /** Variant. */
+    variant?: AxisVariant;
     /** X position. */
     x?: number;
     /** Y position. */
@@ -391,35 +410,6 @@ declare const StyledChartContainer: styled_components.StyledComponent<"div", any
 declare const StyledChartContainerTitle: styled_components.StyledComponent<_redsift_design_system.Comp<_redsift_design_system.FlexboxProps, HTMLDivElement>, any, ChartContainerProps, never>;
 declare const StyledChartContainerCaption: styled_components.StyledComponent<"p", any, ChartContainerProps, never>;
 
-/**
- * Component props.
- */
-interface LegendProps extends ComponentProps<'ul'> {
-    /** Data. */
-    data: (CategoryDatum & {
-        color: string;
-    })[];
-    /** Variant. */
-    variant?: LabelVariant;
-    /** Width. */
-    width?: string;
-}
-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 | undefined;
-}, never>;
-declare const StyledLabel: styled_components.StyledComponent<"li", any, {
-    $color: string;
-}, never>;
-
 interface LocaleText$2 {
     emptyChartText: string;
 }
@@ -470,6 +460,55 @@ declare const StyledBarChartEmptyText: styled_components.StyledComponent<"div",
     $textSize: number;
 }, never>;
 
+/**
+ * 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. */
+    scaleX: ScaleLinear$1<number, number, never>;
+    /** 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>;
+}
+type StyledDotProps = StyledDataPointProps & Omit<DotProps, 'scaleX' | 'scaleY'>;
+
+declare const Dot: Comp<DotProps, SVGGElement>;
+
+/**
+ * Component style.
+ */
+declare const StyledDot: styled_components.StyledComponent<_redsift_design_system.Comp<DataPointProps<any>, SVGGElement>, any, Omit<DataPointProps<any>, "data"> & {
+    $clickable: boolean;
+} & Omit<DotProps, "scaleX" | "scaleY">, never>;
+
+/**
+ * Component props.
+ */
+interface LegendProps extends ComponentProps<'ul'> {
+    /** Data. */
+    data: (CategoryDatum & {
+        color: string;
+    })[];
+    /** Variant. */
+    variant?: LabelVariant;
+    /** Width. */
+    width?: string;
+}
+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 | undefined;
+}, never>;
+declare const StyledLabel: styled_components.StyledComponent<"li", any, {
+    $color: string;
+}, never>;
+
 /**
  * Component variant.
  */
@@ -557,16 +596,6 @@ declare const StyledPieChartEmptyText: styled_components.StyledComponent<"div",
     $isDonut: boolean;
 }, never>;
 
-/**
- * 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. */
-    scaleX: ScaleLinear$1<number, number, never>;
-    /** 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>;
-}
-
 /**
  * Component variant.
  */
@@ -614,7 +643,7 @@ interface ScatterPlotProps extends ChartContainerProps {
     /** Method called on brush. */
     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;
+    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. */
     onDotClick?: (datum: DotDatum) => void;
     /** ScatterPlot size. */
@@ -627,6 +656,10 @@ interface ScatterPlotProps extends ChartContainerProps {
     tooltipVariant?: TooltipVariant;
     /** Variant. */
     variant?: ScatterPlotVariant;
+    /** X axis variant. */
+    xAxisVariant?: AxisVariant;
+    /** Y axis variant. */
+    yAxisVariant?: AxisVariant;
 }
 type StyledScatterPlotProps = ScatterPlotProps & {};
 
@@ -641,4 +674,4 @@ declare const StyledScatterPlotEmptyText: styled_components.StyledComponent<"div
     $textSize: number;
 }, never>;
 
-export { AnyScale, Arc, ArcDatum, ArcProps, Arcs, ArcsProps, Axis, AxisPosition, AxisProps, Bar, BarChart, BarChartDimensions, BarChartProps, BarDatum, BarOrientation, BarProps, CategoryData, CategoryDatum, CategoryDim, ChartContainer, ChartContainerProps, ChartDimensions, ChartSize, ChartTheme, ColorTheme, Coordinates, CoordinatesCategoryData, CoordinatesCategoryDatum, CoordinatesCategoryDim, CustomColorTheme, Datum, DotDatum, JSONArray, JSONObject, JSONValue, LabelVariant, Legend, LegendProps, NumericValue, PieChart, PieChartDimensions, PieChartLabelVariant, PieChartProps, PieChartVariant, Scale, ScaleBand, ScaleLinear, ScaleLog, ScalePoint, ScaleSymlog, ScaleTime, ScaleTypeToScale, ScaleValue, ScaleWithBandwidth, ScatterPlot, ScatterPlotDimensions, ScatterPlotLabelVariant, ScatterPlotProps, ScatterPlotVariant, StringValue, StyledArc, StyledArcProps, StyledArcs, StyledArcsProps, StyledAxis, StyledAxisProps, StyledBar, StyledBarChart, StyledBarChartEmptyText, StyledBarChartProps, StyledBarProps, StyledChartContainer, StyledChartContainerCaption, StyledChartContainerProps, StyledChartContainerTitle, StyledLabel, StyledLegend, StyledLegendProps, StyledPieChart, StyledPieChartCenterText, StyledPieChartEmptyText, StyledPieChartProps, StyledScatterPlot, StyledScatterPlotEmptyText, StyledScatterPlotProps, SuccessDangerColorTheme, TicksSpec, TooltipVariant, UseBrushProps, UseColorProps, UseFormatCategoricalDataProps, UseZoomProps, empty, getColorScale, 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, CategoryData, CategoryDatum, CategoryDim, ChartContainer, ChartContainerProps, ChartDimensions, ChartSize, ChartTheme, ColorTheme, Coordinates, CoordinatesCategoryData, CoordinatesCategoryDatum, CoordinatesCategoryDim, CustomColorTheme, DataPoint, DataPointProps, Datum, Dot, DotDatum, DotProps, JSONArray, JSONObject, JSONValue, LabelVariant, Legend, LegendProps, NumericValue, PieChart, PieChartDimensions, PieChartLabelVariant, PieChartProps, PieChartVariant, Scale, ScaleBand, ScaleLinear, ScaleLog, ScalePoint, ScaleSymlog, ScaleTime, ScaleTypeToScale, ScaleValue, ScaleWithBandwidth, ScatterPlot, ScatterPlotDimensions, ScatterPlotLabelVariant, ScatterPlotProps, ScatterPlotVariant, StringValue, StyledArc, StyledArcProps, StyledArcs, StyledArcsProps, StyledAxis, StyledAxisProps, StyledBar, StyledBarChart, StyledBarChartEmptyText, StyledBarChartProps, StyledBarProps, StyledChartContainer, StyledChartContainerCaption, StyledChartContainerProps, StyledChartContainerTitle, StyledDataPoint, StyledDataPointProps, StyledDot, StyledDotProps, StyledLabel, StyledLegend, StyledLegendProps, StyledPieChart, StyledPieChartCenterText, StyledPieChartEmptyText, StyledPieChartProps, StyledScatterPlot, StyledScatterPlotEmptyText, StyledScatterPlotProps, SuccessDangerColorTheme, TicksSpec, TooltipVariant, UseBrushProps, UseColorProps, UseFormatCategoricalDataProps, UseZoomProps, empty, getColorScale, monochrome, scheme, successDangerScheme, useBrush, useColor, useFormatCategoricalData, useZoom };