@ic3/reporting-api 9.0.0 → 9.1.0

package/dist/PublicTidyTable.d.ts

@@ -1,534 +0,0 @@
-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 { TidyHistogramOptions } from "./PublicTidyHistogram";
-import { IPublicContext } from "./PublicContext";
-import { ITidyMath } from "./PublicTidyMath";
-/**
- *  Identifies a Mdx node in a query.
- *
- *  For queries with more than 2 axis multiple rows might point to the same NodeIdentifier
- */
-export interface MdxNodeIdentifier {
-    readonly uid: string;
-    readonly axis: number;
-    readonly hierarchyIdx: number;
-    readonly tupleUNs: ReadonlyArray<string>;
-    readonly captions?: ReadonlyArray<string>;
-    readonly tupleIdx: number;
-    readonly levelDepthR?: number;
-}
-/**
- * Result of a MDX, SQL, ... query with additional transformations (e.g., colors, sizes, changing MDX names,...).
- * A tidy table has axes and measures. The axes describe the coordinates for each measure.
- * The columns of a tidy table are thus structured as follows: columns = axes + measures.
- *
- * For example:
- * axes         | measures
- * Brand | Year | Size (m)
- * Volvo | 2018 | 234
- * MBW   | 2019 | 456
- *
- * In this chart the Brand and Year columns are axes and Size (m) is the measure.
- * The columns of this table are Brand, Year, Size (m).
- */
-export interface ITidyTable {
-    /**
-     * Get the query uid
-     */
-    getQueryUid(): number;
-    isSameDimensionality(other: ITidyTable): boolean;
-    asPivotTableForExcel(nullValue: any, rows: number[] | undefined): ITidyColumn[];
-    /**
-     * Return all columns in the table
-     */
-    getColumns(): ITidyColumn[];
-    /**
-     * Get the number of rows.
-     */
-    getRowCount(): number;
-    /**
-     * Get the number of columns.
-     */
-    getColumnCount(): number;
-    /**
-     * Get the nth character column in the table
-     * @param axisPosition
-     */
-    getAxisN(axisPosition: number): ITidyCharacterColumn;
-    /**
-     * @see {getAxisN}
-     */
-    getOptionalAxisN(axisPosition: number): ITidyCharacterColumn | undefined;
-    /**
-     * Get the nth numeric column in the table
-     * @param axisPosition
-     */
-    getMeasureN(axisPosition: number): ITidyNumericColumn;
-    /**
-     * @see {getMeasureN}
-     * @param axisPosition
-     */
-    getOptionalMeasureN(axisPosition: number): ITidyNumericColumn | undefined;
-    /**
-     * Get a column by name (case insensitive) or index. If no column is found, it gives an error.
-     * @param identifier name or index of the column
-     */
-    getColumn(identifier: string | number): ITidyColumn;
-    /**
-     * @see {getColumn}
-     */
-    getOptionalColumn(identifier: string | number): ITidyColumn | undefined;
-    /**
-     * Column getters with mapping defined, throws an error if the column is not found.
-     *
-     * The idea is then to have a function: getColumnByAlias that requests mapping name.
-     * The widget can check for if the mapping is undefined or not. If it is defined,
-     * it will result in a column (which can be empty). If it is undefined it will try to
-     * fallback to another column that has the mapping specification.
-     *
-     * @param alias mapping name
-     */
-    getColumnByAlias(alias: string): ITidyColumn;
-    /**
-     * Returns multiple columns. For example, in the line chart, this function returns all the columns mapped in the
-     * values option.
-     * @see getColumnByAlias
-     * @param alias
-     */
-    getColumnsByAlias(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;
-    /**
-     * @see {getColumnByAlias}
-     */
-    getOptionalColumnsByAlias(alias: string): ITidyColumn[] | undefined;
-    /**
-     * Get the coordinate of the column using the alias for the mapping
-     * @param alias the name of the mapping
-     */
-    getOptionalColumnCoordinateByAlias(alias: string): TidyTableColumnIdentifier | undefined;
-    /**
-     * Get columns using a selector
-     * @param selector selector object
-     */
-    getColumnsBySelector(selector: TidyTableColumnSelector | TidyTableColumnSelector[]): ITidyColumn[];
-    /**
-     * Get a column using the coordinate of an axis.
-     * @param coordinate
-     * @see {AxisCoordinate}
-     */
-    getColumnByMdxAxis(coordinate: AxisCoordinate): ITidyColumn | undefined;
-    /**
-     * Get all columns on an axis.
-     * @param axisIdx index of the axis. ON 0, ON 1, etc..
-     */
-    getColumnsByMdxAxis(axisIdx: number): ITidyColumn[];
-    /**
-     * Get the number of MDX axis.
-     */
-    getMdxAxisCount(): number;
-    /**
-     * Get the column for the text formatter
-     * @param nameOrAlias the name or the mapping alias for the column
-     */
-    getColumnForTextFormatter(nameOrAlias: string): ITidyColumn | undefined;
-    /**
-     * Convert the tidy table to an array of arrays.
-     * @param major the major-ordering of the arrays. If 'column', the result is an array of columns. If 'row', the
-     * result is an array of rows. The default is 'row'.
-     */
-    toArray(major?: 'row' | 'column'): any[][];
-    /**
-     * Get the column names of the tidy table. Each column in the table has a unique name.
-     */
-    getColumnNames(): string[];
-    /**
-     * Get the column captions of the tidy table
-     */
-    getColumnCaptions(): string[];
-    /**
-     * Get a column by its type
-     * @param type columns of this type are in the result set
-     * @param position get the nth column of the result set, default = 0
-     */
-    getColumnByType(type: TidyColumnsType, position?: number): ITidyColumn;
-    /**
-     * @see {getColumnByType}
-     */
-    getOptionalColumnByType(type: TidyColumnsType, position?: number): ITidyColumn | undefined;
-    /**
-     * Search through the columns in the table returning the n-th column that is found.
-     * @param predicate function that returns true if and only if the column is in the result set.
-     * @param position the position in the result set. Defaults to 0.
-     */
-    searchColumn(predicate: (column: ITidyColumn) => boolean, position?: number): ITidyColumn | undefined;
-    /**
-     * Return a list of the types of the column in the table
-     */
-    getColumnTypes(): TidyColumnsType[];
-    /**
-     * Get the index of the column in the table
-     * @param col
-     */
-    lookupColumnIdx(col?: ITidyColumn): number;
-    /**
-     * Returns the value of the cell. Does not search properties.
-     * @param columnName name of the column in the table
-     * @param row row of the table
-     */
-    getValue(columnName: string, row: number): any;
-    /**
-     * Apply a mapper function to each row. Returns a list with length equal to the number of rows in the table.
-     * @param mapper the function to use.
-     */
-    mapRows<T>(mapper: (rowIdx: number, rowData: (colIdx: number) => any, colCount: number) => T): T[];
-    /**
-     * Map the columns of the table, resulting in a list with length equal to the number of columns.
-     * @param mapper
-     */
-    mapColumns<T>(mapper: (colIdx: ITidyColumn, colData: (rowIdx: number) => any, rowCount: number) => T): T[];
-    /**
-     * Take the sum of the column, but if it is a hierarchical column only the sum at the root level will be
-     * calculated
-     * @param axisColIdx the (hierarchical) axis
-     * @param measureColIdx measures to take the sum of
-     */
-    sumRoot(axisColIdx: number, measureColIdx: number): number;
-    /**
-     * build a tidy tree where the levels are defined by the treeLevels parameter, using
-     * the column values for creating unique tree nodes.
-     *
-     *  ColA   |  ColB  | Value
-     *  Europe   Bike     1
-     *  Europe   Car      2
-     *  America  Foot     4
-     *
-     * is transformed into :
-     *
-     * root
-     *  |
-     *  --- Europe
-     *  |     |
-     *  |     --- Bike  1
-     *  |     |
-     *  |     --- Car   2
-     *  |
-     *  --- America
-     *       |
-     *       --- Foot   4
-     *
-     * The values of the measures are added to the leafs unless expandHierarchicalColumn is true.
-     *
-     *
-     * @param treeColumns  columns to build the levels
-     * @param rootLabel    the label of the root
-     * @param expandHierarchicalColumn  if true, hierarchical columns will be expanded as a tree (all nodes except the root one will have measures values)
-     */
-    buildTidyTree(treeColumns: ITidyColumn[], rootLabel?: string, expandHierarchicalColumn?: boolean): TidyTree;
-    /**
-     * 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)
-     * @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[], useMdx?: boolean): GroupRowIndices[];
-    /**
-     * Pivot a tidy table from wide to long format. See pivot longer in the documentation.
-     * @param columns columns to melt.
-     * @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[], variableName?: string, valuesName?: string): void;
-    /**
-     * Pivot a tidy table from long to wide format
-     * Duplicated rows are discarded.
-     * @param toColumns Pivot the row-values of this column to the columns of the table.
-     * @param valueCols transpose the values in these column.
-     * @param toRows Each unique combination in these columns is a row in the transformed table. Leave undefined to take all remaining columns.
-     */
-    cast(toColumns: ITidyColumn[], valueCols: ITidyColumn[], toRows?: ITidyColumn[]): void;
-    /**
-     * Cast to create a new table
-     * @see cast
-     */
-    castN(toColumns: ITidyColumn[], valueCols: ITidyColumn[], toRows?: ITidyColumn[]): ITidyTable;
-    /**
-     * Sort the table based on the certain columns. Default sorting is descending.
-     * @param columns column(s) used for sorting. Columns earlier in the list take priority over columns with
-     * higher indexes in determining the order.
-     * @param order sorting order. Default = descending.
-     */
-    sort(columns: ITidyColumn[], order?: SortingType[]): void;
-    /**
-     * Sort the table while keeping the parent/child structure in treeColumns intact.
-     * @param treeColumns one or more columns with a tree like structure
-     * @param sortingColumns columns to sort on
-     * @param order sorting order. Default = descending.
-     */
-    sortInTree(treeColumns: ITidyColumn[], sortingColumns: ITidyColumn[], order?: SortingType[]): void;
-    /**
-     * Get the ranking of one or more columns. Smallest value gets rank 0,
-     * second smallest rank 1, etc. until rank n-1. Sort ascending by default.
-     * @param columns columns used for finding the order. Columns earlier in the list take priority over columns with
-     * higher indexes in determining the order.
-     * @param order sorting order. Default = ascending.
-     */
-    getRank(columns: ITidyColumn[], order?: SortingType[]): number[];
-    /**
-     * Add a new column to the table. If the column name already exits, a new name is generated.
-     * If the column is already in the table, nothing is done.
-     */
-    addColumn(column: ITidyColumn): void;
-    /**
-     * Convert the tidy table to a data object that can be used by amCharts V5.
-     */
-    toAmcharts5Data(axis: ITidyColumn, group: ITidyColumn | undefined, value: Record<string, ITidyColumn | undefined>): any;
-    /**
-     * Convert the tidy table to a data object that can be used by amCharts.
-     * Note, duplicated rows in 'group' are skipped.
-     *
-     * See the tests for examples.
-     *
-     * @param category the column with labels for the category axis.
-     * @param value this is an object with columns. Each column is converted to <group>.<key> = <column-value>.
-     * @param group column indicating the groups. Each unique value in this column forms a new group. Groups in
-     * the resulting data object are given by '<group_id>.' preceding the values.
-     * @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].
-     * @param hideNulls column, do not include records where all rows in group evaluate to NULL.
-     * @param disableGroupRecords if true, all the rows become a single object. Else all data per group becomes a single object. Default = false.
-     */
-    toAmcharts4Data<F extends string>(category: ITidyColumn, value: Record<F, ITidyColumn | undefined>, group?: ITidyColumn | ITidyColumn[], level?: ITidyColumn, hideNulls?: ITidyColumn, disableGroupRecords?: boolean): IAmCharts4Data[];
-    /**
-     * Creates a data object for the Amcharts treemap
-     * @param level0 names for the parent nodes
-     * @param level1 names for the child nodes
-     * @param value values to use in the node data
-     */
-    toAmcharts4DataTreeMap(level0: ITidyColumn, level1: ITidyColumn, value: Record<string, ITidyColumn | undefined>): IAmCharts4DataTreeMap[];
-    /**
-     * Convert the tidy table to json.
-     *
-     * For example, let table =
-     * col1 | col2 | value1 | value2
-     * a      b      1        2
-     * a      bar    5        3
-     *
-     * then, table.toJson('r', {c1: col1, c2: col2, v2: value2}) results in
-     * [
-     *    {row: 0, c1: a, c2: b, v2: 2},
-     *    {row: 1, c1: a, c2: bar, v2: 3}
-     * ]
-     *
-     * Note that 'row' represents the index of the row in the tidy table.
-     *
-     * Another example, now without arguments:
-     * table.toJson() results in
-     * [
-     *  {
-     *      row: 0,
-     *      col1: a,
-     *      col2: b,
-     *      value1: 1,
-     *      value2: 2
-     *  },
-     *  {
-     *      row: 1,
-     *      col1: a,
-     *      col2: bar,
-     *      value1: 5,
-     *      value2: 3
-     *  }
-     * ]
-     *
-     * @param rowIdxTag if defined, include the row number of the tidy table in the result. Use rowIdxTag as the key in the object.
-     * @param colTags if defined, this is how the columns in the tidy table are mapped. If not defined, the captions of the
-     * tidy table are used as keys in the row objects.
-     */
-    toJson(rowIdxTag?: string, colTags?: Record<string, ITidyColumn | undefined>): Record<string, any>[];
-    /**
-     * Get a row as an object.
-     * @param rowIdx index of the row to query.
-     */
-    getRowJson(rowIdx: number): Record<string, any>;
-    /**
-     * Convert the table to html table string
-     */
-    toHtml(): string;
-    /**
-     * throws an exception if the column does not belong to the table
-     */
-    assertColumnExists(column: ITidyColumn): void;
-    hasEmptyDrilldown(nodeInfo: MdxNodeIdentifier): boolean;
-    /**
-     * Apply a new index to the table. Used for sorting, filtering and duplication of rows.
-     *
-     * Examples:
-     *
-     * table.toString() -->
-     *     Country   |Amount    |Count     |
-     * ----------------------------------------
-     * 0   France    |10        |5         |
-     * 1   Holland   |20        |4         |
-     * 2   China     |25        |3         |
-     * 3   Germany   |20        |2         |
-     * 4   Belgium   |25        |1         |
-     *
-     * column.reIndex([0,0,2,4,1,-1,-1,999]) -->
-     *     Country   |Amount    |Count     |
-     * ----------------------------------------
-     * 0   France    |10        |5         |
-     * 1   France    |10        |5         |
-     * 2   China     |25        |3         |
-     * 3   Belgium   |25        |1         |
-     * 4   Holland   |20        |4         |
-     * 5   undefined |undefined |undefined |
-     * 6   undefined |undefined |undefined |
-     * 7   undefined |undefined |undefined |
-     *
-     * @param index list of integers.
-     */
-    reIndex(index: number[]): void;
-    /**
-     * Delete a column from the table (if it exists).
-     * @param column
-     */
-    deleteColumn(column: ITidyColumn | string): boolean;
-    /**
-     * Keep a subset of columns from the table.
-     * @param columns list of columns, note that the length of each column must be the same as the number of rows
-     * in the table. Duplicates will be ignored. Columns with the same name get an index added to the name.
-     */
-    setColumns(columns: ITidyColumn[]): void;
-    /**
-     * Create a new column. The column is not added to the table.
-     * @param name name of the column.
-     * @param values cell values for the column.
-     * @param type if undefined, the type is inferred. Note that the provided type is not checked against the values
-     * for speed. Be sure that the type you set is correct to prevent unexpected behaviour.
-     */
-    createColumn<T>(name: string, values: T[], type?: AllowedColumnType<T>): ITidyBaseColumn<T>;
-    createTable(): ITidyTable;
-    /**
-     * Returns a new table with the original columns and rows filtered and in a new order.
-     * It leaves the original table intact.
-     *
-     * cols : [2,1,4]  -> 3 columns in a new order
-     * rowIdx:[55,2,3,5] -> 4 rows in a new order
-     */
-    createFilteredTable(colIdx: number[] | undefined, rowIdx: number[] | undefined): ITidyTable;
-    /**
-     * Print the table as a markdown table (e.g., used for internal documentation).
-     */
-    toMarkdown(): string;
-    /**
-     * Return the values of the tidy table (debugging purpose).
-     *
-     * @param order how to structure the array, default = column-major.
-     *     Say the table has n rows and m columns, then
-     *     > row-major - returns an array of row-values
-     *         [
-     *            [val11, val12, ..., val1m],
-     *            [val21, val22, ..., val2m],
-     *            ...,
-     *            [valn1, valn2, ..., valnm]
-     *         ]
-     *
-     *     > column-major - returns an array of column-values
-     *         [
-     *            [val11, val21, ..., valn1],
-     *            [val21, val22, ..., valn2],
-     *            ...,
-     *            [valm1, valm2, ..., valnm]
-     *         ]
-     */
-    getValues(order?: "row-major" | "column-major"): ReadonlyArray<ReadonlyArray<any>>;
-    /**
-     * Add a tag, name combination to the mapping
-     * @param tag name, mapping, role, etc..
-     * @param identifier name of the column in the table. Not exist = error.
-     */
-    addToColumnIndex(tag: string, identifier: string | number): void;
-    /**
-     * Add a new index to the existing index, overwriting what already exists.
-     */
-    addColumnIndex(index: TidyColumnIndex): void;
-    /**
-     * The limit used when lazy search is enabled.
-     */
-    getLazySearchLimit(): number | undefined;
-    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
-     */
-    toHistogram(context: IPublicContext, valueCol: ITidyBaseColumnReadonly<number | null>, groupCol: ITidyColumn | undefined, options: TidyHistogramOptions): 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;
-    /**
-     * Mark these rows as total rows in the table.
-     * @param totalRows
-     */
-    setTotalRows(totalRows: (rowIdx: number) => boolean): void;
-    /**
-     * Get a column by its role as defined in the mdxBuilderSettings.
-     * @param role name of the axis-role
-     */
-    getOptionalColumnByRole(role: string): ITidyUnknownColumn | undefined;
-    /**
-     * Pivot Table
-     * @param nodeInfo
-     */
-    getLevelDepthR(nodeInfo: MdxNodeIdentifier): any;
-    hasMdxChildren(nodeInfo: MdxNodeIdentifier): boolean;
-    isLeaf(nodeInfo: MdxNodeIdentifier): boolean;
-    /**
-     * 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;
-    /**
-     * Returns true if and only if the table is truncated by the server (too many rows otherwise).
-     */
-    reachedMaxTidyRowCount(): boolean;
-    /**
-     * Some MDX queries return headers that have a hierarchy. This function returns the number of header rows.
-     * For example, the table below has two headers.
-     *
-     *     2020 |         | 2021      |
-     *     car  | bike    | car       | bike
-     *   -------------------------------------
-     *     40   | 50      | 55        | 35
-     *
-     */
-    getTopHeaderHierarchyCount(): number;
-    /**
-     * Clear the index. Use for resetting sorting / filtering.
-     */
-    resetIndex(): void;
-}

package/dist/PublicTidyTable.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=PublicTidyTable.js.map

package/dist/PublicTidyTable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PublicTidyTable.js","sourceRoot":"","sources":["../src/PublicTidyTable.ts"],"names":[],"mappings":""}