@mlightcad/data-model 1.3.3 → 1.3.4

package/lib/entity/AcDbTable.d.ts

@@ -0,0 +1,260 @@
+import { AcGeBox3d } from '@mlightcad/geometry-engine';
+import { AcGiEntity, AcGiMTextAttachmentPoint, AcGiRenderer } from '@mlightcad/graphic-interface';
+import { AcDbBlockReference } from './AcDbBlockReference';
+/**
+ * Interface defining the properties of a table cell within an AcDbTable entity.
+ *
+ * Table cells can contain various types of content including text, blocks, and other
+ * entities. Each cell has properties that control its appearance, content, and behavior.
+ */
+export interface AcDbTableCell {
+    /** The text content displayed in the cell */
+    text: string;
+    /** The attachment point for text positioning within the cell */
+    attachmentPoint: AcGiMTextAttachmentPoint;
+    /** Optional text style name for the cell content */
+    textStyle?: string;
+    /** Optional rotation angle for the cell content in radians */
+    rotation?: number;
+    /** The type of cell (text, block, etc.) */
+    cellType: number;
+    /** Optional flag value for cell behavior */
+    flagValue?: number;
+    /** Optional value indicating merged cell information */
+    mergedValue?: number;
+    /** Optional auto-fit behavior setting */
+    autoFit?: number;
+    /** Optional border width for merged cells */
+    borderWidth?: number;
+    /** Optional border height for merged cells */
+    borderHeight?: number;
+    /** Optional override flag for cell properties */
+    overrideFlag?: number;
+    /** Optional virtual edge flag for cell borders */
+    virtualEdgeFlag?: number;
+    /** Optional field object ID for text type cells */
+    fieldObjetId?: string;
+    /** Optional block table record ID for block type cells */
+    blockTableRecordId?: string;
+    /** Optional scale factor for block type cells */
+    blockScale?: number;
+    /** Optional number of block attributes */
+    blockAttrNum?: number;
+    /** Optional array of attribute definition IDs */
+    attrDefineId?: string[];
+    /** Optional attribute text content */
+    attrText?: string;
+    /** The height of text in the cell */
+    textHeight: number;
+    /** Extended cell flags from AutoCAD 2007 and later */
+    extendedCellFlags?: number;
+}
+/**
+ * Represents a table entity in AutoCAD.
+ *
+ * A table is generally thought of as an n x m rectangular array of cells whose contents
+ * consist of annotation objects, primarily text. Tables often contain a title row, a
+ * header row, and multiple data rows.
+ *
+ * After creating a new table object using the constructor, applications usually need to
+ * set the table style, number of rows and columns, column width, row height, insert
+ * position, width direction, and normal vector. Applications can also enter text or
+ * block contents into each cell using methods of this class.
+ *
+ * Tables are commonly used for bills of materials, schedules, data sheets, and other
+ * tabular information in technical drawings and documentation.
+ */
+export declare class AcDbTable extends AcDbBlockReference {
+    /** The entity type name */
+    static typeName: string;
+    private _attachmentPoint;
+    private _numRows;
+    private _numColumns;
+    private _rowHeight;
+    private _columnWidth;
+    private _cells;
+    /**
+     * Creates a new table entity.
+     *
+     * @param name - The name of the table block reference
+     * @param numRows - The number of rows in the table
+     * @param numColumns - The number of columns in the table
+     */
+    constructor(name: string, numRows: number, numColumns: number);
+    /**
+     * Gets or sets the cell alignment value for this table.
+     *
+     * This property controls how text is positioned within table cells by default.
+     * Individual cells can override this setting with their own attachment point.
+     *
+     * @returns The default attachment point for table cells
+     */
+    get attachmentPoint(): AcGiMTextAttachmentPoint;
+    set attachmentPoint(value: AcGiMTextAttachmentPoint);
+    /**
+     * Gets or sets the number of rows in the table.
+     *
+     * Changing this value will resize the table and may affect existing cell data.
+     *
+     * @returns The current number of rows in the table
+     */
+    get numRows(): number;
+    set numRows(value: number);
+    /**
+     * Gets or sets the number of columns in the table.
+     *
+     * Changing this value will resize the table and may affect existing cell data.
+     *
+     * @returns The current number of columns in the table
+     */
+    get numColumns(): number;
+    set numColumns(value: number);
+    /**
+     * Gets the number of contents in the specified cell.
+     *
+     * @param row - Row index. Must be greater than or equal to 0 and less than the number of rows
+     * @param col - Column index. Must be greater than or equal to 0 and less than the number of columns
+     * @returns The number of contents in the specified cell
+     */
+    numContents(row: number, col: number): number;
+    /**
+     * Gets the row height of the specified row in the table.
+     *
+     * @param index - Zero-based row index
+     * @returns The row height of the specified row in the table
+     */
+    rowHeight(index: number): number;
+    /**
+     * Sets the row height for the specified row index in the table.
+     *
+     * @param index - Zero-based row index
+     * @param height - Height to be used for the specified row
+     */
+    setRowHeight(index: number, height: number): void;
+    /**
+     * Sets a uniform row height for all the rows in the table.
+     *
+     * @param height - Height to be used for all the rows in the table
+     */
+    setUniformRowHeight(height: number): void;
+    /**
+     * Gets the column width at the specified column index in the table.
+     *
+     * @param index - Zero-based column index
+     * @returns The width of the specified column
+     */
+    columnWidth(index: number): number;
+    /**
+     * Sets a uniform column width for all the columns in the table.
+     *
+     * @param width - Uniform width to be used for all the columns in the table
+     */
+    setUniformColumnWidth(width: number): void;
+    /**
+     * Sets the column width at the specified column index in the table.
+     *
+     * @param index - Zero-based column index
+     * @param width - Width to be used for the specified column
+     */
+    setColumnWidth(index: number, width: number): void;
+    /**
+     * Gets the cell at the specified index.
+     *
+     * @param index - Cell index (calculated as row * numColumns + column)
+     * @returns The specified cell by index, or undefined if index is out of range
+     */
+    cell(index: number): AcDbTableCell | undefined;
+    /**
+     * Sets the cell at the specified index.
+     *
+     * @param index - Cell index (calculated as row * numColumns + column)
+     * @param cell - The cell data to set
+     */
+    setCell(index: number, cell: AcDbTableCell): void;
+    /**
+     * Gets the text string in the specified cell.
+     *
+     * @param row - Integer specifying the zero-based row index for the cell
+     * @param col - Integer specifying the zero-based column index for the cell
+     * @param content - Content index. Should be greater than or equal to 0 and less than the number of contents
+     * @returns The text string in the specified cell
+     */
+    textString(row: number, col: number, content?: number): string;
+    /**
+     * Sets the text for the first content at the specified content index.
+     *
+     * @param row - Integer specifying the zero-based row index for the cell
+     * @param col - Integer specifying the zero-based column index for the cell
+     * @param text - Text string to set
+     */
+    setTextString(row: number, col: number, text: string): void;
+    /**
+     * Checks if the content of the specified cell is empty.
+     *
+     * @param row - Integer specifying the zero-based row index for the cell
+     * @param col - Integer specifying the zero-based column index for the cell
+     * @returns True if the content of the specified cell is empty, false otherwise
+     */
+    isEmpty(row: number, col: number): boolean;
+    /**
+     * Gets the geometric extents (bounding box) of this table entity.
+     *
+     * The geometric extents define the minimum bounding box that completely contains
+     * the table entity, including all its cells, borders, and content.
+     *
+     * @returns A 3D bounding box containing the table entity
+     * @inheritdoc
+     */
+    get geometricExtents(): AcGeBox3d;
+    /**
+     * Renders the table entity using the specified graphics renderer.
+     *
+     * This method draws the table structure including borders, cell content, and text.
+     * It handles the rendering of individual cells, merged cells, and applies the
+     * appropriate transformations and styling.
+     *
+     * @param renderer - The graphics renderer used to draw the table
+     * @returns The rendered graphics entity representing the table
+     * @inheritdoc
+     */
+    draw(renderer: AcGiRenderer): AcGiEntity;
+    /**
+     * Marks cells as visited to handle merged cell rendering.
+     *
+     * This method prevents duplicate rendering of merged cells by marking all
+     * constituent cells as visited.
+     *
+     * @param visited - Array tracking which cells have been processed
+     * @param currentIndex - Index of the current cell being processed
+     * @param columnCount - Total number of columns in the table
+     * @param columnSpan - Number of columns this cell spans
+     * @param rowSpan - Number of rows this cell spans
+     * @private
+     */
+    private fillVisited;
+    /**
+     * Gets the text style for a specific cell.
+     *
+     * This method retrieves the appropriate text style for the cell, falling back
+     * to the standard style if no specific style is specified.
+     *
+     * @param cell - The cell for which to get the text style
+     * @returns The text style configuration for the cell
+     * @private
+     */
+    private getTextStyle;
+    /**
+     * Calculates the text offset within a table cell based on attachment point.
+     *
+     * This method determines the appropriate positioning offset for text within
+     * a cell based on the specified attachment point and cell dimensions.
+     *
+     * @param textAlign - The text alignment/attachment point value
+     * @param width - The width of the cell
+     * @param height - The height of the cell
+     * @returns A vector representing the text offset from the cell corner
+     * @private
+     */
+    private getTableTextOffset;
+}
+//# sourceMappingURL=AcDbTable.d.ts.map

package/lib/entity/AcDbTable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbTable.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbTable.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAIV,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAEL,UAAU,EACV,wBAAwB,EAExB,YAAY,EAEb,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,gEAAgE;IAChE,eAAe,EAAE,wBAAwB,CAAA;IACzC,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kDAAkD;IAClD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAID;;;;;;;;;;;;;;GAcG;AACH,qBAAa,SAAU,SAAQ,kBAAkB;IAC/C,2BAA2B;IAC3B,OAAgB,QAAQ,EAAE,MAAM,CAAU;IAE1C,OAAO,CAAC,gBAAgB,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,MAAM,CAAiB;IAE/B;;;;;;OAMG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAU7D;;;;;;;OAOG;IACH,IAAI,eAAe,IAGQ,wBAAwB,CADlD;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,wBAAwB,EAElD;IAED;;;;;;OAMG;IACH,IAAI,OAAO,IAGQ,MAAM,CADxB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED;;;;;;OAMG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;OAMG;IAEH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKpC;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM;IAIvB;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAI1C;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM;IAIlC;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM;IAIzB;;;;OAIG;IACH,qBAAqB,CAAC,KAAK,EAAE,MAAM;IAInC;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI3C;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM;IAKlB;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa;IAI1C;;;;;;;OAOG;IAEH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAIrD;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIpD;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAIhC;;;;;;;;OAQG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAGhC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU;IAkHxC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,WAAW;IAkBnB;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY;IAapB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,kBAAkB;CAwC3B"}