svg-table 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rob Philipp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# SVG Table
+
+Docs to come.

package/d3types.ts

@@ -0,0 +1,17 @@
+// the axis-element type return when calling the ".call(axis)" function
+import type {Selection} from "d3";
+
+export type GroupSelection = Selection<SVGGElement, any, null, undefined>
+export type TextSelection = Selection<SVGTextElement, any, null, undefined>
+export type RectSelection = Selection<SVGRectElement, any, null, undefined>
+export type LineSelection = Selection<SVGLineElement, any, null, undefined>
+
+export type BorderSelection = {
+    top?: LineSelection
+    bottom?: LineSelection
+    left?: LineSelection
+    right?: LineSelection
+}
+
+
+

package/dist/d3types.d.ts

@@ -0,0 +1,12 @@
+import type { Selection } from "d3";
+export type GroupSelection = Selection<SVGGElement, any, null, undefined>;
+export type TextSelection = Selection<SVGTextElement, any, null, undefined>;
+export type RectSelection = Selection<SVGRectElement, any, null, undefined>;
+export type LineSelection = Selection<SVGLineElement, any, null, undefined>;
+export type BorderSelection = {
+    top?: LineSelection;
+    bottom?: LineSelection;
+    left?: LineSelection;
+    right?: LineSelection;
+};
+//# sourceMappingURL=d3types.d.ts.map

package/dist/d3types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"d3types.d.ts","sourceRoot":"","sources":["../d3types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,IAAI,CAAC;AAElC,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;AACzE,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;AAC3E,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;AAC3E,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;AAE3E,MAAM,MAAM,eAAe,GAAG;IAC1B,GAAG,CAAC,EAAE,aAAa,CAAA;IACnB,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,KAAK,CAAC,EAAE,aAAa,CAAA;CACxB,CAAA"}

package/dist/d3types.js

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

package/dist/d3types.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export type { GroupSelection, TextSelection, RectSelection, LineSelection, BorderSelection } from './d3types';
+export type { Styling, TableStylerProps, TableFont, Background, Padding, Margin, BorderElement, Border, Dimension, ColumnStyle, RowStyle, TextAlignment, VerticalTextAlignment, CellStyle, ColumnHeaderStyle, RowHeaderStyle, FooterStyle, Stylings, } from './stylings';
+export { stylingFor, TableStyleType, defaultTableFont, defaultTableBackground, defaultTablePadding, defaultTableMargin, defaultBorderElement, defaultBorder, defaultDimension, defaultColumnStyle, defaultRowStyle, defaultCellStyle, defaultColumnHeaderStyle, defaultRowHeaderStyle, defaultFooterStyle, } from './stylings';
+export { TableData, TableTagType } from './tableData';
+export type { Formatter, Formatting, } from './tableFormatter';
+export { defaultFormatter, defaultFormatting, TableFormatterType, isFormattingTag, TableFormatter } from './tableFormatter';
+export { StyledTable, TableStyler } from './tableStyler';
+export type { ElementPlacementInfo, TextAnchor, DominantBaseline, CellRenderingDimensions, TableRenderingInfo } from './tableSvg';
+export { elementInfoFrom, createTable, tableId, } from './tableSvg';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,cAAc,EACd,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EAClB,MAAM,WAAW,CAAA;AAElB,YAAY,EACR,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,OAAO,EACP,MAAM,EACN,aAAa,EACb,MAAM,EACN,SAAS,EACT,WAAW,EACX,QAAQ,EACR,aAAa,EACb,qBAAqB,EACrB,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,QAAQ,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,GACrB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,SAAS,EACT,YAAY,EACf,MAAM,aAAa,CAAC;AAErB,YAAY,EACR,SAAS,EACT,UAAU,GACb,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACH,WAAW,EACX,WAAW,EACd,MAAM,eAAe,CAAC;AAEvB,YAAY,EACR,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EACrB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,eAAe,EACf,WAAW,EACX,OAAO,GACV,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableId = exports.createTable = exports.elementInfoFrom = exports.TableStyler = exports.StyledTable = exports.TableFormatter = exports.isFormattingTag = exports.TableFormatterType = exports.defaultFormatting = exports.defaultFormatter = exports.TableTagType = exports.TableData = exports.defaultFooterStyle = exports.defaultRowHeaderStyle = exports.defaultColumnHeaderStyle = exports.defaultCellStyle = exports.defaultRowStyle = exports.defaultColumnStyle = exports.defaultDimension = exports.defaultBorder = exports.defaultBorderElement = exports.defaultTableMargin = exports.defaultTablePadding = exports.defaultTableBackground = exports.defaultTableFont = exports.TableStyleType = exports.stylingFor = void 0;
+var stylings_1 = require("./stylings");
+Object.defineProperty(exports, "stylingFor", { enumerable: true, get: function () { return stylings_1.stylingFor; } });
+Object.defineProperty(exports, "TableStyleType", { enumerable: true, get: function () { return stylings_1.TableStyleType; } });
+Object.defineProperty(exports, "defaultTableFont", { enumerable: true, get: function () { return stylings_1.defaultTableFont; } });
+Object.defineProperty(exports, "defaultTableBackground", { enumerable: true, get: function () { return stylings_1.defaultTableBackground; } });
+Object.defineProperty(exports, "defaultTablePadding", { enumerable: true, get: function () { return stylings_1.defaultTablePadding; } });
+Object.defineProperty(exports, "defaultTableMargin", { enumerable: true, get: function () { return stylings_1.defaultTableMargin; } });
+Object.defineProperty(exports, "defaultBorderElement", { enumerable: true, get: function () { return stylings_1.defaultBorderElement; } });
+Object.defineProperty(exports, "defaultBorder", { enumerable: true, get: function () { return stylings_1.defaultBorder; } });
+Object.defineProperty(exports, "defaultDimension", { enumerable: true, get: function () { return stylings_1.defaultDimension; } });
+Object.defineProperty(exports, "defaultColumnStyle", { enumerable: true, get: function () { return stylings_1.defaultColumnStyle; } });
+Object.defineProperty(exports, "defaultRowStyle", { enumerable: true, get: function () { return stylings_1.defaultRowStyle; } });
+Object.defineProperty(exports, "defaultCellStyle", { enumerable: true, get: function () { return stylings_1.defaultCellStyle; } });
+Object.defineProperty(exports, "defaultColumnHeaderStyle", { enumerable: true, get: function () { return stylings_1.defaultColumnHeaderStyle; } });
+Object.defineProperty(exports, "defaultRowHeaderStyle", { enumerable: true, get: function () { return stylings_1.defaultRowHeaderStyle; } });
+Object.defineProperty(exports, "defaultFooterStyle", { enumerable: true, get: function () { return stylings_1.defaultFooterStyle; } });
+var tableData_1 = require("./tableData");
+Object.defineProperty(exports, "TableData", { enumerable: true, get: function () { return tableData_1.TableData; } });
+Object.defineProperty(exports, "TableTagType", { enumerable: true, get: function () { return tableData_1.TableTagType; } });
+var tableFormatter_1 = require("./tableFormatter");
+Object.defineProperty(exports, "defaultFormatter", { enumerable: true, get: function () { return tableFormatter_1.defaultFormatter; } });
+Object.defineProperty(exports, "defaultFormatting", { enumerable: true, get: function () { return tableFormatter_1.defaultFormatting; } });
+Object.defineProperty(exports, "TableFormatterType", { enumerable: true, get: function () { return tableFormatter_1.TableFormatterType; } });
+Object.defineProperty(exports, "isFormattingTag", { enumerable: true, get: function () { return tableFormatter_1.isFormattingTag; } });
+Object.defineProperty(exports, "TableFormatter", { enumerable: true, get: function () { return tableFormatter_1.TableFormatter; } });
+var tableStyler_1 = require("./tableStyler");
+Object.defineProperty(exports, "StyledTable", { enumerable: true, get: function () { return tableStyler_1.StyledTable; } });
+Object.defineProperty(exports, "TableStyler", { enumerable: true, get: function () { return tableStyler_1.TableStyler; } });
+var tableSvg_1 = require("./tableSvg");
+Object.defineProperty(exports, "elementInfoFrom", { enumerable: true, get: function () { return tableSvg_1.elementInfoFrom; } });
+Object.defineProperty(exports, "createTable", { enumerable: true, get: function () { return tableSvg_1.createTable; } });
+Object.defineProperty(exports, "tableId", { enumerable: true, get: function () { return tableSvg_1.tableId; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AA4BA,uCAgBoB;AAfhB,sGAAA,UAAU,OAAA;AACV,0GAAA,cAAc,OAAA;AACd,4GAAA,gBAAgB,OAAA;AAChB,kHAAA,sBAAsB,OAAA;AACtB,+GAAA,mBAAmB,OAAA;AACnB,8GAAA,kBAAkB,OAAA;AAClB,gHAAA,oBAAoB,OAAA;AACpB,yGAAA,aAAa,OAAA;AACb,4GAAA,gBAAgB,OAAA;AAChB,8GAAA,kBAAkB,OAAA;AAClB,2GAAA,eAAe,OAAA;AACf,4GAAA,gBAAgB,OAAA;AAChB,oHAAA,wBAAwB,OAAA;AACxB,iHAAA,qBAAqB,OAAA;AACrB,8GAAA,kBAAkB,OAAA;AAGtB,yCAGqB;AAFjB,sGAAA,SAAS,OAAA;AACT,yGAAA,YAAY,OAAA;AAQhB,mDAM0B;AALtB,kHAAA,gBAAgB,OAAA;AAChB,mHAAA,iBAAiB,OAAA;AACjB,oHAAA,kBAAkB,OAAA;AAClB,iHAAA,eAAe,OAAA;AACf,gHAAA,cAAc,OAAA;AAGlB,6CAGuB;AAFnB,0GAAA,WAAW,OAAA;AACX,0GAAA,WAAW,OAAA;AAWf,uCAIoB;AAHhB,2GAAA,eAAe,OAAA;AACf,uGAAA,WAAW,OAAA;AACX,mGAAA,OAAO,OAAA"}

package/dist/stylings.d.ts

@@ -0,0 +1,206 @@
+import type { DataFrame } from "data-frame-ts";
+/**
+ * Represents a styling configuration with a priority level.
+ * Higher priority styles will override lower priority styles when multiple styles are applied.
+ */
+export type Styling<S> = {
+    style: S;
+    priority: number;
+};
+/**
+ * Creates a Styling object with the given style and priority.
+ * @param style The style to apply
+ * @param defaultStyle The default style that is used to fill in missing style attributes
+ * @param priority The priority level of the style (higher values take precedence)
+ * @returns A Styling object containing the style and priority
+ */
+export declare function stylingFor<S>(style: Partial<S>, defaultStyle: S, priority?: number): Styling<S>;
+/**
+ * Enum representing different types of table styling elements.
+ * Used as identifiers when tagging different parts of the table with styles.
+ */
+export declare enum TableStyleType {
+    COLUMN_HEADER = "column_header_style",
+    ROW_HEADER = "row_header_style",
+    FOOTER = "footer_style",
+    ROW = "row_style",
+    COLUMN = "column_style",
+    CELL = "cell_style"
+}
+/**
+ * Properties for the TableStyler class.
+ * Contains all the styling information and data for a table.
+ */
+export type TableStylerProps<V> = {
+    dataFrame: DataFrame<V>;
+    readonly font: TableFont;
+    border: Border;
+    background: Background;
+    dimension: Pick<Dimension, "width" | "height">;
+    padding: Padding;
+    margin: Margin;
+    readonly errors: Array<string>;
+};
+/**
+ * Defines the font properties for table text.
+ */
+export type TableFont = {
+    size: number;
+    color: string;
+    family: string;
+    weight: number;
+};
+export declare const defaultTableFont: TableFont;
+/**
+ * Defines the background properties for table elements.
+ */
+export type Background = {
+    color: string;
+    opacity: number;
+};
+export declare const defaultTableBackground: Background;
+/**
+ * Defines the padding properties for table elements.
+ * Specifies the space between the content and the border.
+ */
+export type Padding = {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+};
+export declare const defaultTablePadding: Padding;
+/**
+ * Defines the margin properties for table elements.
+ * Specifies the space outside the border.
+ */
+export type Margin = {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+};
+export declare const defaultTableMargin: Margin;
+/**
+ * Defines the border properties for table elements.
+ * Controls the appearance of the border around table elements.
+ */
+export type BorderElement = {
+    color: string;
+    opacity: number;
+    width: number;
+    radius: number;
+};
+export declare const defaultBorderElement: BorderElement;
+export declare enum BorderLocation {
+    TOP = "top",
+    BOTTOM = "bottom",
+    LEFT = "left",
+    RIGHT = "right"
+}
+export type Border = {
+    top: BorderElement;
+    bottom: BorderElement;
+    left: BorderElement;
+    right: BorderElement;
+};
+export declare const defaultBorder: Border;
+/**
+ * Defines the dimension properties for table elements.
+ * Controls the size constraints including width and height with their minimum,
+ * maximum, and default values.
+ */
+export type Dimension = {
+    width: number;
+    defaultWidth: number;
+    minWidth: number;
+    maxWidth: number;
+    height: number;
+    defaultHeight: number;
+    minHeight: number;
+    maxHeight: number;
+};
+export declare const defaultDimension: Dimension;
+/**
+ * The style for each column (for what is not determined by each row's style).
+ */
+export type ColumnStyle = {
+    alignText: TextAlignment;
+    verticalAlignText: VerticalTextAlignment;
+    dimension: Pick<Dimension, "defaultWidth" | "minWidth" | "maxWidth">;
+    padding: Pick<Padding, "left" | "right">;
+    border: Border;
+};
+export declare const defaultColumnStyle: ColumnStyle;
+/**
+ * Note that the {@link ColumnStyle} determines the text alignment for
+ * each column. Therefore, the alignment of the text in a row is determined
+ * by the alignment for all the rows in the column.
+ */
+export type RowStyle = {
+    font: TableFont;
+    background: Background;
+    dimension: Pick<Dimension, "defaultHeight" | "minHeight" | "maxHeight">;
+    padding: Pick<Padding, "top" | "bottom">;
+    border: Border;
+};
+export declare const defaultRowStyle: RowStyle;
+export type TextAlignment = "left" | "center" | "right";
+export type VerticalTextAlignment = "top" | "middle" | "bottom";
+export type CellStyle = {
+    font: TableFont;
+    alignText: TextAlignment;
+    verticalAlignText: VerticalTextAlignment;
+    background: Background;
+    dimension: Dimension;
+    padding: Padding;
+    border: Border;
+};
+export declare const defaultCellStyle: CellStyle;
+/**
+ * Confusing as it may be, this is the style for the **row** that holds the
+ * headers for each column. The styling for this row may differ from the
+ * other rows in the table.
+ */
+export type ColumnHeaderStyle = {
+    font: TableFont;
+    alignText: TextAlignment;
+    verticalAlignText: VerticalTextAlignment;
+    dimension: Pick<Dimension, "height" | "maxHeight" | "minHeight">;
+    padding: Pick<Padding, "top" | "bottom">;
+    background: Background;
+    border: Border;
+};
+export declare const defaultColumnHeaderStyle: ColumnHeaderStyle;
+/**
+ * Confusing as it may be, this is the style for the **column** that holds
+ * the headers for each row. The styling for this column may differ from the
+ * columns in the table.
+ */
+export type RowHeaderStyle = {
+    font: TableFont;
+    alignText: TextAlignment;
+    verticalAlignText: VerticalTextAlignment;
+    dimension: Pick<Dimension, "width" | "maxWidth" | "minWidth">;
+    padding: Pick<Padding, "left" | "right">;
+    background: Background;
+    border: Border;
+};
+export declare const defaultRowHeaderStyle: RowHeaderStyle;
+/**
+ * Defines the style for the footer row of the table.
+ * Controls the appearance of the footer including font, text alignment,
+ * height, padding, and background.
+ */
+export type FooterStyle = {
+    font: TableFont;
+    alignText: TextAlignment;
+    verticalAlignText: VerticalTextAlignment;
+    dimension: Pick<Dimension, "height">;
+    padding: Pick<Padding, "top" | "bottom">;
+    background: Background;
+    border: Border;
+};
+export declare const defaultFooterStyle: FooterStyle;
+export type Stylings = Styling<RowHeaderStyle> | Styling<ColumnHeaderStyle> | Styling<FooterStyle> | Styling<RowStyle> | Styling<ColumnStyle> | Styling<CellStyle>;
+//# sourceMappingURL=stylings.d.ts.map

package/dist/stylings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stylings.d.ts","sourceRoot":"","sources":["../stylings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACrB,KAAK,EAAE,CAAC,CAAA;IACR,QAAQ,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,QAAQ,GAAE,MAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAElG;AAGD;;;GAGG;AACH,oBAAY,cAAc;IACtB,aAAa,wBAAwB;IACrC,UAAU,qBAAqB;IAC/B,MAAM,iBAAiB;IACvB,GAAG,cAAc;IACjB,MAAM,iBAAiB;IACvB,IAAI,eAAe;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAC9B,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAA;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CACjC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,SAK9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAClB,CAAA;AACD,eAAO,MAAM,sBAAsB,EAAE,UAAwC,CAAA;AAE7E;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,eAAO,MAAM,mBAAmB,EAAE,OAAgD,CAAA;AAElF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,eAAO,MAAM,kBAAkB,EAAE,MAA+C,CAAA;AAEhF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,eAAO,MAAM,oBAAoB,EAAE,aAAiE,CAAA;AAEpG,oBAAY,cAAc;IACtB,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;CAClB;AAED,MAAM,MAAM,MAAM,GAAG;IACjB,GAAG,EAAE,aAAa,CAAA;IAClB,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,aAAa,CAAA;IACnB,KAAK,EAAE,aAAa,CAAA;CACvB,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,MAK3B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAEhB,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,SAU9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,iBAAiB,EAAE,qBAAqB,CAAA;IACxC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC,CAAA;IACpE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;IACxC,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,WAMhC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,eAAe,GAAG,WAAW,GAAG,WAAW,CAAC,CAAA;IACvE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAA;IACxC,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,QAM7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;AAEvD,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE/D,MAAM,MAAM,SAAS,GAAG;IACpB,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,EAAE,aAAa,CAAA;IACxB,iBAAiB,EAAE,qBAAqB,CAAA;IACxC,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,SAQ9B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,EAAE,aAAa,CAAA;IACxB,iBAAiB,EAAE,qBAAqB,CAAA;IACxC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC,CAAA;IAChE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAA;IACxC,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,iBAStC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,EAAE,aAAa,CAAA;IACxB,iBAAiB,EAAE,qBAAqB,CAAA;IACxC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC,CAAA;IAC7D,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;IACxC,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,cASnC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,EAAE,aAAa,CAAA;IACxB,iBAAiB,EAAE,qBAAqB,CAAA;IACxC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IACpC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAA;IACxC,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,WAShC,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,GAC1C,OAAO,CAAC,iBAAiB,CAAC,GAC1B,OAAO,CAAC,WAAW,CAAC,GACpB,OAAO,CAAC,QAAQ,CAAC,GACjB,OAAO,CAAC,WAAW,CAAC,GACpB,OAAO,CAAC,SAAS,CAAC,CAAA"}

package/dist/stylings.js

@@ -0,0 +1,123 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultFooterStyle = exports.defaultRowHeaderStyle = exports.defaultColumnHeaderStyle = exports.defaultCellStyle = exports.defaultRowStyle = exports.defaultColumnStyle = exports.defaultDimension = exports.defaultBorder = exports.BorderLocation = exports.defaultBorderElement = exports.defaultTableMargin = exports.defaultTablePadding = exports.defaultTableBackground = exports.defaultTableFont = exports.TableStyleType = void 0;
+exports.stylingFor = stylingFor;
+/**
+ * Creates a Styling object with the given style and priority.
+ * @param style The style to apply
+ * @param defaultStyle The default style that is used to fill in missing style attributes
+ * @param priority The priority level of the style (higher values take precedence)
+ * @returns A Styling object containing the style and priority
+ */
+function stylingFor(style, defaultStyle, priority) {
+    if (priority === void 0) { priority = 0; }
+    return { style: __assign(__assign({}, defaultStyle), style), priority: priority };
+}
+/**
+ * Enum representing different types of table styling elements.
+ * Used as identifiers when tagging different parts of the table with styles.
+ */
+var TableStyleType;
+(function (TableStyleType) {
+    TableStyleType["COLUMN_HEADER"] = "column_header_style";
+    TableStyleType["ROW_HEADER"] = "row_header_style";
+    TableStyleType["FOOTER"] = "footer_style";
+    TableStyleType["ROW"] = "row_style";
+    TableStyleType["COLUMN"] = "column_style";
+    TableStyleType["CELL"] = "cell_style";
+})(TableStyleType || (exports.TableStyleType = TableStyleType = {}));
+exports.defaultTableFont = {
+    size: 13,
+    color: '#d2933f',
+    family: 'sans-serif',
+    weight: 450,
+};
+exports.defaultTableBackground = { color: '#fff', opacity: 0 };
+exports.defaultTablePadding = { left: 0, right: 0, top: 0, bottom: 0 };
+exports.defaultTableMargin = { left: 0, right: 0, top: 0, bottom: 0 };
+exports.defaultBorderElement = { color: 'black', radius: 0, width: 0, opacity: 0 };
+var BorderLocation;
+(function (BorderLocation) {
+    BorderLocation["TOP"] = "top";
+    BorderLocation["BOTTOM"] = "bottom";
+    BorderLocation["LEFT"] = "left";
+    BorderLocation["RIGHT"] = "right";
+})(BorderLocation || (exports.BorderLocation = BorderLocation = {}));
+exports.defaultBorder = {
+    top: exports.defaultBorderElement,
+    bottom: exports.defaultBorderElement,
+    left: exports.defaultBorderElement,
+    right: exports.defaultBorderElement,
+};
+exports.defaultDimension = {
+    width: 60,
+    defaultWidth: 70,
+    minWidth: 50,
+    maxWidth: 100,
+    height: 15,
+    defaultHeight: 20,
+    minHeight: 10,
+    maxHeight: 50
+};
+exports.defaultColumnStyle = {
+    alignText: "left",
+    verticalAlignText: "middle",
+    dimension: __assign(__assign({}, exports.defaultDimension), { defaultWidth: 60, minWidth: 40, maxWidth: 80 }),
+    padding: __assign(__assign({}, exports.defaultTablePadding), { left: 0, right: 0 }),
+    border: exports.defaultBorder
+};
+exports.defaultRowStyle = {
+    font: exports.defaultTableFont,
+    background: exports.defaultTableBackground,
+    dimension: { defaultHeight: 20, minHeight: 15, maxHeight: 50 },
+    padding: { top: 0, bottom: 0 },
+    border: exports.defaultBorder
+};
+exports.defaultCellStyle = {
+    font: exports.defaultTableFont,
+    alignText: "left",
+    verticalAlignText: "middle",
+    background: exports.defaultTableBackground,
+    dimension: exports.defaultDimension,
+    padding: exports.defaultTablePadding,
+    border: exports.defaultBorder
+};
+exports.defaultColumnHeaderStyle = {
+    font: __assign(__assign({}, exports.defaultTableFont), { weight: 600 }),
+    alignText: "left",
+    verticalAlignText: "middle",
+    dimension: __assign(__assign({}, exports.defaultDimension), { height: 20, maxHeight: 50, minHeight: 15 }),
+    padding: __assign(__assign({}, exports.defaultTablePadding), { top: 0, bottom: 0 }),
+    background: exports.defaultTableBackground,
+    border: exports.defaultBorder
+};
+exports.defaultRowHeaderStyle = {
+    font: exports.defaultTableFont,
+    alignText: "left",
+    verticalAlignText: "middle",
+    dimension: __assign(__assign({}, exports.defaultDimension), { width: 60, minWidth: 15, maxWidth: 100 }),
+    padding: __assign(__assign({}, exports.defaultTablePadding), { left: 0, right: 0 }),
+    background: exports.defaultTableBackground,
+    border: exports.defaultBorder
+};
+exports.defaultFooterStyle = {
+    font: exports.defaultTableFont,
+    alignText: "left",
+    verticalAlignText: "middle",
+    dimension: { height: 20 },
+    padding: __assign(__assign({}, exports.defaultTablePadding), { top: 0, bottom: 0 }),
+    background: exports.defaultTableBackground,
+    border: exports.defaultBorder
+};
+//# sourceMappingURL=stylings.js.map

package/dist/stylings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stylings.js","sourceRoot":"","sources":["../stylings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAkBA,gCAEC;AATD;;;;;;GAMG;AACH,SAAgB,UAAU,CAAI,KAAiB,EAAE,YAAe,EAAE,QAAoB;IAApB,yBAAA,EAAA,YAAoB;IAClF,OAAO,EAAC,KAAK,wBAAM,YAAY,GAAK,KAAK,CAAC,EAAE,QAAQ,UAAA,EAAC,CAAA;AACzD,CAAC;AAGD;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACtB,uDAAqC,CAAA;IACrC,iDAA+B,CAAA;IAC/B,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;AACvB,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AA2BY,QAAA,gBAAgB,GAAc;IACvC,IAAI,EAAE,EAAE;IACR,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,GAAG;CACd,CAAA;AASY,QAAA,sBAAsB,GAAe,EAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAC,CAAA;AAYhE,QAAA,mBAAmB,GAAY,EAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAC,CAAA;AAYrE,QAAA,kBAAkB,GAAW,EAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAC,CAAA;AAYnE,QAAA,oBAAoB,GAAkB,EAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAC,CAAA;AAEpG,IAAY,cAKX;AALD,WAAY,cAAc;IACtB,6BAAW,CAAA;IACX,mCAAiB,CAAA;IACjB,+BAAa,CAAA;IACb,iCAAe,CAAA;AACnB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AASY,QAAA,aAAa,GAAW;IACjC,GAAG,EAAE,4BAAoB;IACzB,MAAM,EAAE,4BAAoB;IAC5B,IAAI,EAAE,4BAAoB;IAC1B,KAAK,EAAE,4BAAoB;CAC9B,CAAA;AAmBY,QAAA,gBAAgB,GAAc;IACvC,KAAK,EAAE,EAAE;IACT,YAAY,EAAE,EAAE;IAChB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,GAAG;IAEb,MAAM,EAAE,EAAE;IACV,aAAa,EAAE,EAAE;IACjB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;CAChB,CAAA;AAaY,QAAA,kBAAkB,GAAgB;IAC3C,SAAS,EAAE,MAAM;IACjB,iBAAiB,EAAE,QAAQ;IAC3B,SAAS,wBAAM,wBAAgB,KAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAC;IAC9E,OAAO,wBAAM,2BAAmB,KAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAC;IACpD,MAAM,EAAE,qBAAa;CACxB,CAAA;AAeY,QAAA,eAAe,GAAa;IACrC,IAAI,EAAE,wBAAgB;IACtB,UAAU,EAAE,8BAAsB;IAClC,SAAS,EAAE,EAAC,aAAa,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAC;IAC5D,OAAO,EAAE,EAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAC;IAC5B,MAAM,EAAE,qBAAa;CACxB,CAAA;AAgBY,QAAA,gBAAgB,GAAc;IACvC,IAAI,EAAE,wBAAgB;IACtB,SAAS,EAAE,MAAM;IACjB,iBAAiB,EAAE,QAAQ;IAC3B,UAAU,EAAE,8BAAsB;IAClC,SAAS,EAAE,wBAAgB;IAC3B,OAAO,EAAE,2BAAmB;IAC5B,MAAM,EAAE,qBAAa;CACxB,CAAA;AAiBY,QAAA,wBAAwB,GAAsB;IACvD,IAAI,wBAAM,wBAAgB,KAAE,MAAM,EAAE,GAAG,GAAC;IACxC,SAAS,EAAE,MAAM;IACjB,iBAAiB,EAAE,QAAQ;IAC3B,SAAS,wBAAM,wBAAgB,KAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,GAAC;IAC1E,OAAO,wBAAM,2BAAmB,KAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAC;IACpD,UAAU,EAAE,8BAAsB;IAClC,MAAM,EAAE,qBAAa;CAExB,CAAA;AAiBY,QAAA,qBAAqB,GAAmB;IACjD,IAAI,EAAE,wBAAgB;IACtB,SAAS,EAAE,MAAM;IACjB,iBAAiB,EAAE,QAAQ;IAC3B,SAAS,wBAAM,wBAAgB,KAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,GAAC;IACxE,OAAO,wBAAM,2BAAmB,KAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAC;IACpD,UAAU,EAAE,8BAAsB;IAClC,MAAM,EAAE,qBAAa;CAExB,CAAA;AAiBY,QAAA,kBAAkB,GAAgB;IAC3C,IAAI,EAAE,wBAAgB;IACtB,SAAS,EAAE,MAAM;IACjB,iBAAiB,EAAE,QAAQ;IAC3B,SAAS,EAAE,EAAC,MAAM,EAAE,EAAE,EAAC;IACvB,OAAO,wBAAM,2BAAmB,KAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAC;IACpD,UAAU,EAAE,8BAAsB;IAClC,MAAM,EAAE,qBAAa;CAExB,CAAA"}

package/dist/tableData.d.ts

@@ -0,0 +1,168 @@
+import { DataFrame } from "data-frame-ts";
+import { type Result } from "result-fn";
+import { type Formatting } from "./tableFormatter";
+/**
+ * The types of tags the {@link TableData} supports
+ */
+export declare enum TableTagType {
+    COLUMN_HEADER = "column-header",
+    ROW_HEADER = "row-header",
+    FOOTER = "footer"
+}
+/**
+ * Represents the table data, row and column headers, and footers
+ */
+export declare class TableData<V> {
+    private readonly dataFrame;
+    /**
+     * The matrix of data, including row, column headers, and footers, if they exist
+     */
+    private constructor();
+    static fromDataFrame<V>(dataFrame: DataFrame<V>): TableData<V>;
+    /**
+     * Adds a column-header where each element in the column-header is the name of the column.
+     * Note that the specified column {@link header} determines the number of data columns in the table. This
+     * means that you must specify a header for each data column. No need to account for a possible column
+     * containing row-headers. The builder will take care of any adjustments needed for that.
+     * @param header An array describing the columns in the table.
+     * @param formatting The formatter, and its priority, for the row that represents the column-header. Note that the column
+     * header should not account for a possible column containing row-headers. The builder will take care
+     * of any adjustments needed for that.
+     * @param rowHeaderProvider
+     * @return A {@link TableData} which represents the next step in the guided builder
+     */
+    withColumnHeader(header: Array<V>, formatting?: Formatting<V>, rowHeaderProvider?: () => V | undefined): Result<TableData<V>, string>;
+    withRowHeader(header: Array<V>, formatting?: Formatting<V>, columnHeaderProvider?: () => V | undefined, footerProvider?: () => V | undefined): Result<TableData<V>, string>;
+    withFooter(footer: Array<V>, formatting?: Formatting<V>, rowHeaderProvider?: () => V | undefined): Result<TableData<V>, string>;
+    static hasColumnHeader<V>(dataFrame: DataFrame<V>): boolean;
+    static hasRowHeader<V>(dataFrame: DataFrame<V>): boolean;
+    static hasFooter<V>(dataFrame: DataFrame<V>): boolean;
+    static dataRowCount<V>(dataFrame: DataFrame<V>): number;
+    static dataColumnCount<V>(dataFrame: DataFrame<V>): number;
+    static tableRowCount<V>(dataFrame: DataFrame<V>): number;
+    static tableColumnCount<V>(dataFrame: DataFrame<V>): number;
+    hasColumnHeader(): boolean;
+    hasRowHeader(): boolean;
+    hasFooter(): boolean;
+    dataRowCount(): number;
+    dataColumnCount(): number;
+    tableRowCount(): number;
+    tableColumnCount(): number;
+    /**
+     * @param [includeRowHeader=false] When `true` includes an extra empty column element when the table
+     * has a row-header. When `false` returns only the column-header elements
+     * @return A {@link Result} holding the column header if it exists; or a failure if no column-header exists
+     * @example
+     * ```typescript
+     * const columnHeader = ['A', 'B', 'C', 'D', 'E']
+     * const rowHeader = ['one', 'two', 'three', 'four']
+     * const footer = ['a10', 'b10', 'c10', 'd10', 'e10']
+     * const data = DataFrame.from([
+     *     ['a1', 'b1', 'c1', 'd1', 'e1'],
+     *     ['a2', 'b2', 'c2', 'd2', 'e2'],
+     *     ['a3', 'b3', 'c3', 'd3', 'e3'],
+     *     ['a4', 'b4', 'c4', 'd4', 'e4'],
+     * ]).getOrThrow()
+     *
+     * // create a data-table with a column-header, row-header, footer, and data
+     * const tableData = createTableData<string>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(table => table.withRowHeader(rowHeader))
+     *     .flatMap(table => table.withFooter(footer))
+     *     .getOrThrow()
+     *
+     * // the column-header retrieved from the table-data should equal the column-header originally set
+     * expect(tableData.columnHeader().getOrThrow().equals(columnHeader)).toBeTruthy()
+     * ```     */
+    columnHeader(includeRowHeader?: boolean): Result<Array<V>, string>;
+    /**
+     * @param [includeColumnHeader=false] When `true` returns an extra empty row element if the table data
+     * has a column header. When `false` does not include the empty extra row element.
+     * @param [includeFooter=false] When `true` returns an extra empty row element if the table data
+     * has a footer. When `false` does not include the empty extra row element.
+     * @return A {@link Result} holding the row-header if it exists; or a failure if no row-header exists
+     * @example
+     * ```typescript
+     * const columnHeader = ['A', 'B', 'C', 'D', 'E']
+     * const rowHeader = ['one', 'two', 'three', 'four']
+     * const footer = ['a10', 'b10', 'c10', 'd10', 'e10']
+     * const data = DataFrame.from([
+     *     ['a1', 'b1', 'c1', 'd1', 'e1'],
+     *     ['a2', 'b2', 'c2', 'd2', 'e2'],
+     *     ['a3', 'b3', 'c3', 'd3', 'e3'],
+     *     ['a4', 'b4', 'c4', 'd4', 'e4'],
+     * ]).getOrThrow()
+     *
+     * // create a data-table with a column-header, row-header, footer, and data
+     * const tableData = createTableData<string>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(table => table.withRowHeader(rowHeader))
+     *     .flatMap(table => table.withFooter(footer))
+     *     .getOrThrow()
+     *
+     * // the row-header retrieved from the table-data should equal the row-header originally set
+     * expect(tableData.rowHeader().getOrThrow().equals(rowHeader)).toBeTruthy()
+     * ```     */
+    rowHeader(includeColumnHeader?: boolean, includeFooter?: boolean): Result<Array<V>, string>;
+    /**
+     * @param [includeRowHeader=false] When `true` includes an extra empty column element when the table
+     * has a row-header. When `false` returns only the column-header elements
+     * @return A {@link Result} holding the footer, if exists; or a failure if no footer exists
+     * @example
+     * ```typescript
+     * const columnHeader = ['A', 'B', 'C', 'D', 'E']
+     * const rowHeader = ['one', 'two', 'three', 'four']
+     * const footer = ['a10', 'b10', 'c10', 'd10', 'e10']
+     * const data = DataFrame.from([
+     *     ['a1', 'b1', 'c1', 'd1', 'e1'],
+     *     ['a2', 'b2', 'c2', 'd2', 'e2'],
+     *     ['a3', 'b3', 'c3', 'd3', 'e3'],
+     *     ['a4', 'b4', 'c4', 'd4', 'e4'],
+     * ]).getOrThrow()
+     *
+     * // create a data-table with a column-header, row-header, footer, and data
+     * const tableData = createTableData<string>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(table => table.withRowHeader(rowHeader))
+     *     .flatMap(table => table.withFooter(footer))
+     *     .getOrThrow()
+     *
+     * // the footer retrieved from the table-data should equal the footer originally set
+     * expect(tableData.footer().getOrThrow().equals(footer)).toBeTruthy()
+     * ```
+     */
+    footer(includeRowHeader?: boolean): Result<Array<V>, string>;
+    /**
+     * Retrieves the "data" from the data-table. This excludes any column headers, row-headers, and footers.
+     * @return A {@link Result} holding a {@link DataFrame} with the "data" from the data-table. This excludes any
+     * column headers, row-headers, and footers.
+     * @example
+     * ```typescript
+     * const columnHeader = ['A', 'B', 'C', 'D', 'E']
+     * const rowHeader = ['one', 'two', 'three', 'four']
+     * const footer = ['a10', 'b10', 'c10', 'd10', 'e10']
+     * const data = DataFrame.from([
+     *     ['a1', 'b1', 'c1', 'd1', 'e1'],
+     *     ['a2', 'b2', 'c2', 'd2', 'e2'],
+     *     ['a3', 'b3', 'c3', 'd3', 'e3'],
+     *     ['a4', 'b4', 'c4', 'd4', 'e4'],
+     * ]).getOrThrow()
+     *
+     * // create a data-table with a column-header, row-header, footer, and data
+     * const tableData = createTableData<string>(data)
+     *     .withColumnHeader(columnHeader)
+     *     .flatMap(table => table.withRowHeader(rowHeader))
+     *     .flatMap(table => table.withFooter(footer))
+     *     .getOrThrow()
+     *
+     * // the data retrieved from the table-data should equal the data originally set
+     * expect(tableData.data().getOrThrow().equals(data)).toBeTruthy()
+     * ```
+     */
+    data(): Result<DataFrame<V>, string>;
+    /**
+     * @return a copy of the {@link DataFrame} that has been prepared by this class.
+     */
+    unwrapDataFrame(): DataFrame<V>;
+}
+//# sourceMappingURL=tableData.d.ts.map

package/dist/tableData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableData.d.ts","sourceRoot":"","sources":["../tableData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AACxC,OAAO,EAAgB,KAAK,MAAM,EAAgB,MAAM,WAAW,CAAC;AAEpE,OAAO,EAAoB,KAAK,UAAU,EAAqB,MAAM,kBAAkB,CAAC;AAExF;;GAEG;AACH,oBAAY,YAAY;IACpB,aAAa,kBAAkB;IAC/B,UAAU,eAAe;IACzB,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,qBAAa,SAAS,CAAC,CAAC;IAIA,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH9C;;OAEG;IACH,OAAO;IAGP,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAI9D;;;;;;;;;;;OAWG;IACI,gBAAgB,CACnB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAChB,UAAU,GAAE,UAAU,CAAC,CAAC,CAA0B,EAClD,iBAAiB,GAAE,MAAM,CAAC,GAAG,SAA2B,GACzD,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IA2BxB,aAAa,CAChB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAChB,UAAU,GAAE,UAAU,CAAC,CAAC,CAA0B,EAClD,oBAAoB,GAAE,MAAM,CAAC,GAAG,SAA2B,EAC3D,cAAc,GAAE,MAAM,CAAC,GAAG,SAA2B,GACtD,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAiCxB,UAAU,CACb,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAChB,UAAU,GAAE,UAAU,CAAC,CAAC,CAA0B,EAClD,iBAAiB,GAAE,MAAM,CAAC,GAAG,SAA2B,GACzD,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IA2B/B,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO;IAI3D,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO;IAIxD,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO;IAIrD,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM;IAIvD,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM;IAI1D,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM;IAIxD,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM;IAI3D,eAAe,IAAI,OAAO;IAK1B,YAAY,IAAI,OAAO;IAKvB,SAAS,IAAI,OAAO;IAKpB,YAAY,IAAI,MAAM;IAKtB,eAAe,IAAI,MAAM;IAKzB,aAAa,IAAI,MAAM;IAIvB,gBAAgB,IAAI,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;iBAyBa;IACb,YAAY,CAAC,gBAAgB,GAAG,OAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAW1E;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2Ba;IACb,SAAS,CAAC,mBAAmB,GAAE,OAAe,EAAE,aAAa,GAAE,OAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAYzG;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,gBAAgB,GAAG,OAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAWpE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IASpC;;OAEG;IACH,eAAe,IAAI,SAAS,CAAC,CAAC,CAAC;CAGlC"}