@redsift/dashboard 6.1.0-alpha.0 → 6.2.0

package/index.d.ts

@@ -10,7 +10,7 @@ declare type JSONValue = string | number | boolean | {
 declare type JSONObject = {
     [x: string]: JSONValue;
 };
-declare type JSONType = Array<JSONObject>;
+declare type JSONArray = Array<JSONObject>;
 declare type TNdx = Crossfilter<any>;
 declare type Group = Group$1<any, NaturallyOrderedValue, unknown>;
 declare type GroupSelector = (group: Group) => Group;
@@ -49,7 +49,7 @@ declare type DashboardContextProps = {
     ndx?: TNdx;
     state: DashboardReducerState;
     dispatch?: Dispatch<DashboardReducerAction>;
-    data?: JSONType;
+    data?: JSONArray;
 };
 /**
  * Reducer props.
@@ -70,7 +70,7 @@ declare type DashboardReducerAction = {
  */
 interface DashboardProps extends ComponentProps<'div'> {
     /** Dataset that will be share across every components within the dashboard. */
-    data: JSONType;
+    data: JSONArray;
 }
 
 declare const Dashboard: Comp<DashboardProps, HTMLDivElement>;
@@ -108,7 +108,7 @@ declare const HorizontalBarChartTheme: {
     readonly monochrome: "monochrome";
 };
 declare type HorizontalBarChartTheme = ValueOf<typeof HorizontalBarChartTheme>;
-interface LocaleText$1 {
+interface LocaleText$2 {
     resetLabel?: string;
 }
 /**
@@ -124,7 +124,7 @@ interface HorizontalBarChartProps extends ComponentProps<'div'> {
     /** Field value of the DataGrid column to filter. */
     columnToFilter?: string;
     /** Dataset to use to generate the chart, if no context is provided. */
-    data?: JSONType;
+    data?: JSONArray;
     /** Method that will be used by crossfilter to compute the dimensions of the charts. */
     dimension: DimensionSelector;
     /** Reset function that is triggered when reset button is pressed in the empty state chart. */
@@ -134,7 +134,9 @@ interface HorizontalBarChartProps extends ComponentProps<'div'> {
     /** Whether the reset button is hidden or not. */
     isResetable?: boolean;
     /** 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. */
     others?: boolean | string;
     /** HorizontalBarChart size. */
@@ -152,7 +154,7 @@ declare type StyledHorizontalBarChartProps = Omit<HorizontalBarChartProps, 'colu
 
 declare const HorizontalBarChart: Comp<HorizontalBarChartProps, HTMLDivElement>;
 
-interface LocaleText {
+interface LocaleText$1 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
     emptyChartResetLabel?: string;
@@ -169,7 +171,7 @@ interface PieChartProps extends ComponentProps<'div'> {
     /** Field value of the DataGrid column to filter. */
     columnToFilter?: string;
     /** Dataset to use to generate the chart, if no context is provided. */
-    data?: JSONType;
+    data?: JSONArray;
     /** Method that will be used by crossfilter to compute the dimensions of the charts. */
     dimension: DimensionSelector;
     /** Method that will be used by crossfilter to compute the groups of the charts. */
@@ -179,7 +181,9 @@ 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;
+    localeText?: LocaleText$1;
+    /** 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;
     /** PieChart size. */
@@ -206,4 +210,70 @@ declare type StyledPieChartProps = Omit<PieChartProps, 'columnToFilter' | 'dimen
 
 declare const PieChart: Comp<PieChartProps, HTMLDivElement>;
 
-export { ChartDimensions, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONObject, JSONType, JSONValue, PieChart, PieChartProps, StyledHorizontalBarChartProps, StyledPieChartProps, TNdx, initialState };
+/**
+ * Component size.
+ */
+declare const TimeSeriesBarChartSize: {
+    readonly large: "large";
+    readonly medium: "medium";
+    readonly small: "small";
+};
+declare type TimeSeriesBarChartSize = ValueOf<typeof TimeSeriesBarChartSize>;
+/**
+ * Component theme.
+ */
+declare const TimeSeriesBarChartTheme: {
+    readonly default: "default";
+    readonly dark: "dark";
+    readonly darker: "darker";
+    readonly monochrome: "monochrome";
+};
+declare type TimeSeriesBarChartTheme = ValueOf<typeof TimeSeriesBarChartTheme>;
+declare type datetimeEnum = 'hour' | 'day' | 'week' | 'month' | 'year';
+interface LocaleText {
+    resetLabel?: string;
+}
+/**
+ * Component props.
+ */
+interface TimeSeriesBarChartProps extends ComponentProps<'div'> {
+    /** Caption. */
+    caption?: string;
+    /** Whether the x axis labels are rotated or not. */
+    areXLabelsRotated?: boolean;
+    /** Field value of the DataGrid column to filter. */
+    columnToFilter?: string;
+    /** Dataset to use to generate the chart, if no context is provided. */
+    data?: JSONArray;
+    /** Name of the dataset field that contains the datetime value. */
+    dateTimeFieldName: string;
+    /** Format used for the date and time values in the dataset by d3.js. Should follow https://github.com/d3/d3-time-format#locale_format. */
+    dateTimeFormat?: string;
+    /** Datetime unit to used to group values and for x units. */
+    dateTimeGroup?: datetimeEnum;
+    /** Method that will be used by crossfilter to compute the dimensions of the charts. */
+    dimension: DimensionSelector;
+    /** Whether the reset button is hidden or not. */
+    isResetable?: boolean;
+    /** Overriden values for internal labels and texts. */
+    localeText?: LocaleText;
+    /** TimeSeriesChart size. */
+    size?: TimeSeriesBarChartSize;
+    /** 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?: TimeSeriesBarChartTheme | {
+        success: string;
+        warning: string;
+        danger: string;
+    };
+    /** Title. */
+    title?: string;
+    /** Dataset key to use to stack values. */
+    stackedCategory?: string;
+    /** Y Axis Label. */
+    yAxisLabel?: string;
+}
+declare type StyledTimeSeriesBarChartProps = Omit<TimeSeriesBarChartProps, 'dimension' | 'dateTimeFieldName'> & {};
+
+declare const TimeSeriesBarChart: Comp<TimeSeriesBarChartProps, HTMLDivElement>;
+
+export { ChartDimensions, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONArray, JSONObject, JSONValue, PieChart, PieChartProps, StyledHorizontalBarChartProps, StyledPieChartProps, StyledTimeSeriesBarChartProps, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum, initialState };