svg-table 0.0.2 → 0.1.1

package/dist/TableFormatter.js

@@ -92,6 +92,9 @@ var TableFormatter = /** @class */ (function () {
      * @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
@@ -135,14 +138,68 @@ var TableFormatter = /** @class */ (function () {
             .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, formatter, priority);
+        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.slice().shift();
+            var columnIndex = columnIndexes.shift();
             if (columnIndex != null) {
                 return tableFormatter
                     .addColumnFormatter(columnIndex, formatter, priority)
@@ -151,12 +208,114 @@ var TableFormatter = /** @class */ (function () {
         }
         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);
@@ -173,21 +332,132 @@ var TableFormatter = /** @class */ (function () {
         }
         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, formatter, priority);
+        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.slice().shift()) !== null && _a !== void 0 ? _a : [undefined, undefined], 2), columnIndex = _b[0], rowIndex = _b[1];
+            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)
@@ -266,10 +536,21 @@ var TableFormatter = /** @class */ (function () {
     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
+        var formattedDataFrame = this
+            .dataFrame
             .mapElements(function (elem, row, col) {
             var tags = _this.dataFrame
                 .tagsFor(row, col)

package/dist/TableFormatter.js.map

@@ -1 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;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,4CAAmB,GAAnB,UAAoB,aAA4B,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAC3F,OAAO,cAAc,CAAC,mBAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACvF,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,CAAC,KAAK,EAAE,CAAA;YACjD,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,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,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,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,0CAAiB,GAAjB,UAAkB,WAA0C,EAAE,SAAuB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QACvG,OAAO,cAAc,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACnF,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,CAAC,KAAK,EAAE,mCAAI,CAAC,SAAS,EAAE,SAAS,CAAC,IAAA,EAA9E,WAAW,QAAA,EAAE,QAAQ,QAAyD,CAAA;YACrF,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,wCAAe,GAAf,UAAgE,MAA2C;QAA3G,iBAyBC;QAxBG,IAAM,kBAAkB,GAAkB,EAAE,CAAA;QAC5C,IAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS;aACpC,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,AAhQD,IAgQC;AAhQY,wCAAc"}
+{"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"}

package/dist/TableStyler.d.ts

@@ -1,7 +1,7 @@
 import { TableData } from "./TableData";
 import { DataFrame } from "data-frame-ts";
 import { type Result } from "result-fn";
-import { type Background, type Border, type CellStyle, type ColumnHeaderStyle, type ColumnStyle, type Dimension, type FooterStyle, type Padding, type RowHeaderStyle, type RowStyle, type Styling, type TableFont, type TableStylerProps, Margin } from "./stylings";
+import { type Background, type Border, type CellStyle, type ColumnHeaderStyle, type ColumnStyle, type Dimension, type FooterStyle, Margin, type Padding, type RowHeaderStyle, type RowStyle, type Styling, type TableFont, type TableStylerProps } from "./stylings";
 /**
  * Represents a table with applied styles.
  * Provides methods to access the styling information for different parts of the table.
@@ -76,8 +76,20 @@ export declare class StyledTable<V> {
      * @private
      */
     private rowTagsFor;
+    /**
+     * Checks if the table has a row header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     hasRowHeader(): boolean;
+    /**
+     * Checks if the table has a column header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     hasColumnHeader(): boolean;
+    /**
+     * Checks if the table has a footer header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     hasFooter(): boolean;
     /**
      * Gets the style for the row header.
@@ -89,6 +101,10 @@ export declare class StyledTable<V> {
      * @returns A Result containing the column header style if found, or an error message
      */
     columnHeaderStyle(): Result<Styling<ColumnHeaderStyle>, string>;
+    /**
+     * Gets the style for the footer.
+     * @returns A Result containing the footer style if found, or an error message
+     */
     footerStyle(): Result<Styling<FooterStyle>, string>;
     /**
      * Gets the style for a specific row.
@@ -194,6 +210,14 @@ export declare class TableStyler<V> {
      * @returns A new TableStyler instance with updated properties
      */
     update(properties: Partial<TableStylerProps<V>>): TableStyler<V>;
+    /**
+     * Applies the specified font settings for the table and returns a new {@link TableStyler}
+     * instance with the updated font configuration.
+     *
+     * @param font - The font configuration to be applied. This object can include partial
+     * properties of the TableFont.
+     * @return A new {@link TableStyler} instance with the updated font settings.
+     */
     withTableFont(font: Partial<TableFont>): TableStyler<V>;
     /**
      * Sets the background for the table.
@@ -277,6 +301,17 @@ export declare class TableStyler<V> {
      * @returns A new TableStyler instance with the row style applied
      */
     withRowStyle(rowIndex: number, rowStyle: Partial<RowStyle>, priority?: number): TableStyler<V>;
+    /**
+     * Applies specific styles to rows in a table based on the provided row indexes.
+     *
+     * @param rowIndexes - An array of row indexes to which the styles will be applied. If the
+     * array is empty, all rows will be styled.
+     * @param rowStyle - An object representing the styles to apply to the specified rows.
+     * @param [priority=0] - An optional priority value for the styles. Higher priority values
+     * override lower ones.
+     * @return A new TableStyler instance with the specified row styles applied.
+     * @see withRowStyle
+     */
     withRowStyles(rowIndexes: Array<number>, rowStyle: Partial<RowStyle>, priority?: number): TableStyler<V>;
     private static withRowStyles;
     /**
@@ -288,6 +323,16 @@ export declare class TableStyler<V> {
      * @returns A new TableStyler instance with the column style applied
      */
     withColumnStyle(columnIndex: number, columnStyle: Partial<ColumnStyle>, priority?: number): TableStyler<V>;
+    /**
+     * Applies specified styles to the columns of a table.
+     *
+     * @param columnIndexes - Array of column indexes to which the style should be applied. If the array
+     * is empty, styles will be applied to all columns.
+     * @param columnStyle - Partial column style configuration object defining the styles to be applied.
+     * @param [priority=0] - Optional priority value to determine the precedence of this style over others.
+     * @return Returns an instance of TableStyler with the updated column styles applied.
+     * @see withColumnStyle
+     */
     withColumnStyles(columnIndexes: Array<number>, columnStyle: Partial<ColumnStyle>, priority?: number): TableStyler<V>;
     private static withColumnStyles;
     /**
@@ -300,6 +345,16 @@ export declare class TableStyler<V> {
      * @returns A new TableStyler instance with the cell style applied
      */
     withCellStyle(rowIndex: number, columnIndex: number, cellStyle: Partial<CellStyle>, priority?: number): TableStyler<V>;
+    /**
+     * Sets the style for a specific cell based on a predicate.
+     * @param predicate A function that accepts the value, row-index, and column-index of the cell, and
+     * returns `true` if the cell should be styled, or `false` otherwise.
+     * @param cellStyle The style to apply to the cell if the predicate is `true`.
+     * @param priority The style's priority. Higher priority values override lower ones.
+     * @returns A new TableStyler instance with the cell style applied.
+     * @see withCellStyle
+     * @see withCellStyles
+     */
     withCellStyleWhen(predicate: (value: V, rowIndex: number, columnIndex: number) => boolean, cellStyle: Partial<CellStyle>, priority?: number): TableStyler<V>;
     /**
      * Finalizes the styling process and creates a StyledTable instance.

package/dist/TableStyler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TableStyler.d.ts","sourceRoot":"","sources":["../TableStyler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAmC,SAAS,EAAyC,MAAM,eAAe,CAAC;AAClH,OAAO,EAAgB,KAAK,MAAM,EAAgB,MAAM,WAAW,CAAC;AACpE,OAAO,EACH,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAYhB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,OAAO,EAGZ,KAAK,SAAS,EACd,KAAK,gBAAgB,EACU,MAAM,EACxC,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC;IAalB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAjB3B;;;;;;;;;OASG;gBAEkB,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EACvB,IAAI,EAAE,SAAS,EACf,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM;IAInC;;OAEG;IACH,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;IAIpB,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC;IAKzB;;;OAGG;IACH,SAAS,IAAI,SAAS;IAItB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;OAGG;IACH,eAAe,IAAI,UAAU;IAI7B;;;OAGG;IACH,eAAe,IAAI,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAItD;;;OAGG;IACH,YAAY,IAAI,OAAO;IAIvB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAkBrB;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAkBlB,YAAY,IAAI,OAAO;IAIvB,eAAe,IAAI,OAAO;IAI1B,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,cAAc,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IASzD;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAS/D,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IASnD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMhE;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAMzE;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAkBvF;;;;;;;;;;;;;;;;;OAiBG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;IAqB1F;;;;;;;;;;;;;;;OAeG;IACH,yBAAyB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;CAoF9F;AAED;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC;IAclB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,MAAM;IAnB3B;;;;;;;;;;OAUG;IACH,OAAO;IAYP;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAIhE;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAIhE;;;OAGG;IACH,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;IAatB;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAsBhE,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMvD;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMpE;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMnD;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IAM7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMtD;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMnD;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM;IAQd;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IAQjB;;;;;;OAMG;IACH,qBAAqB,CACjB,iBAAiB,GAAE,OAAO,CAAC,iBAAiB,CAA4B,EACxE,QAAQ,GAAE,MAAiB,GAC5B,WAAW,CAAC,CAAC,CAAC;IAejB;;;;;;OAMG;IACH,kBAAkB,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,GAAE,MAAiB,GAAG,WAAW,CAAC,CAAC,CAAC;IAWxG;;;;;;OAMG;IACH,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAE,MAAiB,GAAG,WAAW,CAAC,CAAC,CAAC;IAY/F;;;;;;;OAOG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAajG,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAK3G,OAAO,CAAC,MAAM,CAAC,aAAa;IAgB5B;;;;;;;OAOG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAa7G,gBAAgB,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAKvH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAgB/B;;;;;;;;OAQG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAoBzH,iBAAiB,CACb,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,EACvE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAC7B,QAAQ,GAAE,MAAU,GACrB,WAAW,CAAC,CAAC,CAAC;IAWjB;;;OAGG;IACH,UAAU,IAAI,WAAW,CAAC,CAAC,CAAC;CAc/B"}
+{"version":3,"file":"TableStyler.d.ts","sourceRoot":"","sources":["../TableStyler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAmC,SAAS,EAAyC,MAAM,eAAe,CAAC;AAClH,OAAO,EAAgB,KAAK,MAAM,EAAgB,MAAM,WAAW,CAAC;AACpE,OAAO,EACH,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAahB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,MAAM,EACN,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,OAAO,EAGZ,KAAK,SAAS,EACd,KAAK,gBAAgB,EAExB,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC;IAalB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAjB3B;;;;;;;;;OASG;gBAEkB,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EACvB,IAAI,EAAE,SAAS,EACf,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM;IAInC;;OAEG;IACH,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;IAIpB,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC;IAKzB;;;OAGG;IACH,SAAS,IAAI,SAAS;IAItB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;OAGG;IACH,eAAe,IAAI,UAAU;IAI7B;;;OAGG;IACH,eAAe,IAAI,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAItD;;;OAGG;IACH,YAAY,IAAI,OAAO;IAIvB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAkBrB;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAkBlB;;;OAGG;IACH,YAAY,IAAI,OAAO;IAIvB;;;OAGG;IACH,eAAe,IAAI,OAAO;IAI1B;;;OAGG;IACH,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,cAAc,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IASzD;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAS/D;;;OAGG;IACH,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IASnD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMhE;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAMzE;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAkBvF;;;;;;;;;;;;;;;;;OAiBG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;IAqB1F;;;;;;;;;;;;;;;OAeG;IACH,yBAAyB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;CAoF9F;AAED;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC;IAclB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,MAAM;IAnB3B;;;;;;;;;;OAUG;IACH,OAAO;IAYP;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAIhE;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAIhE;;;OAGG;IACH,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;IAatB;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAsBhE;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMvD;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMpE;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMnD;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IAM7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMtD;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAMnD;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM;IAQd;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IAQjB;;;;;;OAMG;IACH,qBAAqB,CACjB,iBAAiB,GAAE,OAAO,CAAC,iBAAiB,CAA4B,EACxE,QAAQ,GAAE,MAAiB,GAC5B,WAAW,CAAC,CAAC,CAAC;IAejB;;;;;;OAMG;IACH,kBAAkB,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,GAAE,MAAiB,GAAG,WAAW,CAAC,CAAC,CAAC;IAWxG;;;;;;OAMG;IACH,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAE,MAAiB,GAAG,WAAW,CAAC,CAAC,CAAC;IAY/F;;;;;;;OAOG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAajG;;;;;;;;;;OAUG;IACH,aAAa,CACT,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,EACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAC3B,QAAQ,GAAE,MAAU,GACrB,WAAW,CAAC,CAAC,CAAC;IAOjB,OAAO,CAAC,MAAM,CAAC,aAAa;IAgB5B;;;;;;;OAOG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAa7G;;;;;;;;;OASG;IACH,gBAAgB,CACZ,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,EAC5B,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,EACjC,QAAQ,GAAE,MAAU,GACrB,WAAW,CAAC,CAAC,CAAC;IAOjB,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAgB/B;;;;;;;;OAQG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAoBzH;;;;;;;;;OASG;IACH,iBAAiB,CACb,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,EACvE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAC7B,QAAQ,GAAE,MAAU,GACrB,WAAW,CAAC,CAAC,CAAC;IAWjB;;;OAGG;IACH,UAAU,IAAI,WAAW,CAAC,CAAC,CAAC;CAc/B"}

package/dist/TableStyler.js

@@ -142,12 +142,24 @@ var StyledTable = /** @class */ (function () {
         }
         return (0, result_fn_1.successResult)(tags[0]);
     };
+    /**
+     * Checks if the table has a row header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     StyledTable.prototype.hasRowHeader = function () {
         return TableData_1.TableData.hasRowHeader(this.dataFrame);
     };
+    /**
+     * Checks if the table has a column header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     StyledTable.prototype.hasColumnHeader = function () {
         return TableData_1.TableData.hasColumnHeader(this.dataFrame);
     };
+    /**
+     * Checks if the table has a footer header.
+     * @returns `true` if the table has a row header, `false` otherwise
+     */
     StyledTable.prototype.hasFooter = function () {
         return TableData_1.TableData.hasFooter(this.dataFrame);
     };
@@ -175,6 +187,10 @@ var StyledTable = /** @class */ (function () {
             .rowTagsFor(0, stylings_1.TableStyleType.COLUMN_HEADER)
             .map(function (tag) { return tag.value; });
     };
+    /**
+     * Gets the style for the footer.
+     * @returns A Result containing the footer style if found, or an error message
+     */
     StyledTable.prototype.footerStyle = function () {
         if (!TableData_1.TableData.hasFooter(this.dataFrame)) {
             return (0, result_fn_1.failureResult)("(StyledTable::footerStyle) The table data does not have a footer");
@@ -398,6 +414,14 @@ var TableStyler = /** @class */ (function () {
         var _a = properties.dataFrame, dataFrame = _a === void 0 ? this.dataFrame : _a, _b = properties.font, font = _b === void 0 ? this.font : _b, _c = properties.border, border = _c === void 0 ? this.border : _c, _d = properties.background, background = _d === void 0 ? this.background : _d, _e = properties.dimension, dimension = _e === void 0 ? this.dimension : _e, _f = properties.padding, padding = _f === void 0 ? this.padding : _f, _g = properties.margin, margin = _g === void 0 ? this.margin : _g;
         return new TableStyler(dataFrame, font, border, background, dimension, padding, margin, this.errors);
     };
+    /**
+     * Applies the specified font settings for the table and returns a new {@link TableStyler}
+     * instance with the updated font configuration.
+     *
+     * @param font - The font configuration to be applied. This object can include partial
+     * properties of the TableFont.
+     * @return A new {@link TableStyler} instance with the updated font settings.
+     */
     TableStyler.prototype.withTableFont = function (font) {
         var builder = this.copy();
         builder.font = __assign(__assign({}, stylings_1.defaultTableFont), font);
@@ -561,9 +585,22 @@ var TableStyler = /** @class */ (function () {
             .tagRow(rowIndex, stylings_1.TableStyleType.ROW, (0, stylings_1.stylingFor)(rowStyle, stylings_1.defaultRowStyle, priority))
             .getOrElse(this);
     };
+    /**
+     * Applies specific styles to rows in a table based on the provided row indexes.
+     *
+     * @param rowIndexes - An array of row indexes to which the styles will be applied. If the
+     * array is empty, all rows will be styled.
+     * @param rowStyle - An object representing the styles to apply to the specified rows.
+     * @param [priority=0] - An optional priority value for the styles. Higher priority values
+     * override lower ones.
+     * @return A new TableStyler instance with the specified row styles applied.
+     * @see withRowStyle
+     */
     TableStyler.prototype.withRowStyles = function (rowIndexes, rowStyle, priority) {
         if (priority === void 0) { priority = 0; }
-        var indexes = rowIndexes.length > 0 ? rowIndexes : new Array(this.dataFrame.rowCount()).fill(0).map(function (_, i) { return i; });
+        var indexes = rowIndexes.length > 0 ?
+            rowIndexes :
+            new Array(this.dataFrame.rowCount()).fill(0).map(function (_, i) { return i; });
         return TableStyler.withRowStyles(this, indexes, rowStyle, priority);
     };
     TableStyler.withRowStyles = function (tableStyler, rowIndexes, rowStyle, priority) {
@@ -596,9 +633,21 @@ var TableStyler = /** @class */ (function () {
             .tagColumn(columnIndex, stylings_1.TableStyleType.COLUMN, (0, stylings_1.stylingFor)(columnStyle, stylings_1.defaultColumnStyle, priority))
             .getOrElse(this);
     };
+    /**
+     * Applies specified styles to the columns of a table.
+     *
+     * @param columnIndexes - Array of column indexes to which the style should be applied. If the array
+     * is empty, styles will be applied to all columns.
+     * @param columnStyle - Partial column style configuration object defining the styles to be applied.
+     * @param [priority=0] - Optional priority value to determine the precedence of this style over others.
+     * @return Returns an instance of TableStyler with the updated column styles applied.
+     * @see withColumnStyle
+     */
     TableStyler.prototype.withColumnStyles = function (columnIndexes, columnStyle, priority) {
         if (priority === void 0) { priority = 0; }
-        var indexes = columnIndexes.length > 0 ? columnIndexes : new Array(this.dataFrame.columnCount()).fill(0).map(function (_, i) { return i; });
+        var indexes = columnIndexes.length > 0 ?
+            columnIndexes :
+            new Array(this.dataFrame.columnCount()).fill(0).map(function (_, i) { return i; });
         return TableStyler.withColumnStyles(this, indexes, columnStyle, priority);
     };
     TableStyler.withColumnStyles = function (tableStyler, columnIndexes, columnStyle, priority) {
@@ -640,6 +689,16 @@ var TableStyler = /** @class */ (function () {
             // when failed, return this (unmodified) builder
             .getOrElse(this);
     };
+    /**
+     * Sets the style for a specific cell based on a predicate.
+     * @param predicate A function that accepts the value, row-index, and column-index of the cell, and
+     * returns `true` if the cell should be styled, or `false` otherwise.
+     * @param cellStyle The style to apply to the cell if the predicate is `true`.
+     * @param priority The style's priority. Higher priority values override lower ones.
+     * @returns A new TableStyler instance with the cell style applied.
+     * @see withCellStyle
+     * @see withCellStyles
+     */
     TableStyler.prototype.withCellStyleWhen = function (predicate, cellStyle, priority) {
         var _this = this;
         if (priority === void 0) { priority = 0; }