@ic3/reporting-api 8.0.0-rc.4 → 8.1.0

package/dist/PublicTheme.d.ts

@@ -6,26 +6,33 @@ import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
 import { IWidgetLayoutDefinition } from "./PublicLayout";
 import { IThemeWidgetDefaults } from "./IThemeManager";
 import { AlertDialogClassKey } from "./theme/ThemeAlertDialog";
-import { AppClassKey } from "./theme/ThemeApp";
+import { AppClassKey, AppDivProps } from "./theme/ThemeApp";
 import { DrilldownUserSelectMenuClassKey } from "./theme/ThemeDrilldownUserSelectMenu";
 import { ErrorRendererClassKey } from "./theme/ThemeErrorRenderer";
 import { HtmlBoxClassKey, HtmlBoxProps } from "./theme/ThemeHtmlBox";
 import { LayoutClassKey } from "./theme/ThemeLayout";
 import { LayoutPageClassKey } from "./theme/ThemeLayoutPage";
 import { ReportAppBarClassKey } from "./theme/ThemeReportAppBar";
-import { ReportAppMenuClassKey } from "./theme/ThemeReportAppMenu";
 import { WidgetBoxClassKey } from "./theme/ThemeWidgetBox";
 import { WidgetBoxContentMessageClassKey } from "./theme/ThemeWidgetBoxContentMessage";
 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";
+import { FilterTreeChartOptions, FilterTreeClassKey } from "./theme/ThemeFilterTree";
+import { DatePickerChartOptions, DatePickerClassKey } from "./theme/ThemeDatePicker";
+import { FilterAutocompleteChartOptions, FilterAutocompleteClassesKey } from "./theme/ThemeFilterAutocomplete";
+import { AppMenuIconProps, ThemeAppMenuIconClassKey } from "./theme/ThemeAppMenuIcon";
+import { QueryBuilderNodeProps, ThemeQueryBuilderNodeClassKey } from "./theme/ThemeQueryBuilderNode";
 export interface INoSchemaRendererOptions {
     missingSchema: string;
 }
@@ -96,6 +103,10 @@ export declare type ThemeFormattersOptions = {
     amCharts4?: Amcharts4ThemeDateFormatterOptions;
 };
 export interface ic3Palette {
+    /**
+     * The color for the page background (can be overridden at layout level).
+     */
+    pageBackgroundColor: Property.Color;
     /**
      * The color for a selected item
      */
@@ -191,6 +202,7 @@ interface MandatorySingleColors {
     grey900: Property.Color;
 }
 export interface ic3PaletteOptions {
+    pageBackgroundColor: Property.Color;
     selected?: Property.Color;
     selectedText?: Property.Color;
     selectedBackground?: Property.Color;
@@ -307,6 +319,27 @@ export interface ic3Theme {
         };
     };
     noSchemaRenderer?: (context: IPublicContext, options: INoSchemaRendererOptions) => ReactElement;
+    /**
+     * Theme settings for the editor (application & report).
+     */
+    editor: {
+        /**
+         * Editor logo. Defaults to icCubes logo.
+         */
+        logo: string;
+        /**
+         * Alt text for the logo image. Default = icCube.
+         */
+        logoAlt: string;
+        /**
+         * Top - Offset of dashboard page to the editor. Default 25.
+         */
+        viewPortOffsetTop: number;
+        /**
+         * Left - Offset of dashboard page to the editor. Default 25.
+         */
+        viewPortOffsetLeft: number;
+    };
 }
 export interface ic3ThemeOptions {
     id: string;
@@ -333,7 +366,7 @@ export interface ic3ThemeOptions {
         disableUserMenuEdition?: boolean;
         userMenuFilter?: (options: string[], templateDef?: IPublicWidgetTemplateDefinition<any>) => string[];
     };
-    widgetBox: {
+    widgetBox?: {
         contentOffset: {
             top: number;
             left: number;
@@ -346,7 +379,7 @@ export interface ic3ThemeOptions {
     /**
      * The first defined layout is used as the default one.
      */
-    layouts: IWidgetLayoutDefinition[];
+    layouts?: IWidgetLayoutDefinition[];
     /**
      * Styling for the sparklines in the sparkline transformation and the KPI card
      */
@@ -371,6 +404,27 @@ export interface ic3ThemeOptions {
         };
     };
     noSchemaRenderer?: (context: IPublicContext, options: INoSchemaRendererOptions) => ReactElement;
+    /**
+     * Theme settings for the editor (application & report).
+     */
+    editor?: {
+        /**
+         * Editor logo. Defaults to icCubes logo.
+         */
+        logo?: string;
+        /**
+         * Alt text for the logo image. Default = icCube.
+         */
+        logoAlt?: string;
+        /**
+         * Top - Offset of dashboard page to the editor. Default 25.
+         */
+        viewPortOffsetTop?: number;
+        /**
+         * Left - Offset of dashboard page to the editor. Default 25.
+         */
+        viewPortOffsetLeft?: number;
+    };
 }
 interface ic3BaseComponents {
     AlertDialog?: {
@@ -385,16 +439,36 @@ interface ic3BaseComponents {
     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"];
     };
-    GoogleMapMarker?: {
-        variants?: ComponentsVariants['GoogleMapMarker'];
+    FilterTree?: {
+        styleOverrides?: ComponentsOverrides["FilterTree"];
+        variants?: ComponentsVariants["FilterTree"];
+    };
+    FilterDatePicker?: {
+        styleOverrides?: ComponentsOverrides["FilterDatePicker"];
+        variants?: ComponentsVariants["FilterDatePicker"];
+    };
+    FilterAutocomplete?: {
+        styleOverrides?: ComponentsOverrides["FilterAutocomplete"];
+        variants?: ComponentsVariants["FilterAutocomplete"];
+    };
+    GoogleMarker?: {
+        variants?: ComponentsVariants['GoogleMarker'];
     };
     HtmlBox?: {
         styleOverrides?: ComponentsOverrides["HtmlBox"];
@@ -413,8 +487,8 @@ interface ic3BaseComponents {
     ReportAppBar?: {
         styleOverrides?: ComponentsOverrides["ReportAppBar"];
     };
-    ReportAppMenu?: {
-        styleOverrides?: ComponentsOverrides["ReportAppMenu"];
+    ReportAppLeftPanel?: {
+        styleOverrides?: ComponentsOverrides["ReportAppLeftPanel"];
     };
     Table?: {
         variants?: ComponentsVariants['Table'];
@@ -427,6 +501,12 @@ interface ic3BaseComponents {
     WidgetBoxContentMessage?: {
         styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
     };
+    AppMenuIcon?: {
+        styleOverrides?: ComponentsOverrides["AppMenuIcon"];
+    };
+    QueryBuilderNode?: {
+        styleOverrides?: ComponentsOverrides["QueryBuilderNode"];
+    };
 }
 /**
  * For Typing purpose extending MUI Theme with ic3 components
@@ -441,9 +521,55 @@ export interface ic3Components extends ic3BaseComponents, Components {
 declare module "@mui/material/styles/createPalette" {
     interface Palette {
         ic3: ic3Palette;
+        mdx: {
+            annotation: string;
+            comment: string;
+            definitionKeyword: string;
+            keyword: string;
+            labelName: string;
+            number: string;
+            operator: string;
+            propertyName: string;
+            separator: string;
+            string: string;
+            variableName: string;
+            dimension: string;
+            hierarchy: string;
+            level: string;
+            member: string;
+            measureGroup: string;
+            measureFolder: string;
+            measure: string;
+            set: string;
+            calcMeasure: string;
+            event: string;
+        };
     }
     interface PaletteOptions {
         ic3?: ic3PaletteOptions;
+        mdx?: {
+            annotation?: string;
+            comment?: string;
+            definitionKeyword?: string;
+            keyword?: string;
+            labelName?: string;
+            number?: string;
+            operator?: string;
+            propertyName?: string;
+            separator?: string;
+            string?: string;
+            variableName?: string;
+            dimension?: string;
+            hierarchy?: string;
+            level?: string;
+            member?: string;
+            measureGroup?: string;
+            measureFolder?: string;
+            measure?: string;
+            set?: string;
+            calcMeasure?: string;
+            event?: string;
+        };
     }
 }
 declare module "@mui/material/styles/createTypography" {
@@ -478,28 +604,43 @@ declare module '@mui/material/styles/overrides' {
         App: AppClassKey;
         DrilldownUserSelectMenu: DrilldownUserSelectMenuClassKey;
         ErrorRenderer: ErrorRendererClassKey;
+        FilterCheckbox: FilterCheckboxRadioClassKey;
         FilterButtons: FilterButtonsClassKey;
+        FilterPanel: FilterPanelClassesKey;
         FilterSlider: FilterSliderClassKey;
+        FilterTree: FilterTreeClassKey;
+        FilterDatePicker: DatePickerClassKey;
+        FilterAutocomplete: FilterAutocompleteClassesKey;
         HtmlBox: HtmlBoxClassKey;
         Layout: LayoutClassKey;
         LayoutPage: LayoutPageClassKey;
         PivotTable: PivotTableClassKey;
-        ReportAppBar: ReportAppBarClassKey;
-        ReportAppMenu: ReportAppMenuClassKey;
         Table: TableClassKey;
+        ReportAppBar: ReportAppBarClassKey;
         WidgetBox: WidgetBoxClassKey;
         WidgetBoxContentMessage: WidgetBoxContentMessageClassKey;
+        ReportAppLeftPanel: ReportAppLeftPanelClassKey;
+        AppMenuIcon: ThemeAppMenuIconClassKey;
+        QueryBuilderNode: ThemeQueryBuilderNodeClassKey;
     }
 }
 declare module '@mui/material/styles/props' {
     interface ComponentsPropsList {
-        FilterButtons: FilterButtonsProps;
-        FilterSlider: FilterSliderProps;
-        GoogleMapMarker: GoogleMapMarkerProps;
+        FilterCheckbox: FilterCheckboxRadioChartOptions;
+        FilterButtons: FilterButtonsChartOptions;
+        FilterPanel: Record<never, any>;
+        FilterSlider: FilterSliderChartOptions;
+        FilterTree: FilterTreeChartOptions;
+        FilterDatePicker: DatePickerChartOptions;
+        FilterAutocomplete: FilterAutocompleteChartOptions;
         HtmlBox: HtmlBoxProps;
         PivotTable: PivotTableProps;
         Table: TableProps;
         WidgetBox: Record<never, any>;
+        GoogleMarker: GoogleMarkerVariantChartOptions;
+        AppMenuIconStyled: AppMenuIconProps;
+        App: AppDivProps;
+        QueryBuilderNode: QueryBuilderNodeProps;
     }
 }
 export {};

package/dist/PublicTheme.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AAsQA,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":";;;AAoRA,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

@@ -1,9 +1,10 @@
-import { AxisCoordinate, ConvertToTypeParseSettings, EntityItem, IMdxAxisSeriesInfo, ITidyColumnsSource, ITidyTableSelection, MdxInfo, MdxMemberCoordinates, TidyCellError, TidyColumnsSubType, TidyColumnsType } from "./PublicTidyTableTypes";
+import { AxisCoordinate, ConvertToTypeParseSettings, EntityItem, GroupRowIndices, IMdxAxisSeriesInfo, ITidyColumnIndex, ITidyColumnsSource, MdxInfo, MdxMemberCoordinates, TidyCellError, TidyColumnsSubType, TidyColumnsType } from "./PublicTidyTableTypes";
 import { TidyActionEvent } from "./IcEvent";
 import { ReactElement } from "react";
 import { ThemeTextFormatter } from "./PublicTheme";
 import { Property } from "csstype";
 import { AppNotification } from "./INotification";
+import { MdxNodeIdentifier } from "./PublicTidyTable";
 export interface ITidyColumnTypedValue {
     value: any;
     fValue?: string;
@@ -22,6 +23,10 @@ export interface ITidyColumnAddValueCopyRow {
  * Properties with a special meaning
  */
 export declare enum ITidyColumnNamedProperties {
+    /**
+     * The value of a cell.
+     */
+    mdxCellValue = "value",
     /**
      * The formatted value of a cell. For example, 5003 in euros is formatted as €5,003
      */
@@ -82,7 +87,11 @@ export declare enum ITidyColumnNamedProperties {
     /**
      * Show this when hovering over the cell (or the visualisation representing the cell)
      */
-    tooltip = "tooltip"
+    tooltip = "tooltip",
+    /**
+     * Name for datetime properties for levels of type Year, Month, Day, Hour, etc..
+     */
+    datetime = "datetime"
 }
 export declare const CharacterTidyColumnProperties: Set<string>;
 /**
@@ -200,9 +209,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 useMdx If true, use MDX-unique names to construct groups. If false, use the columns values.
+     * Default = false.
+     *
+     * @returns a map with indexes for each group. Key -> row indeces
      */
-    groupBy(): Map<string, number[]>;
+    groupBy(useMdx?: boolean): Map<string, GroupRowIndices>;
     /**
      * Same as reIndex but creating a new column leaving this column untouched.
      *
@@ -214,6 +226,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
@@ -297,6 +310,7 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * Return the properties of a column for a given cell index.
      *
      * @param idx row index of cell.
+     * @deprecated
      */
     getPropertiesAt(idx: number): Record<string, any>;
     /**
@@ -308,6 +322,12 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * Create and return the entity item at position idx for generating events.
      */
     getEntityItem(idx: number): EntityItem | undefined;
+    /**
+     * Get the entity item for the column. Used in column selection.
+     * Returns empty array if there are no entityItems.
+     * @param hierarchyIndeces only include these hierarchies for generating the EntityItem
+     */
+    getColumnEntityItem(hierarchyIndeces?: number[]): EntityItem[];
     /**
      * Get the index of the parent. Returns -1 if the parent is the root.
      * @param idx the index to find the parent of.
@@ -343,6 +363,12 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * Returns the MDX info at a row index.
      */
     getMdxInfo(idx: number): MdxInfo | undefined;
+    /**
+     * Returns the key from the model. Values with the same key are the same in the underlying model. Rows
+     * with the same value but with a different key, are treated as different values.
+     * @param rowIdx
+     */
+    getUid(rowIdx: number): string;
     /**
      * Get extra information of the MDX axis used for this column, if available.
      */
@@ -382,6 +408,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.
      *
@@ -411,11 +442,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.
      *
@@ -507,12 +539,6 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * The ITidyTableSelection row identifier for the row (uniqueName if it's an MDX like column)
      */
     getSelectionRowIdentifier(idx: number): string;
-    /**
-     * @param sel  the selection columns
-     * @param colIdx  if multiple columns, the colIdx in the selectionColumn for the lookup
-     * @param startIdx  if defined, start lookup at this position
-     */
-    findRowIdxForSelection(sel: ITidyTableSelection, colIdx?: number, startIdx?: number): number | undefined;
     /**
      * Returns the row index of the first occurrence where the values of this column equals value.
      * Returns undefined if it did not find the value.
@@ -549,16 +575,45 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
      * Cell decoration
      */
     setCellDecoration(decoration: PublicTidyColumnCellDecoration): void;
+    /**
+     * Return the index of the column.
+     */
+    getIndex(): ITidyColumnIndex[];
+    /**
+     * undefined if it's not an Mdx member column
+     */
+    getQueryNodeIdentifier(idx: number): MdxNodeIdentifier | undefined;
+}
+export interface PublicTidyColumnCellDecorationRenderedOptions {
+    cellWidth?: number;
+    cellHeight: number;
+}
+export interface BaseTidyColumnCellDecoration {
+    handlesCellsOnError?: boolean;
+    appliesToCell?: (rowIdx: number) => boolean;
+    /**
+     *
+     * If an object is returned the underlying code uses emotion css function to convert to a className so you can do className like css
+     *
+     * {
+     *      fontSize: "0.7rem",
+     *      ':hover': {
+     *        fontSize: "1.4rem",
+     *      }
+     * }
+     *
+     */
+    cssStyles?: (rowIdx: number) => Record<string, any> | undefined;
+}
+export interface ReactTidyColumnCellDecoration extends BaseTidyColumnCellDecoration {
+    stringRenderer?: false;
+    renderer?: (rowIdx: number, options?: PublicTidyColumnCellDecorationRenderedOptions) => React.ReactElement;
+}
+export interface HtmlTidyColumnCellDecoration extends BaseTidyColumnCellDecoration {
+    stringRenderer: true;
+    renderer: (rowIdx: number, options?: PublicTidyColumnCellDecorationRenderedOptions) => string;
 }
-export declare type PublicTidyColumnCellDecoration = Partial<{
-    handlesCellsOnError: boolean;
-    appliesToCell: (rowIdx: number) => boolean;
-    rendered: (rowIdx: number, sizing?: {
-        width: number;
-        height: number;
-    }) => React.ReactElement;
-    cssStyles: (rowIdx: number) => Record<string, any> | undefined;
-}>;
+export declare type PublicTidyColumnCellDecoration = ReactTidyColumnCellDecoration | HtmlTidyColumnCellDecoration;
 export declare type ITidyColumn = ITidyBaseColumn<any>;
 export declare type ITidyUnknownColumn = ITidyBaseColumn<unknown | null>;
 export declare type ITidyNullColumn = ITidyBaseColumn<null>;

package/dist/PublicTidyColumn.js

@@ -6,6 +6,10 @@ exports.TidyTableNumberExprColumnMetas = exports.TidyTableTextExprColumnMetas =
  */
 var ITidyColumnNamedProperties;
 (function (ITidyColumnNamedProperties) {
+    /**
+     * The value of a cell.
+     */
+    ITidyColumnNamedProperties["mdxCellValue"] = "value";
     /**
      * The formatted value of a cell. For example, 5003 in euros is formatted as €5,003
      */
@@ -67,6 +71,10 @@ var ITidyColumnNamedProperties;
      * Show this when hovering over the cell (or the visualisation representing the cell)
      */
     ITidyColumnNamedProperties["tooltip"] = "tooltip";
+    /**
+     * Name for datetime properties for levels of type Year, Month, Day, Hour, etc..
+     */
+    ITidyColumnNamedProperties["datetime"] = "datetime";
 })(ITidyColumnNamedProperties = exports.ITidyColumnNamedProperties || (exports.ITidyColumnNamedProperties = {}));
 exports.CharacterTidyColumnProperties = new Set([
     ITidyColumnNamedProperties.mdxCellFormattedValue,

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;AAinBU,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":";;;AA8CA;;GAEG;AACH,IAAY,0BAsFX;AAtFD,WAAY,0BAA0B;IAElC;;OAEG;IACH,oDAAsB,CAAA;IAEtB;;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;IAEnB;;OAEG;IACH,mDAAqB,CAAA;AACzB,CAAC,EAtFW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAsFrC;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;AAgrBU,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 TidyHistogramMetaOptions: (group?: string, 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"}