@ic3/reporting-api 9.0.1 → 9.1.0

package/dist/PublicAmchartsData.d.ts

@@ -1,116 +0,0 @@
-import { ITidyColorColumn, ITidyColumn, ITidyNumericColumn } from "./PublicTidyColumn";
-import { ITidyTable } from "./PublicTidyTable";
-import { GroupRowIndices, IAmCharts4Data } from "./PublicTidyTableTypes";
-export declare enum ISeriesValuesType {
-    LINE = 0,
-    COLUMN = 1,
-    TREND = 2,
-    DIVERGENT = 3,
-    LEFT_SERIES = 4,
-    RIGHT_SERIES = 5
-}
-export interface ISeriesValues {
-    type: ISeriesValuesType;
-    /**
-     * Value column.
-     * @see {PublicAmchartsData.TAG_VALUE}.
-     */
-    values: ITidyColumn;
-    /**
-     * Color column.
-     * @see {PublicAmchartsData.TAG_COLOR}.
-     */
-    colors?: ITidyColorColumn;
-    /**
-     * Extra values.
-     * @see {PublicAmchartsData.TAG_ADDITIONAL_VALUE}.
-     */
-    additionalValues?: ITidyColumn;
-    parentValueColIdx?: number;
-}
-/**
- * Used for managing amcharts data in the Amcharts plugin. This class controls both the creation of the charts
- * data and the creation of the series of that chart.
- */
-export declare class PublicAmchartsData {
-    static readonly TAG_VALUE = "v";
-    static readonly TAG_COLOR = "c";
-    static readonly TAG_ADDITIONAL_VALUE = "v2";
-    private readonly onValues;
-    private readonly onAxis;
-    private readonly onLevel;
-    private readonly onGroup;
-    private readonly table;
-    private readonly disableGroupRecords?;
-    constructor(table: ITidyTable, onValues: ISeriesValues[], onAxis: ITidyColumn, onGroup?: ITidyColumn, onLevel?: ITidyColumn, disableGroupRecords?: boolean);
-    static getSeriesId(groupKey: string, valueColIdx: number): string;
-    /**
-     * Get the data for the chart.
-     */
-    getChartData(): IAmCharts4Data[];
-    /**
-     * Create, update and remove series in the chart.
-     * @param itemControl map keeping track of current series in the chart.
-     * @param seriesControl object controlling the adding/removing/updating of series.
-     * @param firstGroupOnly only call the first group.
-     */
-    updateSeries<T>(itemControl: Map<string, T>, seriesControl: IAmchartsSeriesControl<T>, firstGroupOnly?: boolean): void;
-    getAxis(): ITidyColumn;
-    getLevel(): ITidyColumn | undefined;
-    getGroup(): ITidyColumn | undefined;
-    /**
-     * Return the nth value column.
-     * @param idx n
-     */
-    getValueColumn(idx: number): ITidyNumericColumn;
-    getValueColumns(): ITidyNumericColumn[];
-    /**
-     * Call a function on each series, and its column
-     * @param itemControl map keeping track of current series in the chart.
-     */
-    forEachSeries<T>(itemControl: Map<string, T>, callback: (col: ITidyNumericColumn, seriesId: string, series: T) => void): void;
-    /**
-     * Returns the first item in the onValues argument of the constructor.
-     */
-    getFirstValue(): ITidyNumericColumn;
-    /**
-     * Returns true if and only if multiple non-trend measures are in the chart.
-     */
-    isMultiMeasure(): boolean;
-    /**
-     * Returns the first column used for a series type.
-     */
-    getFirstColumnOfType(seriesType: ISeriesValuesType): ITidyColumn | undefined;
-}
-/**
- * Controls when to add / remove / dispose / update series. This class exists because using chart.setSeries removes
- * trend-series. This class handles the adding and removing of series and keeps the series in the order of the data.
- */
-export interface IAmchartsSeriesControl<T> {
-    /**
-     * If defined, only call create, update and remove where `typeFilter(type)` returns true.
-     */
-    typeFilter?: (type: ISeriesValuesType) => boolean;
-    /**
-     * Create a new series if it is not in itemControl. Use 'add' to add it to the chart.
-     * @param seriesId unique id of the series
-     * @param groupKey key for the group by (if defined). If not defined, use _
-     * @param valueKey series value dataField
-     * @param fillKey series fill dataField
-     * @param sValue the onValues part used.
-     */
-    create: (seriesId: string, groupKey: string, valueKey: string, fillKey: string, sValue: ISeriesValues) => T;
-    /**
-     * Update a series.
-     * @param seriesId unique id of the series
-     * @param groupKey key for the group by (if defined). If not defined, use _
-     * @param series the charts series to update
-     * @param sValue the onValues part used
-     * @param groupRows row indices of the group. Length >= 1.
-     */
-    update: (seriesId: string, groupKey: string, series: T, sValue: ISeriesValues, groupRows: GroupRowIndices) => void;
-    /**
-     * Destroy an item. Called when the item can be cleared from memory. E.g., dispose() on the series.
-     */
-    remove: (item: T) => void;
-}

package/dist/PublicAmchartsData.js

@@ -1,170 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublicAmchartsData = exports.ISeriesValuesType = void 0;
-const PublicTidyTableTypes_1 = require("./PublicTidyTableTypes");
-var ISeriesValuesType;
-(function (ISeriesValuesType) {
-    ISeriesValuesType[ISeriesValuesType["LINE"] = 0] = "LINE";
-    ISeriesValuesType[ISeriesValuesType["COLUMN"] = 1] = "COLUMN";
-    ISeriesValuesType[ISeriesValuesType["TREND"] = 2] = "TREND";
-    ISeriesValuesType[ISeriesValuesType["DIVERGENT"] = 3] = "DIVERGENT";
-    ISeriesValuesType[ISeriesValuesType["LEFT_SERIES"] = 4] = "LEFT_SERIES";
-    ISeriesValuesType[ISeriesValuesType["RIGHT_SERIES"] = 5] = "RIGHT_SERIES";
-})(ISeriesValuesType || (exports.ISeriesValuesType = ISeriesValuesType = {}));
-/**
- * Used for managing amcharts data in the Amcharts plugin. This class controls both the creation of the charts
- * data and the creation of the series of that chart.
- */
-class PublicAmchartsData {
-    constructor(table, onValues, onAxis, onGroup, onLevel, disableGroupRecords) {
-        this.onValues = onValues;
-        this.onAxis = onAxis;
-        this.onGroup = onGroup;
-        this.onLevel = onLevel;
-        this.table = table;
-        this.disableGroupRecords = disableGroupRecords;
-    }
-    static getSeriesId(groupKey, valueColIdx) {
-        return groupKey + "." + String(valueColIdx);
-    }
-    /**
-     * Get the data for the chart.
-     */
-    getChartData() {
-        const chartValues = {};
-        this.onValues.forEach((value, idx) => {
-            /*
-            Divergent series needs to have negative values, but show a positive value when hovered. Thus, the values
-            in chart data are set to negative, but the values in the column are not.
-             */
-            let valueColumn;
-            if (value.type === ISeriesValuesType.DIVERGENT) {
-                valueColumn = value.values.mapToColumn(v => v != null ? -v : null, "rightValue", PublicTidyTableTypes_1.TidyColumnsType.NUMERIC);
-            }
-            else {
-                valueColumn = value.values;
-            }
-            chartValues[String(idx) + PublicAmchartsData.TAG_VALUE] = valueColumn;
-            if (value.colors) {
-                chartValues[String(idx) + PublicAmchartsData.TAG_COLOR] = value.colors;
-            }
-            if (value.additionalValues) {
-                chartValues[String(idx) + PublicAmchartsData.TAG_ADDITIONAL_VALUE] = value.additionalValues;
-            }
-        });
-        return this.table.toAmcharts4Data(this.onAxis, chartValues, this.onGroup, this.onLevel, undefined, this.disableGroupRecords);
-    }
-    /**
-     * Create, update and remove series in the chart.
-     * @param itemControl map keeping track of current series in the chart.
-     * @param seriesControl object controlling the adding/removing/updating of series.
-     * @param firstGroupOnly only call the first group.
-     */
-    updateSeries(itemControl, seriesControl, firstGroupOnly) {
-        const group = this.onGroup;
-        const updated = new Set();
-        const forEachSeries = (groupKey, groupIdx) => {
-            this.onValues.forEach((onValue, idx) => {
-                if (seriesControl.typeFilter != null && !seriesControl.typeFilter(onValue.type)) {
-                    return;
-                }
-                const seriesKey = PublicAmchartsData.getSeriesId(groupKey, idx);
-                let item = itemControl.get(seriesKey);
-                if (item == null) {
-                    const newItem = seriesControl.create(seriesKey, groupKey, seriesKey + PublicAmchartsData.TAG_VALUE, seriesKey + PublicAmchartsData.TAG_COLOR, onValue);
-                    itemControl.set(seriesKey, newItem);
-                    item = newItem;
-                }
-                seriesControl.update(seriesKey, groupKey, item, onValue, groupIdx);
-                updated.add(seriesKey);
-            });
-        };
-        if (group != null && !this.disableGroupRecords) {
-            const index = group.groupBy(true);
-            if (firstGroupOnly) {
-                const groupIdx = index.values().next();
-                if (!groupIdx.done) {
-                    const firstIndex = groupIdx.value[0];
-                    const groupKey = group.getAmcharts4GroupKey(firstIndex);
-                    forEachSeries(groupKey, groupIdx.value);
-                }
-            }
-            else {
-                index.forEach(groupIdx => {
-                    const groupKey = group.getAmcharts4GroupKey(groupIdx[0]);
-                    forEachSeries(groupKey, groupIdx);
-                });
-            }
-        }
-        else {
-            const groupKey = PublicTidyTableTypes_1.IAmcharts4DataKey.NULL;
-            forEachSeries(groupKey, [0]);
-        }
-        itemControl.forEach((item, key) => {
-            if (!updated.has(key)) {
-                itemControl.delete(key);
-                seriesControl.remove(item);
-            }
-        });
-    }
-    getAxis() {
-        return this.onAxis;
-    }
-    getLevel() {
-        return this.onLevel;
-    }
-    getGroup() {
-        return this.onGroup;
-    }
-    /**
-     * Return the nth value column.
-     * @param idx n
-     */
-    getValueColumn(idx) {
-        return this.onValues[idx].values;
-    }
-    getValueColumns() {
-        return this.onValues.map(i => i.values);
-    }
-    /**
-     * Call a function on each series, and its column
-     * @param itemControl map keeping track of current series in the chart.
-     */
-    forEachSeries(itemControl, callback) {
-        this.updateSeries(itemControl, {
-            create: () => {
-                throw Error("SNBH series cannot be created");
-            },
-            update: (seriesId, _groupKey, series, sValue, _groupRows) => {
-                callback(sValue.values, seriesId, series);
-            },
-            remove: () => {
-                throw Error("SNBH series cannot be removed");
-            },
-            typeFilter: type => type !== ISeriesValuesType.TREND
-        }, true);
-    }
-    /**
-     * Returns the first item in the onValues argument of the constructor.
-     */
-    getFirstValue() {
-        return this.onValues[0].values;
-    }
-    /**
-     * Returns true if and only if multiple non-trend measures are in the chart.
-     */
-    isMultiMeasure() {
-        return this.onValues.filter(i => i.type !== ISeriesValuesType.TREND).length > 1;
-    }
-    /**
-     * Returns the first column used for a series type.
-     */
-    getFirstColumnOfType(seriesType) {
-        return this.onValues.find(i => i.type === seriesType)?.values;
-    }
-}
-exports.PublicAmchartsData = PublicAmchartsData;
-PublicAmchartsData.TAG_VALUE = 'v';
-PublicAmchartsData.TAG_COLOR = 'c';
-PublicAmchartsData.TAG_ADDITIONAL_VALUE = 'v2';
-//# sourceMappingURL=PublicAmchartsData.js.map

package/dist/PublicAmchartsData.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PublicAmchartsData.js","sourceRoot":"","sources":["../src/PublicAmchartsData.ts"],"names":[],"mappings":";;;AAEA,iEAA2G;AAE3G,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IACzB,yDAAI,CAAA;IACJ,6DAAM,CAAA;IACN,2DAAK,CAAA;IACL,mEAAS,CAAA;IACT,uEAAW,CAAA;IACX,yEAAY,CAAA;AAChB,CAAC,EAPW,iBAAiB,iCAAjB,iBAAiB,QAO5B;AA8BD;;;GAGG;AACH,MAAa,kBAAkB;IAa3B,YAAY,KAAiB,EAAE,QAAyB,EAAE,MAAmB,EAAE,OAAqB,EACxF,OAAqB,EAAE,mBAA6B;QAC5D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,WAAmB;QACpD,OAAO,QAAQ,GAAG,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,YAAY;QAER,MAAM,WAAW,GAAgC,EAAE,CAAC;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAEjC;;;eAGG;YACH,IAAI,WAAwB,CAAC;YAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,SAAS,EAAE,CAAC;gBAC7C,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,EAAE,sCAAe,CAAC,OAAO,CAAC,CAAC;YAC9G,CAAC;iBAAM,CAAC;gBACJ,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;YAC/B,CAAC;YAED,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;YAEtE,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBACf,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YAC3E,CAAC;YAED,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBACzB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC;YAChG,CAAC;QAEL,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAEjI,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAI,WAA2B,EAAE,aAAwC,EAAE,cAAwB;QAC3G,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAElC,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,QAAyB,EAAE,EAAE;YAClE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;gBAEnC,IAAI,aAAa,CAAC,UAAU,IAAI,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9E,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAChE,IAAI,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACtC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;oBACf,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,EACpD,SAAS,GAAG,kBAAkB,CAAC,SAAS,EACxC,SAAS,GAAG,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBACvD,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBACpC,IAAI,GAAG,OAAO,CAAC;gBACnB,CAAC;gBAED,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACnE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAE3B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,cAAc,EAAE,CAAC;gBACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACjB,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;oBACxD,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAC5C,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACrB,MAAM,QAAQ,GAAG,KAAK,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzD,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACtC,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,QAAQ,GAAG,wCAAiB,CAAC,IAAI,CAAC;YACxC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACxB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,GAAW;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,CAAC;IAED,eAAe;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,aAAa,CAAI,WAA2B,EAAE,QAAwE;QAElH,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;YAC3B,MAAM,EAAE,GAAG,EAAE;gBACT,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE;gBACxD,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACT,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACjD,CAAC;YACD,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,iBAAiB,CAAC,KAAK;SACvD,EAAE,IAAI,CAAC,CAAC;IACb,CAAC;IAED;;OAEG;IACH,aAAa;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,UAA6B;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE,MAAM,CAAC;IAClE,CAAC;;AA1LL,gDA4LC;AA1L0B,4BAAS,GAAG,GAAG,CAAC;AAChB,4BAAS,GAAG,GAAG,CAAC;AAChB,uCAAoB,GAAG,IAAI,CAAC"}

package/dist/PublicCommon.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/PublicCommon.js

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

package/dist/PublicCommon.js.map

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