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

package/dist/PublicTidyMath.d.ts

@@ -1,31 +1,41 @@
 import { ITidyBaseColumnReadonly } from "./PublicTidyColumn";
 import { HistogramData, HistogramOptions } from "./PublicTidyTableTypes";
+/**
+ * Utility class for doing maths in columns
+ *
+ *
+ * As a general rule, functions will return NaN once a value of the column is Nan
+ */
 export interface ITidyMath {
+    /**
+     * For each not null column value (numbers including Nan or Infinity)
+     *
+     * @param callback true to stop the for each
+     */
+    forEachNotNull(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[], callback: (value: number) => void): void;
     /**
      * Sum of all values in the column.
      */
-    sum(column: ITidyBaseColumnReadonly<number | null>): number | null;
+    sum(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[]): number | null;
     /**
      * Get the extreme value of the column. Null values are skipped.
      * @param column
-     * @returns the minimum value of the column. Returns undefined if the column has no values or if the column contains
-     * a NaN-value.
+     * @returns the minimum value of the column. Returns undefined if the column has no values.
      */
-    min<T>(column: ITidyBaseColumnReadonly<T>): T | undefined;
+    min<T>(column: ITidyBaseColumnReadonly<T> | ITidyBaseColumnReadonly<T | null>[]): T | undefined;
     /**
      * Get the extreme value of the column. Null values are skipped.
      * @param column
-     * @returns the maximum value of the column. Returns undefined if the column has no values or if the column contains
-     * a NaN-value.
+     * @returns the maximum value of the column. Returns undefined if the column has no values.
      */
-    max<T>(column: ITidyBaseColumnReadonly<T>): T | undefined;
+    max<T>(column: ITidyBaseColumnReadonly<T> | ITidyBaseColumnReadonly<T | null>[]): T | undefined;
     /**
      * Get the maximum of the absolute values of the column.
      * @param column
      * @returns If x_1, x_2, ..., x_n are the columns values, then it returns max(|x_1|, ..., |x_n|). Null values are
      * skipped.
      */
-    absoluteMax(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
+    absoluteMax(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[]): number | undefined;
     /**
      * Sum all values matching the lowest depth level of axis column
      */
@@ -33,33 +43,29 @@ export interface ITidyMath {
     /**
      * Estimate the population mean of the column, skipping null values.
      *
-     * @returns the mean of the numeric column. Returns undefined if the column has no values or if the column contains
-     * a NaN-value.
+     * @returns the mean of the numeric column. Returns undefined if the column has no values.
      */
-    mean(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
+    mean(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[]): number | undefined;
     /**
      * Estimate the population variance of the column. Null values are skipped.
      * @param column
-     * @returns the variance of the column. Returns undefined if the column has no values or if the column contains a
-     * NaN-value.
+     * @returns the variance of the column. Returns undefined if the column has no values
      */
-    variance(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
+    variance(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[]): number | undefined;
     /**
      * Estimate the population standard deviation of the column. Null values are skipped.
      * @param column
-     * @returns the standard deviation of the column. Returns undefined if the column has no values or if the column
-     * contains a NaN-value.
+     * @returns the standard deviation of the column. Returns undefined if the column has no values
      */
-    standardDeviation(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
+    standardDeviation(column: ITidyBaseColumnReadonly<number | null> | ITidyBaseColumnReadonly<number | null>[]): number | undefined;
     /**
      * Return the number of non-null values in the column.
      */
-    count(column: ITidyBaseColumnReadonly<any>): number;
+    count(column: ITidyBaseColumnReadonly<any> | ITidyBaseColumnReadonly<any>[]): number;
     /**
      * Calculate the median of the column. Null-values are ignored.
      * @param column
-     * @returns the median of the numeric column. Returns undefined if the column has no values or if the column contains
-     * a NaN-value.
+     * @returns the median of the numeric column. Returns undefined if the column has no values
      */
     median(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
     /**

package/dist/PublicTidyTable.d.ts

@@ -1,9 +1,9 @@
-import { AxisCoordinate, IAmCharts4Data, IAmCharts4DataTreeMap, ITotalRowValues, SortingType, TidyColumnIndex, TidyColumnsType, TidyTableColumnSelector } from "./PublicTidyTableTypes";
+import { AxisCoordinate, ChartTemplateDataMapping, GroupRowIndices, 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";
+import { ITidyMath } from "./PublicTidyMath";
 /**
  *  Identifies a Mdx node in a query.
  *
@@ -15,6 +15,7 @@ export interface MdxNodeIdentifier {
     readonly hierarchyIdx: number;
     readonly tupleUNs: ReadonlyArray<string>;
     readonly tupleIdx: number;
+    readonly levelDepthR?: number;
 }
 /**
  * Result of a MDX, SQL, ... query with additional transformations (e.g., colors, sizes, changing MDX names,...).
@@ -35,6 +36,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 +89,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 +227,20 @@ export interface ITidyTable {
      */
     buildTidyTree(treeColumns: ITidyColumn[], rootLabel?: string, expandHierarchicalColumn?: boolean): TidyTree;
     /**
-     * Construct list of tidy tables
+     * Group the table by some of its columns. Rows are in the same group, if their values are equal.
      * @param columns groupIdx and groupRows for each unique value in this(ese) column(s)
-     * @returns an map with indexes for each group.
+     * @param useMdx If true, use MDX values. Default = use column values.
+     * @returns an array with indexes for each group. The ith item represents the rows of the group, where i is the
+     * index of the ith unique value in the group column.
      */
-    groupBy(columns: ITidyColumn[]): number[][];
+    groupBy(columns: ITidyColumn[], useMdx?: boolean): GroupRowIndices[];
     /**
-     * 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 +298,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 +449,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 +459,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 +472,18 @@ 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;
+    /**
+     * Utility class for doing maths on columns
+     */
+    getMath(): ITidyMath;
 }

package/dist/PublicTidyTableInteractions.d.ts

@@ -1,4 +1,4 @@
-import { SelectionBehaviour } from "./PublicTidyTableTypes";
+import { SelectionBehaviour, WidgetTidySelectionOptions } from "./PublicTidyTableTypes";
 import { ITidyBaseColumn, ITidyColumn } from "./PublicTidyColumn";
 import { ILazyTreeViewLoader } from "./LazyTreeView";
 import { PublicIcEvent } from "./IcEvent";
@@ -29,11 +29,12 @@ export declare enum TidyPivotTableLikeNodeStatus {
     LOADING = 4
 }
 export declare type TidyEvent = MouseEvent | TouchEvent;
+export declare type IWidgetInteractionMode = "drilldown" | "selection";
 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 +45,22 @@ export interface ITidyTableInteractionSelection {
      * @param rowIdx the index of the row
      */
     isSelected(rowIdx: number): boolean;
+    /**
+     * Returns true if and only if the column is selected.
+     * @param colIdx
+     */
+    isColumnSelected(colIdx: number): boolean;
+    /**
+     * Returns true if and only if the cell is selected.
+     * @param rowIdx
+     */
+    isCellSelected(rowIdx: number, colIdx: 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
@@ -62,23 +79,39 @@ export interface ITidyTableInteractionSelection {
      * @param noSelectionValue   if defined an the selection is empty, all row values have this value
      */
     applySelectionToNewColumn<T>(selectedItemValue: T, notSelectedItemValue: T, noSelectionValue?: T): ITidyBaseColumn<T>;
+    /**
+     * Handles the row click event for the selection
+     * @param rowIdx index of row clicked
+     * @param event the mouse event of the click
+     */
+    handleClickSelection(rowIdx: number, event?: TidyEvent): void;
     /**
      * Handles the click event for the selection on a given column.
      *
      * If the columns is not part of the selection columns of the widget nothing will happen
      *
-     * @param column column that is in the selection columns
-     * @param rowIdx index of row clicked
+     * @param column column index of the tidy table
      * @param event the mouse event of the click
      */
-    handleColumnSelection(column: ITidyColumn, rowIdx: number, event?: TidyEvent): void;
-    getColorOnSelection(theme: Theme, color: string | undefined, rowIdx: number): string | undefined;
+    handleColumnSelection(colIdx: number, event?: TidyEvent): void;
     /**
-     * Handles the click event for the selection
-     * @param rowIdx index of row clicked
+     * Handles the click event for the selection of a given cell
+     *
+     * If the columns is not part of the selection columns of the widget nothing will happen
+     *
+     * @param rowIdx row index of clicked cell in the tidy table
+     * @param colIdx column index of clicked cell in the tidy table
      * @param event the mouse event of the click
      */
-    handleClickSelection(rowIdx: number, event?: TidyEvent): void;
+    handleCellSelection(rowIdx: number, colIdx: number, event?: TidyEvent): void;
+    /**
+     * Get the interaction mode:
+     * undefined = no interactions in the widget,
+     * selection = perform selection interaction,
+     * drilldown = perform drilldown interaction.
+     */
+    getInteractionMode(): IWidgetInteractionMode | undefined;
+    getColorOnSelection(theme: Theme, color: string | undefined, rowIdx: number): string | undefined;
     /**
      * Select multiple rows at once
      */
@@ -158,10 +191,6 @@ 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 {
     /**
@@ -169,13 +198,41 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
      *
      * The column(s) for the selection or the drilldown are based on the widget options/settings
      *
-     * This does not fire any event...for now
+     * This does not fire any event. To fire an event, use fireEvent.
+     *
+     * @see fireEvent
      */
     handleRowHit(rowIdx: number, event: TidyEvent | undefined): void;
     /**
-     * Collapsed / Expand
+     * Handles a cell click in the tidy table.
+     * @param rowIdx row index of the cell
+     * @param colIdx column index of the cell
+     * @param event mouse/touch event
+     *
+     * @see handleRowHit
+     */
+    handleCellHit(rowIdx: number, colIdx: number, event: TidyEvent | undefined): void;
+    /**
+     * Handles a column click in the tidy table.
+     * @param colIdx index of clicked column in the tidy table
+     * @param event mouse/touch event
+     *
+     * @see handleRowHit
+     */
+    handleColumnHit(colIdx: 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 on a column row (i.e. it's a tree)
      */
-    toggleSeriesPoint(column: ITidyColumn, rowIdx: number): void;
+    toggleCollapse(column: ITidyColumn, rowIdx: number): void;
+    /**
+     * returns the collapse/expand state that has not yet been set by the end user (i.e. first time, on drilldowns..)
+     */
+    setCollapseUnsetFunction(collapseUnsetFunction?: (nodeInfo: MdxNodeIdentifier) => boolean): void;
     /**
      * Map a function to the visible rows only. Used in tree structures with expanded or collapsed items.
      * @param column column to map the values of
@@ -188,7 +245,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.
@@ -205,4 +262,10 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
     asLazyTreeViewLoader(column: ITidyColumn): ILazyTreeViewLoader;
     getCompactedSelectionNames(): string[] | undefined;
     isSelectable(col: ITidyColumn): boolean;
+    getSelectedRows(): number[];
+    setSortSelectionToColumnOrder(value: boolean): void;
+    /**
+     * Returns the widgets selection options.
+     */
+    getWidgetSelectionOptions(): WidgetTidySelectionOptions;
 }

package/dist/PublicTidyTableTypes.d.ts

@@ -2,8 +2,9 @@
  * Tidy Column Types
  */
 import { TidyHistogramBucketType } from "./PublicTidyHistogram";
-import { ITidyColumnAddValueInsert } from "./PublicTidyColumn";
+import { ITidyColumn, ITidyColumnAddValueInsert } from "./PublicTidyColumn";
 import { MdxNodeIdentifier } from "./PublicTidyTable";
+import { SelectionMode } from "./PublicTidyTableInteractions";
 export declare enum TidyColumnsType {
     /**
      * Values represent a color, e.g. 'red', 'rbg(10, 10, 10)' or '#fff'. Can be null.
@@ -59,12 +60,11 @@ export declare enum ITidyColumnsSource {
     UNKNOWN = "unknown"
 }
 /**
- * Defines a mapping that maps columns to the coordinate system of the chart.
- *
- * The key represents the internal name for the mapping (is converted to lowercase).
- * undefined --> the editor sets names to undefined upon removing of a mapping.
+ * Defines a mapping that maps columns to the coordinate system of the widget.
+ * The key represents the internal lowercase-name for the mapping, e.g., axis, group, rows, columns.
+ * Note that a mapping can have multiple columns, for example, on the Rows.
  */
-export declare type ChartTemplateDataMapping = Record<string, TidyTableColumnSelector | undefined>;
+export declare type ChartTemplateDataMapping = Record<string, ITidyColumn[] | undefined>;
 /**
  * Defines an index from column tag (name, mapping, role, etc..) to the name or index of the column in the table.
  * The column tag is converted to lower case.
@@ -77,7 +77,7 @@ export declare enum TidyTableMappingColumnSelectorOptions {
     ALL_MEASURES = "@IC3_ALL_MEASURES",
     ALL_AXIS = "@IC3_ALL_AXIS"
 }
-export declare type TidyTableColumnSelector = {
+export interface TidyTableColumnIdentifier {
     /**
      * Search column by name
      */
@@ -86,7 +86,34 @@ export declare type TidyTableColumnSelector = {
      * If we want a property, the name of the column's property.
      */
     property?: string;
-} | TidyTableMappingColumnSelectorOptions;
+}
+export declare type TidyTableColumnSelector = TidyTableColumnIdentifier | TidyTableMappingColumnSelectorOptions;
+export declare type IFormFieldGranularityItem = IFormFieldGranularityItemColumn | IFormFieldGranularityItemRole | IFormFieldGranularityItemHierarchy;
+export interface IFormFieldGranularityItemColumn {
+    type: "column";
+    /**
+     * For selecting columns from the tidy table
+     */
+    name: string;
+}
+export interface IFormFieldGranularityItemRole {
+    type: "role";
+    /**
+     * For selecting mapping/roles in a chart
+     */
+    role: string;
+}
+export interface IFormFieldGranularityItemHierarchy {
+    type: "hierarchy";
+    /**
+     * Show in editor.
+     */
+    caption: string;
+    /**
+     * Hierarchy for entity items in columns
+     */
+    hierarchyIdx: number;
+}
 /**
  * Coordinate of an MDX member
  */
@@ -101,8 +128,9 @@ export interface MdxMemberCoordinates {
     tupleIdx: number;
     /**
      * index of the member in the tuple. E.g. AF in (AF, 2009) has index 0 and 2009 has index 1.
+     * undefined means use the whole tuple.
      */
-    hierIdx: number;
+    hierIdx?: number;
 }
 declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 /**
@@ -196,7 +224,6 @@ export interface EntityItem {
     selected?: boolean;
     empty?: boolean;
     tupleUNames?: string[];
-    tidyIdxHint?: number;
 }
 export interface TidyCellError {
     errorCode: string;
@@ -213,18 +240,12 @@ export interface TidyCellError {
  */
 export interface ITidyTableSelection {
     /**
-     * If the Table changes this rowIdx might not longer be valid
-     * It's the clicked/hit row
-     */
-    hitRowIdx: number;
-    /**
-     * A list of unique names that identify the selection
+     * Object storing the selection coordinates.
      */
-    rowIdentifier: string | string[];
     /**
-     * A list with the columns names (for info)
+     * Fired event value. Arrays are combined into a single event.
      */
-    columnNames: string | string[];
+    items: EntityItem[];
 }
 export declare enum SelectionBehaviour {
     /**
@@ -235,6 +256,11 @@ export declare enum SelectionBehaviour {
      * Select all items in the filter.
      */
     SELECT_ALL = "SELECT_ALL",
+    /**
+     * Easy to guess
+     */
+    SELECT_FIRST = "SELECT_FIRST",
+    SELECT_LAST = "SELECT_LAST",
     /**
      * Select no items in the filter and clear the event.
      */
@@ -313,6 +339,9 @@ export interface ConvertToTypeParseSettings {
     dateFormat?: string;
     listSeparator?: string;
 }
+/**
+ * Interface for adding a single row to a tidy table
+ */
 export interface ITotalRowValues {
     /**
      * Keys as column names.
@@ -323,4 +352,65 @@ export interface ITotalRowValues {
      */
     totalTexts: Record<string, ITidyColumnAddValueInsert>;
 }
+/**
+ * If we have (date)times available, then
+ * YES -> always use them
+ * NO -> never use them
+ * AUTO -> use them if the level is a date or datetime (in MDX, these are levels of type DAY, HOUR, MINUTE, SECOND).
+ */
+export declare enum UseDatetimeAxis {
+    YES = "YES",
+    NO = "NO",
+    AUTO = "AUTO"
+}
+export interface ITidyColumnIndex {
+    /**
+     * Name of index
+     */
+    name: string;
+    /**
+     * Display label for index
+     */
+    label: string;
+    /**
+     * Unique name of mdx member
+     */
+    mdxUniqueName?: string;
+    /**
+     * Level of mdx member
+     */
+    mdxLevel?: string;
+}
+export interface WidgetTidySelectionOptions {
+    /**
+     * If true, the widget responds to selection events.
+     */
+    isSelectionActive: boolean;
+    /**
+     * User can set the selection mode in the interaction-settings.
+     */
+    selectionMode: SelectionMode;
+    /**
+     * These columns are considered in the selection.
+     */
+    selectionGranularity?: IFormFieldGranularityItem[];
+    /**
+     * Behaviour when all items in the filter are selected.
+     */
+    selectionAllBehaviour?: SelectionBehaviour;
+    /**
+     * Behaviour when the selection is empty, e.g. when no items are selected.
+     */
+    selectionEmptyBehaviour?: SelectionBehaviour;
+    /**
+     * List with items in the initial selection.
+     */
+    initSelectionUserDefined?: string[];
+    /**
+     * Column with items in the initial selection. The column has a truthy value for items that are in the initial
+     * selection.
+     */
+    initSelectionColumn?: TidyTableColumnSelector;
+}
+export declare type GroupRowIndices = [number, ...number[]];
 export {};

package/dist/PublicTidyTableTypes.js

@@ -3,7 +3,7 @@
  * Tidy Column Types
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InterpolationType = exports.SortingType = exports.SelectionBehaviour = exports.IAmcharts4DataKey = exports.TidyTableMappingColumnSelectorOptions = exports.ITidyColumnsSource = exports.TidyColumnsType = void 0;
+exports.UseDatetimeAxis = exports.InterpolationType = exports.SortingType = exports.SelectionBehaviour = exports.IAmcharts4DataKey = exports.TidyTableMappingColumnSelectorOptions = exports.ITidyColumnsSource = exports.TidyColumnsType = void 0;
 var TidyColumnsType;
 (function (TidyColumnsType) {
     /**
@@ -93,6 +93,11 @@ var SelectionBehaviour;
      * Select all items in the filter.
      */
     SelectionBehaviour["SELECT_ALL"] = "SELECT_ALL";
+    /**
+     * Easy to guess
+     */
+    SelectionBehaviour["SELECT_FIRST"] = "SELECT_FIRST";
+    SelectionBehaviour["SELECT_LAST"] = "SELECT_LAST";
     /**
      * Select no items in the filter and clear the event.
      */
@@ -124,4 +129,16 @@ var InterpolationType;
     InterpolationType["HSL"] = "hsl";
     InterpolationType["LAB"] = "lab";
 })(InterpolationType = exports.InterpolationType || (exports.InterpolationType = {}));
+/**
+ * If we have (date)times available, then
+ * YES -> always use them
+ * NO -> never use them
+ * AUTO -> use them if the level is a date or datetime (in MDX, these are levels of type DAY, HOUR, MINUTE, SECOND).
+ */
+var UseDatetimeAxis;
+(function (UseDatetimeAxis) {
+    UseDatetimeAxis["YES"] = "YES";
+    UseDatetimeAxis["NO"] = "NO";
+    UseDatetimeAxis["AUTO"] = "AUTO";
+})(UseDatetimeAxis = exports.UseDatetimeAxis || (exports.UseDatetimeAxis = {}));
 //# sourceMappingURL=PublicTidyTableTypes.js.map

package/dist/PublicTidyTableTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTidyTableTypes.js","sourceRoot":"","sources":["../src/PublicTidyTableTypes.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAMH,IAAY,eA0DX;AA1DD,WAAY,eAAe;IACvB;;OAEG;IACH,kCAAe,CAAA;IAEf,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IAErB;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,wCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,0CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAa,CAAA;IAEb;;OAEG;IACH,kCAAe,CAAA;IAEf;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAa,CAAA;IAEb;;OAEG;IACH,8BAAW,CAAA;AACf,CAAC,EA1DW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA0D1B;AAkBD,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,qCAAe,CAAA;IACf,uDAAiC,CAAA;IACjC,yCAAmB,CAAA;AACvB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAgBD,IAAY,qCAQX;AARD,WAAY,qCAAqC;IAE7C,yDAAgB,CAAA;IAChB,yEAAgC,CAAA;IAChC,6EAAoC,CAAA;IACpC,2EAAkC,CAAA;IAClC,mEAA0B,CAAA;AAE9B,CAAC,EARW,qCAAqC,GAArC,6CAAqC,KAArC,6CAAqC,QAQhD;AAgED,IAAY,iBAgBX;AAhBD,WAAY,iBAAiB;IACzB;;;OAGG;IACH,kCAAa,CAAA;IAEb;;OAEG;IACH,gCAAW,CAAA;IAEX;;OAEG;IACH,+BAAU,CAAA;AACd,CAAC,EAhBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAgB5B;AA6GD,IAAY,kBA8BX;AA9BD,WAAY,kBAAkB;IAC1B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,+CAAyB,CAAA;IAEzB;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,6CAAuB,CAAA;IAEvB;;OAEG;IACH,yDAAmC,CAAA;AACvC,CAAC,EA9BW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QA8B7B;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACnB,sCAAuB,CAAA;IACvB,wCAAyB,CAAA;IACzB,wCAAuB,CAAA;AAC3B,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAsDD,IAAY,iBAMX;AAND,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;AACf,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B"}
+{"version":3,"file":"PublicTidyTableTypes.js","sourceRoot":"","sources":["../src/PublicTidyTableTypes.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAOH,IAAY,eA0DX;AA1DD,WAAY,eAAe;IACvB;;OAEG;IACH,kCAAe,CAAA;IAEf,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IAErB;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,wCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,0CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAa,CAAA;IAEb;;OAEG;IACH,kCAAe,CAAA;IAEf;;OAEG;IACH,sCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAa,CAAA;IAEb;;OAEG;IACH,8BAAW,CAAA;AACf,CAAC,EA1DW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA0D1B;AAkBD,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,qCAAe,CAAA;IACf,uDAAiC,CAAA;IACjC,yCAAmB,CAAA;AACvB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAeD,IAAY,qCAQX;AARD,WAAY,qCAAqC;IAE7C,yDAAgB,CAAA;IAChB,yEAAgC,CAAA;IAChC,6EAAoC,CAAA;IACpC,2EAAkC,CAAA;IAClC,mEAA0B,CAAA;AAE9B,CAAC,EARW,qCAAqC,GAArC,6CAAqC,KAArC,6CAAqC,QAQhD;AAsGD,IAAY,iBAgBX;AAhBD,WAAY,iBAAiB;IACzB;;;OAGG;IACH,kCAAa,CAAA;IAEb;;OAEG;IACH,gCAAW,CAAA;IAEX;;OAEG;IACH,+BAAU,CAAA;AACd,CAAC,EAhBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAgB5B;AAsGD,IAAY,kBAqCX;AArCD,WAAY,kBAAkB;IAC1B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,+CAAyB,CAAA;IAEzB;;OAEG;IACH,mDAA6B,CAAA;IAE7B,iDAA2B,CAAA;IAE3B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,6CAAuB,CAAA;IAEvB;;OAEG;IACH,yDAAmC,CAAA;AACvC,CAAC,EArCW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAqC7B;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACnB,sCAAuB,CAAA;IACvB,wCAAyB,CAAA;IACzB,wCAAyB,CAAA;AAC7B,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAwDD,IAAY,iBAMX;AAND,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;AACf,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B;AAyBD;;;;;GAKG;AACH,IAAY,eAIX;AAJD,WAAY,eAAe;IACvB,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,gCAAa,CAAA;AACjB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}