@ic3/reporting-api 8.0.0-rc.3 → 8.0.1

package/dist/PublicTheme.d.ts

@@ -19,12 +19,16 @@ import { WidgetBoxContentMessageClassKey } from "./theme/ThemeWidgetBoxContentMe
 import { ReactElement } from "react";
 import { TypographyStyleOptions } from "@mui/material/styles/createTypography";
 import { Property } from "csstype";
-import { FilterButtonsClassKey, FilterButtonsProps } from "./theme/ThemeFilterButtons";
-import { FilterSliderClassKey, FilterSliderProps } from "./theme/ThemeFilterSlider";
-import { GoogleMapMarkerProps } from "./theme/ThemeGoogleMapMarker";
+import { FilterButtonsChartOptions, FilterButtonsClassKey } from "./theme/ThemeFilterButtons";
+import { FilterSliderChartOptions, FilterSliderClassKey } from "./theme/ThemeFilterSlider";
+import { GoogleMarkerVariantChartOptions } from "./theme/ThemeGoogleMarker";
 import { IPublicContext } from "./PublicContext";
 import { TableClassKey, TableProps } from "./theme/ThemeTable";
 import { PivotTableClassKey, PivotTableProps } from "./theme/ThemePivotTable";
+import { Components } from "@mui/material/styles/components";
+import { FilterPanelClassesKey } from "./theme/ThemeFilterPanel";
+import { FilterCheckboxRadioChartOptions, FilterCheckboxRadioClassKey } from "./theme/ThemeFilterCheckboxRadio";
+import { ReportAppLeftPanelClassKey } from "./theme/ThemeReportAppLeftPanel";
 export interface INoSchemaRendererOptions {
     missingSchema: string;
 }
@@ -206,28 +210,15 @@ export interface ic3PaletteOptions {
     reportAppMenu?: Property.Color;
     onHover?: (color: Property.Color) => Property.Color;
 }
-declare module "@mui/material/styles/createPalette" {
-    interface Palette {
-        ic3: ic3Palette;
-    }
-    interface PaletteOptions {
-        ic3?: ic3PaletteOptions;
-    }
-}
 export interface ic3Typography {
     amCharts4: TypographyStyleOptions;
 }
 export interface ic3TypographyOptions {
+    /**
+     * Typography for the amCharts plugin.
+     */
     amCharts4?: TypographyStyleOptions;
 }
-declare module "@mui/material/styles/createTypography" {
-    interface Typography {
-        ic3: ic3Typography;
-    }
-    interface TypographyOptions {
-        ic3?: ic3TypographyOptions;
-    }
-}
 export declare enum TableRowHeightOptions {
     standard = "standard",
     compact = "compact"
@@ -384,6 +375,99 @@ export interface ic3ThemeOptions {
     };
     noSchemaRenderer?: (context: IPublicContext, options: INoSchemaRendererOptions) => ReactElement;
 }
+interface ic3BaseComponents {
+    AlertDialog?: {
+        styleOverrides?: ComponentsOverrides["AlertDialog"];
+    };
+    App?: {
+        styleOverrides?: ComponentsOverrides["App"];
+    };
+    DrilldownUserSelectMenu?: {
+        styleOverrides?: ComponentsOverrides["DrilldownUserSelectMenu"];
+    };
+    ErrorRenderer?: {
+        styleOverrides?: ComponentsOverrides["ErrorRenderer"];
+    };
+    FilterCheckbox?: {
+        styleOverrides?: ComponentsOverrides["FilterCheckbox"];
+        variants?: ComponentsVariants["FilterCheckbox"];
+    };
+    FilterButtons?: {
+        styleOverrides?: ComponentsOverrides["FilterButtons"];
+        variants?: ComponentsVariants["FilterButtons"];
+    };
+    FilterPanel?: {
+        variants?: ComponentsVariants['FilterPanel'];
+        styleOverrides?: ComponentsOverrides["FilterPanel"];
+    };
+    FilterSlider?: {
+        styleOverrides?: ComponentsOverrides["FilterSlider"];
+        variants?: ComponentsVariants["FilterSlider"];
+    };
+    GoogleMarker?: {
+        variants?: ComponentsVariants['GoogleMarker'];
+    };
+    HtmlBox?: {
+        styleOverrides?: ComponentsOverrides["HtmlBox"];
+        variants?: ComponentsVariants["HtmlBox"];
+    };
+    Layout?: {
+        styleOverrides?: ComponentsOverrides["Layout"];
+    };
+    LayoutPage?: {
+        styleOverrides?: ComponentsOverrides["LayoutPage"];
+    };
+    PivotTable?: {
+        variants?: ComponentsVariants['PivotTable'];
+        styleOverrides?: ComponentsOverrides["PivotTable"];
+    };
+    ReportAppBar?: {
+        styleOverrides?: ComponentsOverrides["ReportAppBar"];
+    };
+    ReportAppLeftPanel?: {
+        styleOverrides?: ComponentsOverrides["ReportAppLeftPanel"];
+    };
+    ReportAppMenu?: {
+        styleOverrides?: ComponentsOverrides["ReportAppMenu"];
+    };
+    Table?: {
+        variants?: ComponentsVariants['Table'];
+        styleOverrides?: ComponentsOverrides["Table"];
+    };
+    WidgetBox?: {
+        variants?: ComponentsVariants['WidgetBox'];
+        styleOverrides?: ComponentsOverrides["WidgetBox"];
+    };
+    WidgetBoxContentMessage?: {
+        styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
+    };
+}
+/**
+ * For Typing purpose extending MUI Theme with ic3 components
+ */
+export interface ic3Components extends ic3BaseComponents, Components {
+}
+/**
+ *
+ * MUI Module augmentation
+ *
+ */
+declare module "@mui/material/styles/createPalette" {
+    interface Palette {
+        ic3: ic3Palette;
+    }
+    interface PaletteOptions {
+        ic3?: ic3PaletteOptions;
+    }
+}
+declare module "@mui/material/styles/createTypography" {
+    interface Typography {
+        ic3: ic3Typography;
+    }
+    interface TypographyOptions {
+        ic3?: ic3TypographyOptions;
+    }
+}
 declare module '@mui/material/styles/createTheme' {
     interface Theme {
         ic3: ic3Theme;
@@ -399,59 +483,7 @@ declare module '@mui/material/styles/createTheme' {
  * All Components using Material-UI like variants (using styled)
  */
 declare module '@mui/material/styles/components' {
-    interface Components {
-        AlertDialog?: {
-            styleOverrides?: ComponentsOverrides["AlertDialog"];
-        };
-        App?: {
-            styleOverrides?: ComponentsOverrides["App"];
-        };
-        DrilldownUserSelectMenu?: {
-            styleOverrides?: ComponentsOverrides["DrilldownUserSelectMenu"];
-        };
-        ErrorRenderer?: {
-            styleOverrides?: ComponentsOverrides["ErrorRenderer"];
-        };
-        FilterButtons?: {
-            styleOverrides?: ComponentsOverrides["FilterButtons"];
-            variants?: ComponentsVariants["FilterButtons"];
-        };
-        FilterSlider?: {
-            styleOverrides?: ComponentsOverrides["FilterSlider"];
-            variants?: ComponentsVariants["FilterSlider"];
-        };
-        GoogleMapMarker?: {
-            variants?: ComponentsVariants['GoogleMapMarker'];
-        };
-        HtmlBox?: {
-            styleOverrides?: ComponentsOverrides["HtmlBox"];
-            variants?: ComponentsVariants["HtmlBox"];
-        };
-        Layout?: {
-            styleOverrides?: ComponentsOverrides["Layout"];
-        };
-        LayoutPage?: {
-            styleOverrides?: ComponentsOverrides["LayoutPage"];
-        };
-        PivotTable?: {
-            styleOverrides?: ComponentsOverrides["PivotTable"];
-        };
-        ReportAppBar?: {
-            styleOverrides?: ComponentsOverrides["ReportAppBar"];
-        };
-        ReportAppMenu?: {
-            styleOverrides?: ComponentsOverrides["ReportAppMenu"];
-        };
-        Table?: {
-            styleOverrides?: ComponentsOverrides["Table"];
-        };
-        WidgetBox?: {
-            variants?: ComponentsVariants['WidgetBox'];
-            styleOverrides?: ComponentsOverrides["WidgetBox"];
-        };
-        WidgetBoxContentMessage?: {
-            styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
-        };
+    interface Components extends ic3BaseComponents {
     }
 }
 declare module '@mui/material/styles/overrides' {
@@ -460,7 +492,9 @@ declare module '@mui/material/styles/overrides' {
         App: AppClassKey;
         DrilldownUserSelectMenu: DrilldownUserSelectMenuClassKey;
         ErrorRenderer: ErrorRendererClassKey;
+        FilterCheckbox: FilterCheckboxRadioClassKey;
         FilterButtons: FilterButtonsClassKey;
+        FilterPanel: FilterPanelClassesKey;
         FilterSlider: FilterSliderClassKey;
         HtmlBox: HtmlBoxClassKey;
         Layout: LayoutClassKey;
@@ -471,13 +505,16 @@ declare module '@mui/material/styles/overrides' {
         Table: TableClassKey;
         WidgetBox: WidgetBoxClassKey;
         WidgetBoxContentMessage: WidgetBoxContentMessageClassKey;
+        ReportAppLeftPanel: ReportAppLeftPanelClassKey;
     }
 }
 declare module '@mui/material/styles/props' {
     interface ComponentsPropsList {
-        FilterButtons: FilterButtonsProps;
-        FilterSlider: FilterSliderProps;
-        GoogleMapMarker: GoogleMapMarkerProps;
+        FilterCheckbox: FilterCheckboxRadioChartOptions;
+        FilterButtons: FilterButtonsChartOptions;
+        FilterPanel: Record<never, any>;
+        FilterSlider: FilterSliderChartOptions;
+        GoogleMarker: GoogleMarkerVariantChartOptions;
         HtmlBox: HtmlBoxProps;
         PivotTable: PivotTableProps;
         Table: TableProps;

package/dist/PublicTheme.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AAgSA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;AACvB,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC"}
+{"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AAyQA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;AACvB,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC"}

package/dist/PublicTidyColumn.d.ts

@@ -6,13 +6,13 @@ import { Property } from "csstype";
 import { AppNotification } from "./INotification";
 export interface ITidyColumnTypedValue {
     value: any;
+    fValue?: string;
     type: TidyColumnsType;
 }
 export declare type ITidyColumnAddValue = ITidyColumnAddValueInsert | ITidyColumnAddValueCopyRow;
 export interface ITidyColumnAddValueInsert {
     options: "INSERT";
     value: ITidyColumnTypedValue;
-    fValue?: string;
 }
 export interface ITidyColumnAddValueCopyRow {
     options: "COPY_ROW";
@@ -138,6 +138,10 @@ export interface ITidyBaseColumnReadonly<T> {
      * Return the type of the column
      */
     getType(): AllowedColumnType<T>;
+    /**
+     * e.g., List<T>.
+     */
+    getTypeParam(): TidyColumnsType | undefined;
     /**
      * E.g., datetime column: YEAR, ...
      */
@@ -196,9 +200,12 @@ export interface ITidyBaseColumnReadonly<T> {
     /**
      * Apply a function to the groups of unique values in this column
      *
-     * @return a map with the string value and the row indices in the group.
+     * @param useMdxUniqueName If true, use MDX-unique names to construct groups. Default = use column values.
+     *
+     * @return a map with getRowIdentifier for the group -> row indices in the group.
+     *
      */
-    groupBy(): Map<string, number[]>;
+    groupBy(useMdxUniqueName?: boolean): Map<string, number[]>;
     /**
      * Same as reIndex but creating a new column leaving this column untouched.
      *
@@ -210,6 +217,7 @@ export interface ITidyBaseColumnReadonly<T> {
  * Base interface for nullable column.
  */
 export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
+    isSameDimensionality(other: ITidyBaseColumn<any>): boolean;
     getErrors(): (TidyCellError | undefined)[];
     /**
      * If an error occurred in the calculation of cells for a column, then the error can be
@@ -378,6 +386,11 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * @param caption set this as the caption of the column.
      */
     setCaption(caption: string): void;
+    /**
+     * Returns true if and only if the column has a caption different from the default. The default caption is the
+     * columns name.
+     */
+    hasCaption(): boolean;
     /**
      * Convert the column to another type. This modifies the values to be of that type.
      *
@@ -407,11 +420,12 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      */
     apply<P>(fun: (value: T, index: number) => P, newType?: AllowedColumnType<P>): void;
     /**
-     * Inserts are sorted according to the insertion indices.
+     * Insert values at a row index.
+     * Structure: Map: row idx -> values to insert
      *
      * e.g., add totals.
      */
-    insertValues(inserts: Map<number, ITidyColumnAddValue>): void;
+    insertValues(inserts: Map<number, ITidyColumnAddValue[]>): void;
     /**
      * Repeat the values in the column.
      *
@@ -545,14 +559,20 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * Cell decoration
      */
     setCellDecoration(decoration: PublicTidyColumnCellDecoration): void;
+    /**
+     * Returns true if and only if the column represents the underlying MDX structure.
+     * Always false for non-mdx columns.
+     */
+    isMdxStructureIntact(): boolean;
+}
+export interface PublicTidyColumnCellDecorationRenderedOptions {
+    cellWidth?: number;
+    cellHeight: number;
 }
 export declare type PublicTidyColumnCellDecoration = Partial<{
     handlesCellsOnError: boolean;
     appliesToCell: (rowIdx: number) => boolean;
-    rendered: (rowIdx: number, sizing?: {
-        width: number;
-        height: number;
-    }) => React.ReactElement;
+    rendered: (rowIdx: number, options?: PublicTidyColumnCellDecorationRenderedOptions) => React.ReactElement;
     cssStyles: (rowIdx: number) => Record<string, any> | undefined;
 }>;
 export declare type ITidyColumn = ITidyBaseColumn<any>;

package/dist/PublicTidyColumn.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTidyColumn.js","sourceRoot":"","sources":["../src/PublicTidyColumn.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,0BA4EX;AA5ED,WAAY,0BAA0B;IAElC;;OAEG;IACH,sEAAwC,CAAA;IAExC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;;OAGG;IACH,yEAA2C,CAAA;IAE3C;;OAEG;IACH,oDAAsB,CAAA;IAEtB;;;;OAIG;IACH,yEAA2C,CAAA;IAE3C;;;;OAIG;IACH,+EAAiD,CAAA;IAEjD;;OAEG;IACH,qDAAuB,CAAA;IAEvB;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,6DAA+B,CAAA;IAE/B;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,iDAAmB,CAAA;IAEnB;;OAEG;IACH,gDAAkB,CAAA;IAElB;;OAEG;IACH,iDAAmB,CAAA;AACvB,CAAC,EA5EW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QA4ErC;AAEY,QAAA,6BAA6B,GAAG,IAAI,GAAG,CAAS;IAEzD,0BAA0B,CAAC,qBAAqB;IAChD,0BAA0B,CAAC,UAAU;IAErC,0BAA0B,CAAC,mBAAmB;IAE9C,0BAA0B,CAAC,mBAAmB;IAC9C,0BAA0B,CAAC,SAAS;IAEpC,0BAA0B,CAAC,OAAO;IAClC,0BAA0B,CAAC,OAAO;CAErC,CAAC,CAAC;AA4mBU,QAAA,4BAA4B,GAA8B;IAEnE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAC;CAE7C,CAAC;AAEW,QAAA,8BAA8B,GAA8B;IAErE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,8CAA8C;CAEjD,CAAC"}
+{"version":3,"file":"PublicTidyColumn.js","sourceRoot":"","sources":["../src/PublicTidyColumn.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,0BA4EX;AA5ED,WAAY,0BAA0B;IAElC;;OAEG;IACH,sEAAwC,CAAA;IAExC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;;OAGG;IACH,yEAA2C,CAAA;IAE3C;;OAEG;IACH,oDAAsB,CAAA;IAEtB;;;;OAIG;IACH,yEAA2C,CAAA;IAE3C;;;;OAIG;IACH,+EAAiD,CAAA;IAEjD;;OAEG;IACH,qDAAuB,CAAA;IAEvB;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,6DAA+B,CAAA;IAE/B;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,iDAAmB,CAAA;IAEnB;;OAEG;IACH,gDAAkB,CAAA;IAElB;;OAEG;IACH,iDAAmB,CAAA;AACvB,CAAC,EA5EW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QA4ErC;AAEY,QAAA,6BAA6B,GAAG,IAAI,GAAG,CAAS;IAEzD,0BAA0B,CAAC,qBAAqB;IAChD,0BAA0B,CAAC,UAAU;IAErC,0BAA0B,CAAC,mBAAmB;IAE9C,0BAA0B,CAAC,mBAAmB;IAC9C,0BAA0B,CAAC,SAAS;IAEpC,0BAA0B,CAAC,OAAO;IAClC,0BAA0B,CAAC,OAAO;CAErC,CAAC,CAAC;AAwoBU,QAAA,4BAA4B,GAA8B;IAEnE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAC;CAE7C,CAAC;AAEW,QAAA,8BAA8B,GAA8B;IAErE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,8CAA8C;CAEjD,CAAC"}

package/dist/PublicTidyHistogram.d.ts

@@ -12,13 +12,51 @@ export declare enum TidyHistogramBucketType {
     RIGHT_CLOSED = "rightClosed"
 }
 export interface TidyHistogramOptions extends FormFieldObject {
+    /**
+     * Bucket Mode.
+     *
+     * Automatically create buckets or define them yourself.
+     */
     binType: "automatic" | "userDefined";
+    /**
+     * Bucket Count.
+     *
+     * The number of buckets to auto generate.
+     */
     numberOfBins: number;
+    /**
+     * Custom Buckets.
+     *
+     * A list of objects `{from,to,name}`. Each object describes the range `from < x <= to`. No `from` or `to`
+     * means that the range is unbounded on that side.
+     */
     customBins: string;
+    /**
+     * Sort Buckets.
+     *
+     * Sort the buckets in this order. The sort uses the `from` of each bucket.
+     */
     sortBins: SortingType;
+    /**
+     * Bucket Name Format.
+     *
+     * How to format the names for the bucket. If there is a name in the user defined specification,
+     * then the bucket takes that name.
+     */
     bucketFormat: TidyHistogramBucketFormat;
+    /**
+     * Bucket Type.
+     *
+     * Which side of the bucket is closed?
+     */
     intervalType: TidyHistogramBucketType;
+    /**
+     * Include row ids of the rows that are in the bucket. Added in the table as a column with array values. E.g.,
+     * value [0,4,5] means rows 0, 4 and 5 are in the bucket.
+     */
+    includeRowIds?: boolean;
 }
 export declare const TidyHistogramMetaOptions: (group?: string | undefined, hideSort?: boolean) => FormFields<TidyHistogramOptions>;
 export declare const TidyHistogramBucketColName = "bucket";
 export declare const TidyHistogramCountColName = "count";
+export declare const TidyHistogramRowIdsName = "rowIds";

package/dist/PublicTidyHistogram.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TidyHistogramCountColName = exports.TidyHistogramBucketColName = exports.TidyHistogramMetaOptions = exports.TidyHistogramBucketType = exports.TidyHistogramBucketFormat = void 0;
+exports.TidyHistogramRowIdsName = exports.TidyHistogramCountColName = exports.TidyHistogramBucketColName = exports.TidyHistogramMetaOptions = exports.TidyHistogramBucketType = exports.TidyHistogramBucketFormat = void 0;
 const PublicTidyTableTypes_1 = require("./PublicTidyTableTypes");
 var TidyHistogramBucketFormat;
 (function (TidyHistogramBucketFormat) {
@@ -68,10 +68,15 @@ const TidyHistogramMetaOptions = (group, hideSort = false) => {
                 optionValues: Object.values(TidyHistogramBucketType),
                 optionName: "TidyHistogramBucketType"
             }
+        },
+        "includeRowIds": {
+            fieldType: 'boolean',
+            visibility: false,
         }
     };
 };
 exports.TidyHistogramMetaOptions = TidyHistogramMetaOptions;
 exports.TidyHistogramBucketColName = "bucket";
 exports.TidyHistogramCountColName = "count";
+exports.TidyHistogramRowIdsName = "rowIds";
 //# sourceMappingURL=PublicTidyHistogram.js.map

package/dist/PublicTidyHistogram.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTidyHistogram.js","sourceRoot":"","sources":["../src/PublicTidyHistogram.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAGnD,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACjC,kDAAqB,CAAA;IACrB,2DAA8B,CAAA;IAC9B,4EAA+C,CAAA;IAC/C,mDAAsB,CAAA;IACtB,+CAAkB,CAAA;AACtB,CAAC,EANW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAMpC;AAED,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,qDAA0B,CAAA;IAC1B,uDAA4B,CAAA;AAChC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AAWM,MAAM,wBAAwB,GAAG,CAAC,KAAc,EAAE,QAAQ,GAAG,KAAK,EAAoC,EAAE;IAC3G,OAAO;QACH,SAAS,EAAE;YACP,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,CAAC,WAAW,EAAE,aAAa,CAAC;gBAC1C,UAAU,EAAE,kBAAkB;aACjC;YACD,YAAY,EAAE,WAAW;SAC5B;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,WAAW;SACxE;QACD,YAAY,EAAE;YACV,KAAK;YACL,SAAS,EAAE,MAAM;YACjB,YAAY,EAAE,gDAAgD;YAC9D,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,aAAa;SAC1E;QACD,UAAU,EAAE;YACR,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,kCAAW,CAAC;gBACxC,UAAU,EAAE,aAAa;aAC5B;YACD,YAAY,EAAE,kCAAW,CAAC,SAAS;YACnC,UAAU,EAAE,CAAC,QAAQ;SACxB;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,yBAAyB,CAAC,QAAQ;YAChD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC;gBACtD,UAAU,EAAE,2BAA2B;aAC1C;SACJ;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,uBAAuB,CAAC,YAAY;YAClD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC;gBACpD,UAAU,EAAE,yBAAyB;aACxC;SACJ;KACJ,CAAA;AACL,CAAC,CAAA;AAvDY,QAAA,wBAAwB,4BAuDpC;AAEY,QAAA,0BAA0B,GAAG,QAAQ,CAAC;AACtC,QAAA,yBAAyB,GAAG,OAAO,CAAC"}
+{"version":3,"file":"PublicTidyHistogram.js","sourceRoot":"","sources":["../src/PublicTidyHistogram.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAGnD,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACjC,kDAAqB,CAAA;IACrB,2DAA8B,CAAA;IAC9B,4EAA+C,CAAA;IAC/C,mDAAsB,CAAA;IACtB,+CAAkB,CAAA;AACtB,CAAC,EANW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAMpC;AAED,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,qDAA0B,CAAA;IAC1B,uDAA4B,CAAA;AAChC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AAuDM,MAAM,wBAAwB,GAAG,CAAC,KAAc,EAAE,QAAQ,GAAG,KAAK,EAAoC,EAAE;IAC3G,OAAO;QACH,SAAS,EAAE;YACP,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,CAAC,WAAW,EAAE,aAAa,CAAC;gBAC1C,UAAU,EAAE,kBAAkB;aACjC;YACD,YAAY,EAAE,WAAW;SAC5B;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,WAAW;SACxE;QACD,YAAY,EAAE;YACV,KAAK;YACL,SAAS,EAAE,MAAM;YACjB,YAAY,EAAE,gDAAgD;YAC9D,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,aAAa;SAC1E;QACD,UAAU,EAAE;YACR,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,kCAAW,CAAC;gBACxC,UAAU,EAAE,aAAa;aAC5B;YACD,YAAY,EAAE,kCAAW,CAAC,SAAS;YACnC,UAAU,EAAE,CAAC,QAAQ;SACxB;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,yBAAyB,CAAC,QAAQ;YAChD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC;gBACtD,UAAU,EAAE,2BAA2B;aAC1C;SACJ;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,uBAAuB,CAAC,YAAY;YAClD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC;gBACpD,UAAU,EAAE,yBAAyB;aACxC;SACJ;QACD,eAAe,EAAE;YACb,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,KAAK;SACpB;KACJ,CAAA;AACL,CAAC,CAAA;AA3DY,QAAA,wBAAwB,4BA2DpC;AAEY,QAAA,0BAA0B,GAAG,QAAQ,CAAC;AACtC,QAAA,yBAAyB,GAAG,OAAO,CAAC;AACpC,QAAA,uBAAuB,GAAG,QAAQ,CAAC"}

package/dist/PublicTidyTable.d.ts

@@ -1,7 +1,6 @@
-import { AxisCoordinate, IAmCharts4Data, IAmCharts4DataTreeMap, ITotalRowValues, SortingType, TidyColumnIndex, TidyColumnsType, TidyTableColumnSelector } from "./PublicTidyTableTypes";
+import { AxisCoordinate, ChartTemplateDataMapping, IAmCharts4Data, IAmCharts4DataTreeMap, ITotalRowValues, SortingType, TidyColumnIndex, TidyColumnsType, TidyTableColumnIdentifier, TidyTableColumnSelector } from "./PublicTidyTableTypes";
 import { AllowedColumnType, ITidyBaseColumn, ITidyBaseColumnReadonly, ITidyCharacterColumn, ITidyColumn, ITidyNumericColumn, ITidyUnknownColumn } from "./PublicTidyColumn";
 import { TidyTree } from "./PublicTidyTree";
-import { SelectionGranularityOptions } from "./PublicTemplate";
 import { TidyHistogramOptions } from "./PublicTidyHistogram";
 import { IPublicContext } from "./PublicContext";
 /**
@@ -35,6 +34,7 @@ export interface ITidyTable {
      * Get the query uid
      */
     getQueryUid(): number;
+    isSameDimensionality(other: ITidyTable): boolean;
     asPivotTableForExcel(nullValue: any): ITidyColumn[];
     /**
      * Return all columns in the table
@@ -87,24 +87,30 @@ export interface ITidyTable {
      * @param alias mapping name
      */
     getColumnByAlias(alias: string): ITidyColumn;
+    /**
+     * @see {getOptionalColumnByRole}
+     * @param role mapping name
+     * @returns list of columns with the role 'role'.
+     */
+    getColumnsByRole(role: string): ITidyColumn[];
     /**
      * @see {getColumnByAlias}
      */
     getOptionalColumnByAlias(alias: string): ITidyColumn | undefined;
     /**
-     * Get the coordinate of the column using the alias for the mapping
-     * @param alias the name of the mapping
+     * @see {getColumnByAlias}
      */
-    getOptionalColumnCoordinateByAlias(alias: string): TidyTableColumnSelector | undefined;
+    getOptionalColumnsByAlias(alias: string): ITidyColumn[] | undefined;
     /**
-     * @param granularityOption , if valid a SelectionGranularityOptions
+     * Get the coordinate of the column using the alias for the mapping
+     * @param alias the name of the mapping
      */
-    getOptionalColumnBySelectionGranularity(granularityOption: string | SelectionGranularityOptions): ITidyColumn[] | undefined;
+    getOptionalColumnCoordinateByAlias(alias: string): TidyTableColumnIdentifier | undefined;
     /**
-     * Get column(s) using a selector
-     * @param selector coordinate to the column or property.
+     * Get columns using a selector
+     * @param selector selector object
      */
-    getColumnBySelector(selector?: TidyTableColumnSelector): ITidyColumn[] | undefined;
+    getColumnsBySelector(selector: TidyTableColumnSelector | TidyTableColumnSelector[]): ITidyColumn[];
     /**
      * Get a column using the coordinate of an axis.
      * @param coordinate
@@ -219,18 +225,19 @@ export interface ITidyTable {
      */
     buildTidyTree(treeColumns: ITidyColumn[], rootLabel?: string, expandHierarchicalColumn?: boolean): TidyTree;
     /**
-     * Construct list of tidy tables
+     * Group the table by some of its columns
      * @param columns groupIdx and groupRows for each unique value in this(ese) column(s)
+     * @param useMdxUniqueName If true, use MDX-unique names to construct groups. Default = use column values.
      * @returns an map with indexes for each group.
      */
-    groupBy(columns: ITidyColumn[]): number[][];
+    groupBy(columns: ITidyColumn[], useMdxUniqueName?: boolean): number[][];
     /**
-     * Pivot a tidy table from wide to long format. See https://pandas.pydata.org/docs/reference/api/pandas.melt.html.
+     * Pivot a tidy table from wide to long format. See pivot longer in the documentation.
      * @param columns columns to melt.
-     * @param namesCaption name of the column to which the variable name are melted.
-     * @param valuesCaption name of the column to which the values are melted.
+     * @param variableName name of the column to which the variable name are melted.
+     * @param valuesName name of the column to which the values are melted.
      */
-    melt(columns: ITidyColumn[], namesCaption?: string, valuesCaption?: string): void;
+    melt(columns: ITidyColumn[], variableName?: string, valuesName?: string): void;
     /**
      * Pivot a tidy table from long to wide format
      * Duplicated rows are discarded.
@@ -288,7 +295,7 @@ export interface ITidyTable {
      * @param level this column expands the axis so that widgets can plot level-like charts using guides. This expansion
      * follows the patters axis-label[level-label].
      */
-    toAmcharts4Data<F extends string>(category: ITidyColumn, value: Record<F, ITidyColumn | undefined>, group?: ITidyColumn, level?: ITidyColumn): IAmCharts4Data[];
+    toAmcharts4Data<F extends string>(category: ITidyColumn, value: Record<F, ITidyColumn | undefined>, group?: ITidyColumn | ITidyColumn[], level?: ITidyColumn): IAmCharts4Data[];
     /**
      * Creates a data object for the Amcharts treemap
      * @param level0 names for the parent nodes
@@ -439,6 +446,7 @@ export interface ITidyTable {
     isTotalRow(rowIdx: number): boolean;
     /**
      * Transform the table to a table where each row is a bucket in the histogram for that group.
+     * Returns a new tidy table. Function does not mutate old tidy table and its columns.
      *
      * @see TidyHistogramBucketColName
      * @see TidyHistogramCountColName
@@ -448,7 +456,7 @@ export interface ITidyTable {
      * Create a histogram bucket column from the value column.
      */
     toHistogramBucketColumn(context: IPublicContext, valueCol: ITidyBaseColumnReadonly<number | null>, options: TidyHistogramOptions): ITidyColumn;
-    addTotalRows(totals: Map<number, ITotalRowValues>): void;
+    addTotalRows(totals: Map<number, ITotalRowValues[]>): void;
     /**
      * Get a column by its role as defined in the mdxBuilderSettings.
      * @param role name of the axis-role
@@ -461,4 +469,14 @@ export interface ITidyTable {
     getLevelDepthR(nodeInfo: MdxNodeIdentifier): any;
     hasMdxChildren(nodeInfo: MdxNodeIdentifier): boolean;
     isLeaf(nodeInfo: MdxNodeIdentifier): any;
+    /**
+     * Sort the tidy table pivot style
+     */
+    sortLikePivotTable(sortingColumn: ITidyColumn, type: SortingType, rowIds: number[]): void;
+    /**
+     * The tidy table internally keeps track how columns are mapped to roles. If you apply a transformation
+     * in the widget template, you can update the mapping after whith this function.
+     * @param mapping new mapping = {old mapping , ...mapping}
+     */
+    updateMapping(mapping: ChartTemplateDataMapping): void;
 }

package/dist/PublicTidyTableInteractions.d.ts

@@ -33,7 +33,7 @@ export interface ITidyTableInteractionSelection {
     /**
      * Sets the selection at the creation of the widget
      */
-    initializeSelection(): void;
+    initializeSelection(isRangeSelection?: boolean): void;
     /**
      * Returns true if the selection if empty. Returns false otherwise.
      */
@@ -44,6 +44,12 @@ export interface ITidyTableInteractionSelection {
      * @param rowIdx the index of the row
      */
     isSelected(rowIdx: number): boolean;
+    /**
+     * For the sankey diagram, a row is selected if connecting nodes are in the selection.
+     * @param rowIdx the index of the row
+     * @param column selection should be in this column
+     */
+    isSelectedSankey(rowIdx: number, column: ITidyColumn): boolean;
     /**
      *
      * @param column
@@ -158,6 +164,10 @@ export interface ITidyTableInteractionEvent {
      * register a callback that will be called each time an event is send to the channel bound to the actionName
      */
     onNotification(actionName: string, callback: (event: any) => void): void;
+    /**
+     * Should the interactions be based on rowIds or on row values? Default = true = rowIds.
+     */
+    useHitRowIdxInSelection(value: boolean): void;
 }
 export interface ITidyTableInteraction extends ITidyTableInteractionSelection, ITidyTableInteractionEvent, ITidyTableDrilldown {
     /**
@@ -168,6 +178,11 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
      * This does not fire any event...for now
      */
     handleRowHit(rowIdx: number, event: TidyEvent | undefined): void;
+    /**
+     * Handles a row hit for the sankey diagram. The sankey differs from normal selection because it makes a tuple,
+     * not a set.
+     */
+    handleRowHitSankey(rowIdx: number, column: ITidyColumn, event: TidyEvent | undefined): void;
     /**
      * Collapsed / Expand
      */
@@ -184,7 +199,7 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
      * Is the node loading
      */
     isLoading(column: ITidyColumn, rowIdx: number): boolean;
-    setSelectionColumns(columns: ITidyColumn[]): void;
+    setSelectionColumns(columns: ITidyColumn[] | ((oldColumns: ITidyColumn[]) => ITidyColumn[])): void;
     /**
      * Change the default drilldown column.
      * @param column column to use for the drill-downs. Use undefined to reset to default.
@@ -201,4 +216,6 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
     asLazyTreeViewLoader(column: ITidyColumn): ILazyTreeViewLoader;
     getCompactedSelectionNames(): string[] | undefined;
     isSelectable(col: ITidyColumn): boolean;
+    getSelectedRows(): number[];
+    setSortSelectionToColumnOrder(value: boolean): void;
 }