@redsift/dashboard 7.7.0-alpha.0 → 7.7.0-alpha.2

package/CONTRIBUTING.md

@@ -52,7 +52,7 @@ The Design System is following a monorepo architecture, providing multiple packa
 
 - `@redsift/dashboard`
 
-  This package provides dashboard-related components. Charts are based on [dc.js](https://dc-js.github.io/dc.js/) and [crossfilter](https://crossfilter.github.io/crossfilter/) and datagrids are based on `@redsift/table`. It contains every filterable elements to use inside a dashboard. For static charts, see `@redsift/charts`.
+  This package provides dashboard-related components. Charts are based on [dc.js](https://dc-js.github.io/dc.js/), [d3fc](https://d3fc.io/) and [crossfilter](https://crossfilter.github.io/crossfilter/) and datagrids are based on `@redsift/table`. It contains every filterable elements to use inside a dashboard. For static charts, see `@redsift/charts`.
 
 - _Deprecated_ `@redsift/design-system-legacy`
 

package/index.d.ts

@@ -335,7 +335,7 @@ declare const HorizontalBarChartTheme: {
     readonly monochrome: "monochrome";
 };
 type HorizontalBarChartTheme = ValueOf<typeof HorizontalBarChartTheme>;
-interface LocaleText$3 {
+interface LocaleText$4 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
     emptyChartResetLabel?: string;
@@ -369,7 +369,7 @@ interface HorizontalBarChartProps extends ComponentProps<'div'> {
     /** Whether the reset button is hidden or not. */
     isResetable?: boolean;
     /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText$3;
+    localeText?: LocaleText$4;
     /** Method to call when a filter occured on the chart. */
     onFilter?: (filters?: string[]) => void;
     /** Whether a category should be displayed for categories that has been removed by the caping option. Optionaly, this prop can be used to change the label of this category. */
@@ -387,7 +387,7 @@ type StyledHorizontalBarChartProps = Omit<HorizontalBarChartProps, 'columnToFilt
 
 declare const HorizontalBarChart: Comp<HorizontalBarChartProps, HTMLDivElement>;
 
-interface LocaleText$2 {
+interface LocaleText$3 {
     maxSizeDisclaimer?: string;
 }
 interface PdfExportButtonProps extends ButtonProps {
@@ -398,7 +398,7 @@ interface PdfExportButtonProps extends ButtonProps {
     /** Text to display at the beginning of the PDF. */
     introduction?: string;
     /** Labels and texts. */
-    localeText?: LocaleText$2;
+    localeText?: LocaleText$3;
     /** Image to put at the top of the PDF (SVG format not supported). */
     logo?: string;
     /** Function to be executed when button is clicked. */
@@ -409,7 +409,7 @@ interface PdfExportButtonProps extends ButtonProps {
 
 declare const PdfExportButton: Comp<PdfExportButtonProps, HTMLButtonElement>;
 
-interface LocaleText$1 {
+interface LocaleText$2 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
     emptyChartResetLabel?: string;
@@ -441,7 +441,7 @@ interface PieChartProps extends ComponentProps<'div'> {
     /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. */
     labelVariant?: PieChartLabelVariant;
     /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText$1;
+    localeText?: LocaleText$2;
     /** Method to call when a filter occured on the chart. */
     onFilter?: (filters?: string[]) => void;
     /** Whether a category should be displayed for categories that has been removed by the caping option. Optionaly, this prop can be used to change the label of this category. */
@@ -493,7 +493,7 @@ declare const TimeSeriesBarChartTheme: {
 };
 type TimeSeriesBarChartTheme = ValueOf<typeof TimeSeriesBarChartTheme>;
 type datetimeEnum = 'hour' | 'day' | 'week' | 'month' | 'year';
-interface LocaleText {
+interface LocaleText$1 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
     emptyChartResetLabel?: string;
@@ -522,7 +522,7 @@ interface TimeSeriesBarChartProps extends ComponentProps<'div'> {
     /** Whether the reset button is hidden or not. */
     isResetable?: boolean;
     /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText;
+    localeText?: LocaleText$1;
     /** Method to call when a filter occured on the chart. */
     onFilter?: (filters?: string[], allFiltered?: JSONArray) => void;
     /** TimeSeriesChart size. */
@@ -542,4 +542,100 @@ type StyledTimeSeriesBarChartProps = Omit<TimeSeriesBarChartProps, 'dimension' |
 
 declare const TimeSeriesBarChart: Comp<TimeSeriesBarChartProps, HTMLDivElement>;
 
-export { COUNT, ChartDimensions, ChartEmptyState, ChartEmptyStateProps, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONArray, JSONObject, JSONValue, PdfExportButton, PieChart, PieChartProps, SUM, StyledHorizontalBarChartProps, StyledPieChartProps, StyledTimeSeriesBarChartProps, SuccessDangerColorTheme, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum, groupReduceSum, initialState };
+/**
+ * Component size.
+ */
+declare const ScatterPlotSize: {
+    readonly xlarge: "xlarge";
+    readonly large: "large";
+    readonly medium: "medium";
+    readonly small: "small";
+};
+type ScatterPlotSize = ValueOf<typeof ScatterPlotSize>;
+/**
+ * Component's labels variant.
+ */
+declare const ScatterPlotLabelVariant: {
+    readonly none: "none";
+    readonly label: "label";
+    readonly labelValue: "labelValue";
+    readonly labelPercent: "labelPercent";
+};
+type ScatterPlotLabelVariant = ValueOf<typeof ScatterPlotLabelVariant>;
+/**
+ * Component theme.
+ */
+declare const ScatterPlotTheme: {
+    readonly default: "default";
+    readonly dark: "dark";
+    readonly darker: "darker";
+    readonly monochrome: "monochrome";
+};
+type ScatterPlotTheme = ValueOf<typeof ScatterPlotTheme>;
+interface LocaleText {
+    emptyChartTitle?: string;
+    emptyChartSubtitle?: string;
+    emptyChartResetLabel?: string;
+    resetLabel?: string;
+}
+/**
+ * Component props.
+ */
+interface ScatterPlotProps extends ComponentProps<'div'> {
+    /** Defines the fields to display on hover. An array of key/value will indicate which field to display and how to name it. An object of selectable fields and default selected fields can be used to make the annotations customizable by the user.  */
+    annotations?: {
+        key: string;
+        value: string;
+    }[] | {
+        /** List of fields selected by default. Should only contain values that are keys in selectableFields prop. */
+        defaultSelectedFields?: string[];
+        /** List of fields to display inside the tooltip. keys should match the ones in the dataset and values would be the one used to label the checkboxes. */
+        selectableFields: {
+            key: string;
+            value: string;
+        }[];
+    };
+    /** Caption. */
+    caption?: string;
+    /** Dataset to use to generate the chart, if no context is provided. */
+    data?: JSONArray;
+    /** Which datagrid column the chart is filtering for x and y but also for category if provided. */
+    datagridFilter?: {
+        x: string;
+        y: string;
+        category?: string;
+    };
+    /** Method that will be used by crossfilter to compute the dimensions of the charts. */
+    dimension: OrderedValueSelector<any, [number, number, string]> | OrderedValueSelector<any, [number, number]>;
+    /** Reset function that is triggered when reset button is pressed in the empty state chart. */
+    emptyChartResetFn?: () => void;
+    /** Whether the dimension field is an array or not. */
+    isDimensionArray?: boolean;
+    /** Whether the reset button is hidden or not. */
+    isResetable?: boolean;
+    /** Define whether the labels should be displayed inside or outside the charts and if they should contain raw or percentage values. */
+    labelVariant?: ScatterPlotLabelVariant;
+    /** Overriden values for internal labels and texts. */
+    localeText?: LocaleText;
+    /** Method to call when a filter occured on the chart. */
+    onFilter?: (filters?: string[]) => void;
+    /** Whether a category should be displayed for categories that has been removed by the caping option. Optionaly, this prop can be used to change the label of this category. */
+    others?: boolean | string;
+    /** Method to override the data labels. */
+    setLabels?: (key: string) => string | undefined;
+    /** ScatterPlot size. */
+    size?: ScatterPlotSize | {
+        width: number;
+        height: number;
+        dotSize: number;
+    };
+    /** Color palette to use. You can choose among the list of available color palette or also choose to use the success/warning/danger theme for which you have to specify which key corresponds to which status.  */
+    theme?: ScatterPlotTheme | SuccessDangerColorTheme;
+    /** Title. */
+    title?: string;
+}
+type StyledScatterPlotProps = Omit<ScatterPlotProps, 'columnToFilter' | 'data' | 'dimension' | 'group' | 'localeText'> & {};
+
+declare const ScatterPlot: Comp<ScatterPlotProps, HTMLDivElement>;
+
+export { COUNT, ChartDimensions, ChartEmptyState, ChartEmptyStateProps, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONArray, JSONObject, JSONValue, PdfExportButton, PieChart, PieChartProps, SUM, ScatterPlot, ScatterPlotLabelVariant, ScatterPlotProps, ScatterPlotSize, ScatterPlotTheme, StyledHorizontalBarChartProps, StyledPieChartProps, StyledScatterPlotProps, StyledTimeSeriesBarChartProps, SuccessDangerColorTheme, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum, groupReduceSum, initialState };