svg-table 0.0.1 → 0.1.0

package/dist/TableFormatter.js

@@ -0,0 +1,579 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableFormatter = exports.TableFormatterType = void 0;
+exports.defaultFormatter = defaultFormatter;
+exports.defaultFormatting = defaultFormatting;
+exports.isFormattingTag = isFormattingTag;
+var result_fn_1 = require("result-fn");
+var TableData_1 = require("./TableData");
+/**
+ * Default formatter that converts a {@link value} of type `V` to a string
+ * @param value The value to convert
+ * @return a string representation of the {@link value}
+ */
+function defaultFormatter(value) {
+    return value === undefined || value === null ? '' : "".concat(value);
+}
+function defaultFormatting() {
+    return {
+        formatter: (defaultFormatter),
+        priority: 0
+    };
+}
+var TableFormatterType;
+(function (TableFormatterType) {
+    TableFormatterType["CELL"] = "cell-formatter";
+    TableFormatterType["COLUMN"] = "column-formatter";
+    TableFormatterType["ROW"] = "row-formatter";
+})(TableFormatterType || (exports.TableFormatterType = TableFormatterType = {}));
+function isFormattingTag(tag) {
+    return (tag.name === TableFormatterType.COLUMN ||
+        tag.name === TableFormatterType.ROW ||
+        tag.name === TableFormatterType.CELL) &&
+        tag.value.hasOwnProperty("formatter") &&
+        tag.value.hasOwnProperty("priority");
+}
+/**
+ * Represents a formatter used to apply row, column, and cell formatting to a data table.
+ * This class is used to define custom formatters for specific rows, columns, or cells,
+ * with support for priority-based selection of formatters.
+ */
+var TableFormatter = /** @class */ (function () {
+    /**
+     * @param dataFrame A data-frame that will be tagged with the row, column, and
+     * cell formatters.
+     * @private
+     */
+    function TableFormatter(dataFrame) {
+        this.dataFrame = dataFrame;
+    }
+    /**
+     * Constructs a new {@link TableFormatter} from a {@link TableData} object. Underneath,
+     * this factory method merely unwraps the {@link DataFrame} from the {@link TableData}
+     * and hands it to the constructor.
+     * @param tableData The table data object from which to construct the table formatter
+     * @return A new {@link TableFormatter} based on the {@link TableData}
+     * @see TableFormatter.fromDataFrame
+     */
+    TableFormatter.fromTableData = function (tableData) {
+        return new TableFormatter(tableData.unwrapDataFrame());
+    };
+    /**
+     * Constructs a new {@link TableFormatter} from a {@link DataFrame} object
+     * @param dataFrame The data-frame object from which to construct the table formatter
+     * @return A new {@link TableFormatter} based on the {@link DataFrame}
+     @see TableFormatter.fromTableData
+     */
+    TableFormatter.fromDataFrame = function (dataFrame) {
+        return new TableFormatter(dataFrame.copy());
+    };
+    /**
+     * Formatters convert the column value types to formatted strings. The formatter used to format a given
+     * cell depends on the priority of each formatter associated with that cell. The formatter with the
+     * highest priority is used. If two or more formatters for a given cell have the same priority, the selected
+     * formatter is indeterminant.
+     * @param columnIndex The index of the column to which to add the formatter
+     * @param formatter The formatter
+     * @param [priority = 0] The priority of this formatter. If cells have more than one associated formatter,
+     * the one with the highest priority number is used.
+     * @see addColumnFormatters
+     * @see addRowFormatter
+     * @see addRowFormatters
+     * @example
+     * ```typescript
+     * // create the data
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     *
+     * // create the table-data object from the data, and then hand the table-data
+     * // to the table formatter, add column formats, and format the table, getting
+     * // back a new TableData<string>
+     * const tableData: TableData<string> = TableData.fromDataFrame<string | number | Date>(data)
+     *     // from the table-data, create a table-formatter
+     *     .flatMap(tableData => createTableFormatterFrom(tableData)
+     *         // add a column formatter for the first column of dates
+     *         .addColumnFormatter(0, value => (value as Date).toLocaleDateString())
+     *         // add a column formatter to the second column of number
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => defaultFormatter(value)))
+     *         // add a column formatter to the fourth column of currencies
+     *         .flatMap(tf => tf.addColumnFormatter(3, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `${(value as number).toFixed(0)}`))
+     *         // format the table into a new TableData<string> object
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * // we expect the data-frame in the table data to be the following
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '$ 123.45', '4'],
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'GNM-H234', '$ 3.65', '40'],
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '9'],
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addColumnFormatter = function (columnIndex, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return this.dataFrame
+            .tagColumn(columnIndex, TableFormatterType.COLUMN, { formatter: formatter, priority: priority })
+            .map(function (data) { return new TableFormatter(data); });
+    };
+    /**
+     * Adds formatters to specified column indexes in a table formatter.
+     *
+     * @param columnIndexes An array of column indexes to which the formatter will be applied.
+     * @param formatter The formatting function to apply to the specified columns.
+     * @param [priority = 0] The priority level for the formatter. Higher priority formatters are applied first.
+     * @return A result indicating the success or failure of adding the column formatters.
+     * @see addColumnFormatter
+     * @see addRowFormatter
+     * @see addRowFormatters
+     * @see addCellFormatter
+     * @see addCellFormatters
+     *
+     * @example
+     * ```typescript
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     * const columnHeader = ['Date-Time', 'Customer ID', 'Product ID', 'Purchase Price', 'Amount']
+     * const rowHeader = [1, 2, 3, 4]
+     *
+     * const tableData = TableData.fromDataFrame<string | number | Date>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(td => td.withRowHeader(rowHeader))
+     *     .flatMap(tableData => TableFormatter.fromTableData(tableData)
+     *         // add the default formatter for the column header, at the highest priority so that
+     *         // it is the one that applies to the row representing the column header
+     *         .addRowFormatters([0], defaultFormatter, Infinity)
+     *         // add the default formatter for the row header, at the highest priority so that
+     *         // it is the one that applies to the column representing the row header
+     *         .flatMap(tf => tf.addColumnFormatters([0], defaultFormatter, Infinity))
+     *         // add the column formatters for each column at the default (lowest) priority
+     *         // (notice that the columns are shifted by one for the columns because the row-header
+     *         // occupies the first column (index=0))
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => (value as Date).toLocaleDateString()))
+     *         .flatMap(tf => tf.addColumnFormatter(2, value => defaultFormatter(value)))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(5, value => `${(value as number).toFixed(0)}`))
+     *         // format the table data and get back a TableData<string>
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '$ 123.45', '4'],
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'gnm-h234', '$ 3.65', '40'],
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '9'],
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addColumnFormatters = function (columnIndexes, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return TableFormatter.addColumnFormatters(this, columnIndexes.slice(), formatter, priority);
+    };
+    TableFormatter.addColumnFormatters = function (tableFormatter, columnIndexes, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        if (columnIndexes.length > 0) {
+            var columnIndex = columnIndexes.shift();
+            if (columnIndex != null) {
+                return tableFormatter
+                    .addColumnFormatter(columnIndex, formatter, priority)
+                    .flatMap(function (tf) { return TableFormatter.addColumnFormatters(tf, columnIndexes, formatter, priority); });
+            }
+        }
+        return (0, result_fn_1.successResult)(tableFormatter);
+    };
+    /**
+     * Formatters convert the row value types to formatted strings. The formatter used to format each cell in
+     * a given row depends on the priority of each formatter associated with that cell. The formatter with the
+     * highest priority is used. If two or more formatters for a given cell have the same priority, the selected
+     * formatter is indeterminant.
+     * @param rowIndex The index of the row to which to add the formatter
+     * @param formatter The formatter
+     * @param [priority = 0] The priority of this formatter. If cells have more than one associated formatter,
+     * the one with the highest priority number is used.
+     * @see addColumnFormatter
+     * @see addColumnFormatters
+     * @see addRowFormatters
+     * @example
+     * ```typescript
+     * // create the data
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     *
+     * // create the table-data object from the data, and then hand the table-data
+     * // to the table formatter, add column formats, and format the table, getting
+     * // back a new TableData<string>
+     * const tableData: TableData<string> = TableData.fromDataFrame<string | number | Date>(data)
+     *     // from the table-data, create a table-formatter
+     *     .flatMap(tableData => createTableFormatterFrom(tableData)
+     *         // add a column formatter for the first column of dates
+     *         .addColumnFormatter(0, value => (value as Date).toLocaleDateString())
+     *         // add a column formatter to the second column of number
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => defaultFormatter(value)))
+     *         // add a column formatter to the fourth column of currencies
+     *         .flatMap(tf => tf.addColumnFormatter(3, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `${(value as number).toFixed(0)}`))
+     *         // format the table into a new TableData<string> object
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * // we expect the data-frame in the table data to be the following
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '$ 123.45', '4'],
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'GNM-H234', '$ 3.65', '40'],
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '9'],
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addRowFormatter = function (rowIndex, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return this.dataFrame
+            .tagRow(rowIndex, TableFormatterType.ROW, { formatter: formatter, priority: priority })
+            .map(function (data) { return new TableFormatter(data); });
+    };
+    /**
+     * Adds formatters to specified row indexes in a table formatter.
+     *
+     * @param rowIndexes An array of row indexes to which the formatter will be applied.
+     * @param formatter The formatting function to apply to the specified columns.
+     * @param [priority = 0] The priority level for the formatter. Higher priority formatters are applied first.
+     * @return A result indicating the success or failure of adding the row formatters.
+     * @see addColumnFormatter
+     * @see addRowFormatter
+     * @see addRowFormatters
+     * @see addCellFormatter
+     * @see addCellFormatters
+     * @example
+     * ```typescript
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     * const columnHeader = ['Date-Time', 'Customer ID', 'Product ID', 'Purchase Price', 'Amount']
+     * const rowHeader = [1, 2, 3, 4]
+     *
+     * const tableData = TableData.fromDataFrame<string | number | Date>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(td => td.withRowHeader(rowHeader))
+     *     .flatMap(tableData => TableFormatter.fromTableData(tableData)
+     *         // add the default formatter for the column header, at the highest priority so that
+     *         // it is the one that applies to the row representing the column header
+     *         .addRowFormatters([0], defaultFormatter, Infinity)
+     *         // add the default formatter for the row header, at the highest priority so that
+     *         // it is the one that applies to the column representing the row header
+     *         .flatMap(tf => tf.addColumnFormatters([0], defaultFormatter, Infinity))
+     *         // add the column formatters for each column at the default (lowest) priority
+     *         // (notice that the columns are shifted by one for the columns because the row-header
+     *         // occupies the first column (index=0))
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => (value as Date).toLocaleDateString()))
+     *         .flatMap(tf => tf.addColumnFormatter(2, value => defaultFormatter(value)))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(5, value => `${(value as number).toFixed(0)}`))
+     *         // format the table data and get back a TableData<string>
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '$ 123.45', '4'],
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'gnm-h234', '$ 3.65', '40'],
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '9'],
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addRowFormatters = function (rowIndexes, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return TableFormatter.addRowFormatters(this, rowIndexes.slice(), formatter, priority);
+    };
+    TableFormatter.addRowFormatters = function (tableFormatter, rowIndexes, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        if (rowIndexes.length > 0) {
+            var rowIndex = rowIndexes.shift();
+            if (rowIndex != null) {
+                return tableFormatter
+                    .addRowFormatter(rowIndex, formatter, priority)
+                    .flatMap(function (tf) { return TableFormatter.addRowFormatters(tf, rowIndexes, formatter, priority); });
+            }
+        }
+        return (0, result_fn_1.successResult)(tableFormatter);
+    };
+    /**
+     * Adds a formatter to a specified cell based on the row and column indexes.
+     * @param rowIndex The row index of the cell.
+     * @param columnIndex The column index of the cell.
+     * @param formatter The formatter to apply to the cell.
+     * @param [priority = 0] The priority level for the formatter. Higher priority formatters are applied first.
+     * @return A result indicating the success or failure of adding the cell formatter.
+     * @see addColumnFormatter
+     * @see addRowFormatter
+     * @see addRowFormatters
+     * @see addCellFormatters
+     * @see addCellFormatters
+     * @example
+     * ```typescript
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     * const columnHeader = ['Date-Time', 'Customer ID', 'Product ID', 'Purchase Price', 'Amount']
+     * const rowHeader = [1, 2, 3, 4]
+     *
+     * const tableData = TableData.fromDataFrame<string | number | Date>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(td => td.withRowHeader(rowHeader))
+     *     .flatMap(tableData => TableFormatter.fromTableData(tableData)
+     *         // add the default formatter for the column header, at the highest priority so that
+     *         // it is the one that applies to the row representing the column header
+     *         .addRowFormatters([0], defaultFormatter, Infinity)
+     *         // add the default formatter for the row header, at the highest priority so that
+     *         // it is the one that applies to the column representing the row header
+     *         .flatMap(tf => tf.addColumnFormatters([0], defaultFormatter, Infinity))
+     *         // add the column formatters for each column at the default (lowest) priority
+     *         // (notice that the columns are shifted by one for the columns because the row-header
+     *         // occupies the first column (index=0))
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => (value as Date).toLocaleDateString()))
+     *         .flatMap(tf => tf.addColumnFormatter(2, value => defaultFormatter(value)))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(5, value => `${(value as number).toFixed(0)}`))
+     *         // override the cell formatter for a select set of cells
+     *         .flatMap(tf => tf.addCellFormatter(1, 4, value => `${(value as number).toFixed(2)}`, 1000))
+     *         .flatMap(tf => tf.addCellFormatters([[3, 5], [4, 5]], value => `${((value as number) * 10).toFixed(0)}`, 1000))
+     *         // format the table data and get back a TableData<string>
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '123.45', '4'], // overwrite (1, 4) to remove "$"
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'gnm-h234', '$ 3.65', '400'], // overwrite (3, 5) to multiply by 10
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '90'], // overwrite (4, 5) to multiply by 10
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addCellFormatter = function (rowIndex, columnIndex, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return this.dataFrame
+            .tagCell(rowIndex, columnIndex, TableFormatterType.CELL, { formatter: formatter, priority: priority })
+            .map(function (data) { return new TableFormatter(data); });
+    };
+    /**
+     * Adds formatters to specified cell indexes in a table formatter.
+     * @param cellIndexes An array of cell indexes to which the formatter will be applied.
+     * @param formatter The formatting function to apply to the specified cells.
+     * @param [priority = 0] The priority level for the formatter. Higher priority formatters are applied first.
+     * @return A result indicating the success or failure of adding the cell formatters.
+     * @see addColumnFormatter
+     * @see addRowFormatter
+     * @see addRowFormatters
+     * @see addCellFormatters
+     * @see addCellFormatters
+     * @example
+     * ```typescript
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45, 4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234', 23.45, 5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234', 3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15, 9],
+     * ]).getOrThrow()
+     * const columnHeader = ['Date-Time', 'Customer ID', 'Product ID', 'Purchase Price', 'Amount']
+     * const rowHeader = [1, 2, 3, 4]
+     *
+     * const tableData = TableData.fromDataFrame<string | number | Date>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(td => td.withRowHeader(rowHeader))
+     *     .flatMap(tableData => TableFormatter.fromTableData(tableData)
+     *         // add the default formatter for the column header, at the highest priority so that
+     *         // it is the one that applies to the row representing the column header
+     *         .addRowFormatters([0], defaultFormatter, Infinity)
+     *         // add the default formatter for the row header, at the highest priority so that
+     *         // it is the one that applies to the column representing the row header
+     *         .flatMap(tf => tf.addColumnFormatters([0], defaultFormatter, Infinity))
+     *         // add the column formatters for each column at the default (lowest) priority
+     *         // (notice that the columns are shifted by one for the columns because the row-header
+     *         // occupies the first column (index=0))
+     *         .flatMap(tf => tf.addColumnFormatter(1, value => (value as Date).toLocaleDateString()))
+     *         .flatMap(tf => tf.addColumnFormatter(2, value => defaultFormatter(value)))
+     *         .flatMap(tf => tf.addColumnFormatter(4, value => `$ ${(value as number).toFixed(2)}`))
+     *         .flatMap(tf => tf.addColumnFormatter(5, value => `${(value as number).toFixed(0)}`))
+     *         // override the cell formatter for a select set of cells
+     *         .flatMap(tf => tf.addCellFormatter(1, 4, value => `${(value as number).toFixed(2)}`, 1000))
+     *         .flatMap(tf => tf.addCellFormatters([[3, 5], [4, 5]], value => `${((value as number) * 10).toFixed(0)}`, 1000))
+     *         // format the table data and get back a TableData<string>
+     *         .flatMap(tf => tf.formatTable())
+     *     )
+     *     .getOrThrow()
+     *
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '123.45', '4'], // overwrite (1, 4) to remove "$"
+     *     ['2/2/2021', '23456', 'gnm-g234', '$ 23.45', '5'],
+     *     ['2/3/2021', '34567', 'gnm-h234', '$ 3.65', '400'], // overwrite (3, 5) to multiply by 10
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15', '90'], // overwrite (4, 5) to multiply by 10
+     * ]).getOrThrow()
+     * ```
+     */
+    TableFormatter.prototype.addCellFormatters = function (cellIndexes, formatter, priority) {
+        if (priority === void 0) { priority = 0; }
+        return TableFormatter.addCellFormatters(this, cellIndexes.slice(), formatter, priority);
+    };
+    TableFormatter.addCellFormatters = function (tableFormatter, cellIndexes, formatter, priority) {
+        var _a;
+        if (priority === void 0) { priority = 0; }
+        if (cellIndexes.length > 0) {
+            var _b = __read((_a = cellIndexes.shift()) !== null && _a !== void 0 ? _a : [undefined, undefined], 2), rowIndex = _b[0], columnIndex = _b[1];
+            if (rowIndex != null && columnIndex != null) {
+                return tableFormatter
+                    .addCellFormatter(rowIndex, columnIndex, formatter, priority)
+                    .flatMap(function (tf) { return TableFormatter.addCellFormatters(tf, cellIndexes, formatter, priority); });
+            }
+        }
+        return (0, result_fn_1.successResult)(tableFormatter);
+    };
+    /**
+     * Formats the table headers, footer, and values using the formatters that have been added
+     * to this `TableData<V>` object and returns a new `TableData<string>` object where all the
+     * elements have been converted to a formatted string.
+     * @return a new `TableData<string>` object where all the elements have been converted to a
+     * formatted string.
+     * @example
+     * ```typescript
+     * function dateTimeFor(day: number, hour: number): Date {
+     *   return new Date(2021, 1, day, hour, 0, 0, 0);
+     * }
+     *
+     * // the headers for the table
+     * const columnHeader = ['Date-Time', 'Customer ID', 'Product ID', 'Purchase Price', 'Amount']
+     * const rowHeader = [1, 2, 3, 4]
+     *
+     * // this is the actual data used to creat the data table (in row-form)
+     * const data = DataFrame.from<string | number | Date>([
+     *     [dateTimeFor(1, 1), 12345, 'gnm-f234', 123.45,  4],
+     *     [dateTimeFor(2, 2), 23456, 'gnm-g234',  23.45,  5],
+     *     [dateTimeFor(3, 3), 34567, 'gnm-h234',   3.65, 40],
+     *     [dateTimeFor(4, 4), 45678, 'gnm-i234', 314.15,  9],
+     * ]).getOrThrow()
+     *
+     * // this is what we expect that formatted data to look like
+     * const expectedData = DataFrame.from<string>([
+     *     ['2/1/2021', '12345', 'gnm-f234', '$ 123.45',  '4'],
+     *     ['2/2/2021', '23456', 'gnm-g234',  '$ 23.45',  '5'],
+     *     ['2/3/2021', '34567', 'gnm-h234',   '$ 3.65', '40'],
+     *     ['2/4/2021', '45678', 'gnm-i234', '$ 314.15',  '9'],
+     * ]).getOrThrow()
+     *
+     * // 1. create a data-table that has a column-header and a row-header and mixed-type
+     * //    data (number, string, Date)
+     * // 2. add formatters for the row and column headers (at highest priority)
+     * // 3. add formatters for some of the other data columns
+     * // 4. format the table
+     * const tableData = TableData.fromDataFrame<string | number | Date>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(table => table.withRowHeader(rowHeader))
+     *     // add the default formatter for the column header, at the highest priority so that
+     *     // it is the one that applies to the row representing the column header
+     *     .flatMap(td => td.addRowFormatter(0, defaultFormatter, Infinity))
+     *     // add the default formatter for the row header, at the highest priority so that
+     *     // it is the one that applies to the column representing the row header
+     *     .flatMap(td => td.addColumnFormatter(0, defaultFormatter, Infinity))
+     *     // add the column formatters for each column at the default (lowest) priority
+     *     // (notice that the columns are shifted by one for the columns because the row-header
+     *     // occupies the first column (index=0))
+     *     .flatMap(td => td.addColumnFormatter(1, value => (value as Date).toLocaleDateString()))
+     *     .flatMap(td => td.addColumnFormatter(2, value => defaultFormatter(value)))
+     *     .flatMap(td => td.addColumnFormatter(4, value => `$ ${(value as number).toFixed(2)}`))
+     *     .flatMap(td => td.addColumnFormatter(5, value => `${(value as number).toFixed(0)}`))
+     *     // format the table data and get back a TableData<string>
+     *     .map(td => td.formatTable())
+     *     .getOrThrow()
+     *
+     * // the column header of the formatted table should be the same as the one specified
+     * expect(tableData.columnHeader().getOrThrow()).toEqual(columnHeader)
+     *
+     * // the row header of the formatted table should be the same as the one specified
+     * expect(tableData.rowHeader().getOrThrow()).toEqual(rowHeader.map(hdr => defaultFormatter(hdr)))
+     *
+     * // the data should be equal to the expected data
+     * expect(tableData.data().map(df => df.equals(expectedData)).getOrThrow()).toBeTruthy()
+     * ```
+     */
+    TableFormatter.prototype.formatTable = function () {
+        return this.formatTableInto(function (dataFrame) { return TableData_1.TableData.fromDataFrame(dataFrame); });
+    };
+    /**
+     * Generally, the {@link TableFormatter} formats the {@link DataFrame} into a `TableData<string>`
+     * where all the elements of the {@link TableData} are a string. Because a formatted table does
+     * not necessarily have to be a `TableData<string>` (which would contain a `DataFrame<string>`,
+     * this method allows mapping a {@link DataFrame} into any desired type.
+     * @param mapper A function that takes a `DataFrame<string>` and returns a desired type (`D`).
+     * @return A `Result<D, string>` where the `Result<D, string>` is either success, containing the
+     * desired type (`D`), or failure, containing an error message.
+     * @see formatTable
+     */
+    TableFormatter.prototype.formatTableInto = function (mapper) {
+        var _this = this;
+        var formattingFailures = [];
+        var formattedDataFrame = this
+            .dataFrame
+            .mapElements(function (elem, row, col) {
+            var tags = _this.dataFrame
+                .tagsFor(row, col)
+                .filter(function (tag) { return isFormattingTag(tag); });
+            var sorted = tags
+                .sort(function (t1, t2) { return t2.value.priority - t1.value.priority; });
+            if (sorted.length > 0) {
+                var formatter = sorted[0].value.formatter;
+                try {
+                    return formatter(elem);
+                }
+                catch (e) {
+                    formattingFailures.push("(TableData::formatTable) Failed to format cell (".concat(row, ", ").concat(col, "); value: ").concat(elem, "; error: ").concat(e));
+                }
+            }
+            return defaultFormatter(elem);
+        });
+        if (formattingFailures.length === 0) {
+            return (0, result_fn_1.successResult)(mapper(formattedDataFrame));
+        }
+        return (0, result_fn_1.failureResult)(formattingFailures.concat('').join('\n'));
+    };
+    return TableFormatter;
+}());
+exports.TableFormatter = TableFormatter;
+//# sourceMappingURL=TableFormatter.js.map

package/dist/TableFormatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableFormatter.js","sourceRoot":"","sources":["../TableFormatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAcA,4CAEC;AAOD,8CAKC;AAQD,0CAMC;AAzCD,uCAAoE;AACpE,yCAAsC;AAOtC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAI,KAAQ;IACxC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAG,KAAK,CAAE,CAAA;AAClE,CAAC;AAOD,SAAgB,iBAAiB;IAC7B,OAAO;QACH,SAAS,EAAE,CAAA,gBAAmB,CAAA;QAC9B,QAAQ,EAAE,CAAC;KACd,CAAA;AACL,CAAC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,6CAAuB,CAAA;IACvB,iDAA2B,CAAA;IAC3B,2CAAqB,CAAA;AACzB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,SAAgB,eAAe,CAAC,GAAiC;IAC7D,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,MAAM;QACtC,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,GAAG;QACnC,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;QACrC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;AAC5C,CAAC;AAED;;;;GAIG;AACH;IAEI;;;;OAIG;IACH,wBAAqC,SAAuB;QAAvB,cAAS,GAAT,SAAS,CAAc;IAC5D,CAAC;IAED;;;;;;;OAOG;IACI,4BAAa,GAApB,UAAwB,SAAuB;QAC3C,OAAO,IAAI,cAAc,CAAI,SAAS,CAAC,eAAe,EAAE,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACI,4BAAa,GAApB,UAAwB,SAAuB;QAC3C,OAAO,IAAI,cAAc,CAAI,SAAS,CAAC,IAAI,EAAE,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,2CAAkB,GAAlB,UAAmB,WAAmB,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QACjF,OAAO,IAAI,CAAC,SAAS;aAChB,SAAS,CAAgB,WAAW,EAAE,kBAAkB,CAAC,MAAM,EAAE,EAAC,SAAS,WAAA,EAAE,QAAQ,UAAA,EAAC,CAAC;aACvF,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,cAAc,CAAI,IAAI,CAAC,EAA3B,CAA2B,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,4CAAmB,GAAnB,UAAoB,aAA4B,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAC3F,OAAO,cAAc,CAAC,mBAAmB,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAC/F,CAAC;IAEc,kCAAmB,GAAlC,UACI,cAAiC,EACjC,aAA4B,EAC5B,SAAuB,EACvB,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAEpB,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAM,WAAW,GAAG,aAAa,CAAC,KAAK,EAAE,CAAA;YACzC,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBACtB,OAAO,cAAc;qBAChB,kBAAkB,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC;qBACpD,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,cAAc,CAAC,mBAAmB,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,CAAC,EAA1E,CAA0E,CAAC,CAAA;YAClG,CAAC;QACL,CAAC;QACD,OAAO,IAAA,yBAAa,EAAC,cAAc,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,wCAAe,GAAf,UAAgB,QAAgB,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAC3E,OAAO,IAAI,CAAC,SAAS;aAChB,MAAM,CAAgB,QAAQ,EAAE,kBAAkB,CAAC,GAAG,EAAE,EAAC,SAAS,WAAA,EAAE,QAAQ,UAAA,EAAC,CAAC;aAC9E,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,cAAc,CAAI,IAAI,CAAC,EAA3B,CAA2B,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,yCAAgB,GAAhB,UAAiB,UAAyB,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QACrF,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACzF,CAAC;IAEc,+BAAgB,GAA/B,UACI,cAAiC,EACjC,UAAyB,EACzB,SAAuB,EACvB,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAEpB,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,EAAE,CAAA;YACnC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACnB,OAAO,cAAc;qBAChB,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;qBAC9C,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,cAAc,CAAC,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,EAApE,CAAoE,CAAC,CAAA;YAC5F,CAAC;QACL,CAAC;QACD,OAAO,IAAA,yBAAa,EAAC,cAAc,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,yCAAgB,GAAhB,UAAiB,QAAgB,EAAE,WAAmB,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QACjG,OAAO,IAAI,CAAC,SAAS;aAChB,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,kBAAkB,CAAC,IAAI,EAAE,EAAC,SAAS,WAAA,EAAE,QAAQ,UAAA,EAAC,CAAC;aAC9E,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,cAAc,CAAI,IAAI,CAAC,EAA3B,CAA2B,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,0CAAiB,GAAjB,UAAkB,WAA0C,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QACvG,OAAO,cAAc,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAC3F,CAAC;IAEc,gCAAiB,GAAhC,UACI,cAAiC,EACjC,WAA0C,EAC1C,SAAuB,EACvB,QAAoB;;QAApB,yBAAA,EAAA,YAAoB;QAEpB,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,IAAA,KAAA,OAA0B,MAAA,WAAW,CAAC,KAAK,EAAE,mCAAI,CAAC,SAAS,EAAE,SAAS,CAAC,IAAA,EAAtE,QAAQ,QAAA,EAAE,WAAW,QAAiD,CAAA;YAC7E,IAAI,QAAQ,IAAI,IAAI,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBAC1C,OAAO,cAAc;qBAChB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC;qBAC5D,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,cAAc,CAAC,iBAAiB,CAAC,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAtE,CAAsE,CAAC,CAAA;YAC9F,CAAC;QACL,CAAC;QACD,OAAO,IAAA,yBAAa,EAAC,cAAc,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,oCAAW,GAAX;QACI,OAAO,IAAI,CAAC,eAAe,CAAuB,UAAA,SAAS,IAAI,OAAA,qBAAS,CAAC,aAAa,CAAS,SAAS,CAAC,EAA1C,CAA0C,CAAC,CAAA;IAC9G,CAAC;IAED;;;;;;;;;OASG;IACH,wCAAe,GAAf,UAAgE,MAA2C;QAA3G,iBA0BC;QAzBG,IAAM,kBAAkB,GAAkB,EAAE,CAAA;QAC5C,IAAM,kBAAkB,GAAG,IAAI;aAC1B,SAAS;aACT,WAAW,CAAS,UAAC,IAAI,EAAE,GAAG,EAAE,GAAG;YAChC,IAAM,IAAI,GAAG,KAAI,CAAC,SAAS;iBACtB,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;iBACjB,MAAM,CAAC,UAAA,GAAG,IAAI,OAAA,eAAe,CAAC,GAAG,CAAC,EAApB,CAAoB,CAAiC,CAAA;YACxE,IAAM,MAAM,GAAG,IAAI;iBACd,IAAI,CAAC,UAAC,EAAyB,EAAE,EAAyB,IAAK,OAAA,EAAE,CAAC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAArC,CAAqC,CAAC,CAAA;YAC1G,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpB,IAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAA;gBAC3C,IAAI,CAAC;oBACD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAA;gBAC1B,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,kBAAkB,CAAC,IAAI,CACnB,0DAAmD,GAAG,eAAK,GAAG,uBAAa,IAAI,sBAAY,CAAC,CAAE,CACjG,CAAA;gBACL,CAAC;YACL,CAAC;YACD,OAAO,gBAAgB,CAAI,IAAI,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;QACN,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,OAAO,IAAA,yBAAa,EAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACpD,CAAC;QACD,OAAO,IAAA,yBAAa,EAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAClE,CAAC;IACL,qBAAC;AAAD,CAAC,AAzhBD,IAyhBC;AAzhBY,wCAAc"}