Class AcDbTable

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.

Hierarchy (View Summary)

Constructors

constructor

Properties

typeName

Accessors

attachmentPoint attrs blockTableRecord blockTransform color database geometricExtents layer lineStyle lineType linetypeScale lineWeight normal numColumns numRows objectId ownerId position properties rgbColor rotation scaleFactors transparency type visibility

Methods

appendAttributes attributeIterator cell close columnWidth erase getAttr getAttrWithoutException getGeneralProperties getLayerColor isEmpty numContents rowHeight setAttr setCell setColumnWidth setRowHeight setTextString setUniformColumnWidth setUniformRowHeight subGetGripPoints subGetOsnapPoints subWorldDraw textString transformBy triggerModifiedEvent worldDraw

Constructors

constructor

Properties

StatictypeName

typeName: string = 'Table'

The entity type name

Accessors

attachmentPoint

attrs

blockTableRecord

  • get blockTableRecord(): undefined | AcDbBlockTableRecord

  • Gets the block table record referenced by this block reference.

    The referenced block table record contains the entities that the block reference will display.

    Returns undefined | AcDbBlockTableRecord

    The block table record, or undefined if not found

    Example

    const blockRecord = blockRef.blockTableRecord;
    if (blockRecord) {
      console.log(`Block name: ${blockRecord.name}`);
    }

blockTransform

  • get blockTransform(): AcGeMatrix3d

  • Gets the block-local transformation matrix of this block reference.

    This matrix represents the INSERT entity transform in Object Coordinate System (OCS), excluding the extrusion / normal transformation.

    In AutoCAD, a block reference transform is conceptually applied in the following order:

    1. Translate geometry by the negative block base point
    2. Apply non-uniform scaling
    3. Apply rotation about the block Z axis (OCS Z)
    4. Translate to the insertion point
    5. Finally, transform from OCS to WCS using the entity normal (extrusion)

    This property returns the matrix for steps 1–4 only.

    The OCS → WCS transformation derived from normal must NOT be included here, because:

    • The rotation angle of an INSERT is defined in OCS
    • Applying OCS earlier would rotate around an incorrect axis
    • Cached block geometry must remain reusable for different normals

    Therefore, the extrusion transformation is applied after rendering (see AcDbRenderingCache.draw), matching AutoCAD / RealDWG behavior.

    Matrix composition (right-multiply convention)

    blockTransform =
      T(position)
    · R(rotation about OCS Z)
    · S(scaleFactors)
    · T(-blockBasePoint)

    Notes

    • The returned matrix operates in OCS space
    • Rotation is always about the OCS Z axis
    • normal is applied later as a final orientation step
    • This mirrors the internal behavior of AcDbBlockReference in ObjectARX

    Returns AcGeMatrix3d

    A transformation matrix representing the block-local INSERT transform in OCS, excluding extrusion.

color

database

  • get database(): AcDbDatabase

  • Gets the database in which this object is resident.

    When an object isn't added to a database, this property returns the current working database. After it is added to a database, it will be set automatically. You should never set this value manually.

    Returns AcDbDatabase

    The database this object belongs to

    Example

    const db = obj.database;
  • set database(db: AcDbDatabase): void

  • Sets the database for this object.

    This is typically set automatically when the object is added to a database. Manual setting should be avoided unless you know what you're doing.

    Parameters

    Returns void

    Example

    obj.database = myDatabase;

geometricExtents

  • get geometricExtents(): AcGeBox3d

  • Gets the geometric extents (bounding box) of this block reference.

    This method calculates the bounding box by transforming the geometric extents of all entities in the referenced block according to the block reference's position, rotation, and scale factors.

    Returns AcGeBox3d

    The bounding box that encompasses the entire block reference

    Example

    const extents = blockRef.geometricExtents;
    console.log(`Block bounds: ${extents.minPoint} to ${extents.maxPoint}`);

layer

  • get layer(): string

  • Gets the name of the layer referenced by this entity.

    Returns string

    The layer name

    Example

    const layerName = entity.layer;
  • set layer(value: string): void

  • Sets the name of the layer for this entity.

    Parameters

    • value: string

      The new layer name

    Returns void

    Example

    entity.layer = 'MyLayer';

lineStyle

  • get lineStyle(): AcGiLineStyle

  • Gets the line style for this entity.

    This method returns the line style based on the entity's linetype and other properties.

    Returns AcGiLineStyle

    The line style object

    Example

    const lineStyle = entity.lineStyle;

lineType

  • get lineType(): string

  • Gets the name of the line type referenced by this entity.

    Returns string

    The linetype name

    Example

    const lineType = entity.lineType;
  • set lineType(value: string): void

  • Sets the name of the line type for this entity.

    Parameters

    • value: string

      The new linetype name

    Returns void

    Example

    entity.lineType = 'DASHED';

linetypeScale

  • get linetypeScale(): number

  • Gets the line type scale factor of this entity.

    When an entity is first instantiated, its line type scale is initialized to an invalid value. When the entity is added to the database, if a linetype scale has not been specified for the entity, it is set to the database's current line type scale value.

    Returns number

    The linetype scale factor

    Example

    const scale = entity.linetypeScale;
  • set linetypeScale(value: number): void

  • Sets the line type scale factor for this entity.

    Parameters

    • value: number

      The new linetype scale factor

    Returns void

    Example

    entity.linetypeScale = 2.0;

lineWeight

normal

numColumns

numRows

objectId

  • get objectId(): string

  • Gets the object ID.

    AutoCAD uses 64-bit integers to represent handles, which exceed the maximum integer value of JavaScript. Therefore, strings are used to represent object handles.

    Returns string

    The object ID as a string

    Example

    const id = obj.objectId;
    console.log(`Object ID: ${id}`);
  • set objectId(value: string): void

  • Sets the object ID.

    Parameters

    • value: string

      The new object ID

    Returns void

    Example

    obj.objectId = 'new-object-id';

ownerId

  • get ownerId(): string

  • Gets the object ID of the owner of this object.

    Returns string

    The owner object ID

    Example

    const ownerId = obj.ownerId;
  • set ownerId(value: string): void

  • Sets the object ID of the owner of this object.

    Parameters

    • value: string

      The new owner object ID

    Returns void

    Example

    obj.ownerId = 'parent-object-id';

position

properties

rgbColor

  • get rgbColor(): number

  • Gets the RGB color of this entity.

    This method handles the conversion of color indices (including ByLayer and ByBlock) to actual RGB colors. It resolves layer colors and block colors as needed.

    Returns number

    The RGB color value as a number

    Example

    const rgbColor = entity.rgbColor;
    console.log(`RGB: ${rgbColor.toString(16)}`);

rotation

  • get rotation(): number

  • Gets the rotation value of the block reference.

    The rotation value is relative to the X axis of a coordinate system that is parallel to the OCS of the block reference, but has its origin at the position point of the block reference. The rotation axis is the Z axis of this coordinate system with positive rotations going counterclockwise when looking down the Z axis towards the origin.

    Returns number

    The rotation value in radians

    Example

    const rotation = blockRef.rotation;
    console.log(`Rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
  • set rotation(value: number): void

  • Sets the rotation value of the block reference.

    Parameters

    • value: number

      The new rotation value in radians

    Returns void

    Example

    blockRef.rotation = Math.PI / 4; // 45 degrees

scaleFactors

  • get scaleFactors(): AcGePoint3d

  • Gets the X, Y, and Z scale factors for the block reference.

    Returns AcGePoint3d

    The scale factors as a 3D point

    Example

    const scaleFactors = blockRef.scaleFactors;
    console.log(`Scale factors: ${scaleFactors.x}, ${scaleFactors.y}, ${scaleFactors.z}`);
  • set scaleFactors(value: AcGeVector3dLike): void

  • Sets the X, Y, and Z scale factors for the block reference.

    Parameters

    Returns void

    Example

    blockRef.scaleFactors = new AcGePoint3d(2, 1.5, 1); // 2x X scale, 1.5x Y scale

transparency

type

  • get type(): string

  • Gets the type name of this entity.

    This method returns the entity type by removing the "AcDb" prefix from the constructor name.

    Returns string

    The entity type name

    Example

    const entity = new AcDbLine();
    console.log(entity.type); // "Line"

visibility

  • get visibility(): boolean

  • Gets whether this entity is visible.

    Returns boolean

    True if the entity is visible, false otherwise

    Example

    const isVisible = entity.visibility;
  • set visibility(value: boolean): void

  • Sets whether this entity is visible.

    Parameters

    • value: boolean

      True to make the entity visible, false to hide it

    Returns void

    Example

    entity.visibility = false; // Hide the entity

Methods

appendAttributes

attributeIterator

cell

close

  • close(): void

  • Closes the object.

    All changes made to the object since it was opened are committed to the database, and a "closed" notification is sent. This method can be overridden by subclasses to provide specific cleanup behavior.

    Returns void

    Example

    obj.close();

columnWidth

  • columnWidth(index: number): number

  • Gets the column width at the specified column index in the table.

    Parameters

    • index: number

      Zero-based column index

    Returns number

    The width of the specified column

erase

getAttr

  • getAttr(attrName: string): any

  • Gets the value of the specified attribute.

    This method will throw an exception if the specified attribute doesn't exist. Use getAttrWithoutException() if you want to handle missing attributes gracefully.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute

    Throws

    When the specified attribute doesn't exist

    Example

    try {
      const value = obj.getAttr('objectId');
    } catch (error) {
      console.error('Attribute not found');
    }

getAttrWithoutException

  • getAttrWithoutException(attrName: string): any

  • Gets the value of the specified attribute without throwing an exception.

    This method returns undefined if the specified attribute doesn't exist, making it safer for optional attributes.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute, or undefined if it doesn't exist

    Example

    const value = obj.getAttrWithoutException('optionalAttribute');
    if (value !== undefined) {
      // Use the value
    }

ProtectedgetGeneralProperties

ProtectedgetLayerColor

isEmpty

  • isEmpty(row: number, col: number): boolean

  • Checks if the content of the specified cell is empty.

    Parameters

    • row: number

      Integer specifying the zero-based row index for the cell

    • col: number

      Integer specifying the zero-based column index for the cell

    Returns boolean

    True if the content of the specified cell is empty, false otherwise

numContents

  • numContents(row: number, col: number): number

  • Gets the number of contents in the specified cell.

    Parameters

    • row: number

      Row index. Must be greater than or equal to 0 and less than the number of rows

    • col: number

      Column index. Must be greater than or equal to 0 and less than the number of columns

    Returns number

    The number of contents in the specified cell

rowHeight

  • rowHeight(index: number): number

  • Gets the row height of the specified row in the table.

    Parameters

    • index: number

      Zero-based row index

    Returns number

    The row height of the specified row in the table

setAttr

setCell

setColumnWidth

  • setColumnWidth(index: number, width: number): void

  • Sets the column width at the specified column index in the table.

    Parameters

    • index: number

      Zero-based column index

    • width: number

      Width to be used for the specified column

    Returns void

setRowHeight

  • setRowHeight(index: number, height: number): void

  • Sets the row height for the specified row index in the table.

    Parameters

    • index: number

      Zero-based row index

    • height: number

      Height to be used for the specified row

    Returns void

setTextString

  • setTextString(row: number, col: number, text: string): void

  • Sets the text for the first content at the specified content index.

    Parameters

    • row: number

      Integer specifying the zero-based row index for the cell

    • col: number

      Integer specifying the zero-based column index for the cell

    • text: string

      Text string to set

    Returns void

setUniformColumnWidth

  • setUniformColumnWidth(width: number): void

  • Sets a uniform column width for all the columns in the table.

    Parameters

    • width: number

      Uniform width to be used for all the columns in the table

    Returns void

setUniformRowHeight

  • setUniformRowHeight(height: number): void

  • Sets a uniform row height for all the rows in the table.

    Parameters

    • height: number

      Height to be used for all the rows in the table

    Returns void

subGetGripPoints

subGetOsnapPoints

  • subGetOsnapPoints(
        osnapMode: AcDbOsnapMode,
        pickPoint: AcGeVector3dLike,
        lastPoint: AcGeVector3dLike,
        snapPoints: AcGeVector3dLike[],
        gsMark?: string,
    ): void

  • Gets the object snap points for this mtext.

    Object snap points are precise points that can be used for positioning when drawing or editing. This method provides snap points based on the specified snap mode.

    Parameters

    • osnapMode: AcDbOsnapMode

      The object snap mode

    • pickPoint: AcGeVector3dLike

      The point where the user picked

    • lastPoint: AcGeVector3dLike

      The last point

    • snapPoints: AcGeVector3dLike[]

      Array to populate with snap points

    • OptionalgsMark: string

      The object id of subentity. For now, it is used by INSERT entity only. In AutoCAD, it uses AcGiSubEntityTraits::setSelectionMarkerInput to set GS marker of the subentity involved in the object snap operation. For now, we don't provide such a GS marker mechanism yet. So passed id of subentity as GS marker. Maybe this behavior will change in the future.

    Returns void

subWorldDraw

textString

  • textString(row: number, col: number, content?: number): string

  • Gets the text string in the specified cell.

    Parameters

    • row: number

      Integer specifying the zero-based row index for the cell

    • col: number

      Integer specifying the zero-based column index for the cell

    • Optionalcontent: number

      Content index. Should be greater than or equal to 0 and less than the number of contents

    Returns string

    The text string in the specified cell

transformBy

  • transformBy(matrix: AcGeMatrix3d): this

  • Transforms this entity by the specified matrix.

    This method applies a geometric transformation to the entity. Subclasses should override this method to provide entity-specific transformation behavior.

    Parameters

    Returns this

    This entity after transformation

    Example

    const matrix = AcGeMatrix3d.translation(10, 0, 0);
    entity.transformBy(matrix);

triggerModifiedEvent

worldDraw

  • worldDraw(
        renderer: AcGiRenderer<AcGiEntity>,
        delay?: boolean,
    ): undefined | AcGiEntity

  • Called by cad application when it wants the entity to draw itself in WCS (World Coordinate System) and acts as a wrapper / dispatcher around subWorldDraw(). The children class should never overidde this method.

    It executes the following logic:

    • Handles traits (color, linetype, lineweight, transparency, etc.)
    • Calls subWorldDraw() to do the actual geometry output

    Parameters

    • renderer: AcGiRenderer<AcGiEntity>

      The renderer to use for drawing

    • Optionaldelay: boolean

      The flag to delay creating one rendered entity and just create one dummy entity. Renderer can delay heavy calculation operation to avoid blocking UI when this flag is true. For now, text and mtext entity supports this flag only. Other types of entities just ignore this flag.

    Returns undefined | AcGiEntity

    The rendered entity, or undefined if drawing failed

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods