Class AcDbTextStyleTableRecord

Represents a record in the text style table.

This class represents the records that are found in the text style table (known as the "style" table in DXF). Each of these records represents a specific set of text parameters such as font, default size, relative x scaling, vertical or horizontal orientation, etc.

Example

const textStyle = new AcGiBaseTextStyle();
textStyle.name = 'MyStyle';
textStyle.font = 'Arial';
const record = new AcDbTextStyleTableRecord(textStyle);

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs bigFontFileName database extensionDictionary fileName isVertical name objectId obliquingAngle ownerId priorSize textSize textStyle xScale

Methods

close createExtensionDictionary getAttr getAttrWithoutException getXData removeXData setAttr setXData

Constructors

constructor

Accessors

attrs

bigFontFileName

  • get bigFontFileName(): string

  • Gets or sets the name of the big font file for this text style.

    Big font files are used for languages that require more than 256 characters, such as Chinese, Japanese, and Korean.

    Returns string

    The big font file name

    Example

    const bigFontFileName = record.bigFontFileName;
    record.bigFontFileName = 'bigfont.shx';
  • set bigFontFileName(value: string): void

  • Parameters

    • value: string

    Returns void

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;

extensionDictionary

  • get extensionDictionary(): undefined | string

  • Gets the objectId of the extension dictionary owned by this object.

    If the object does not have an extension dictionary, this returns undefined.

    In ObjectARX terms, this is equivalent to AcDbObject::extensionDictionary().

    Returns undefined | string

    The extension dictionary objectId, or undefined

    Example

    const dictId = obj.extensionDictionary
    if (dictId) {
      console.log('Has extension dictionary:', dictId)
    }
  • set extensionDictionary(value: undefined | string): void

  • Sets the objectId of the extension dictionary owned by this object.

    This does not create or delete the dictionary object itself — it only establishes or clears the ownership relationship.

    Passing undefined removes the association.

    Parameters

    • value: undefined | string

      The extension dictionary objectId, or undefined

    Returns void

    Example

    obj.extensionDictionary = dict.objectId

fileName

isVertical

name

  • get name(): string

  • Gets or sets the name of the symbol table record.

    This property corresponds to DXF group code 2 and is used for identifying and referencing the symbol table record.

    Returns string

    The name of the symbol table record

    Example

    const recordName = record.name;
    record.name = 'NewRecordName';
  • set name(value: string): void

  • Parameters

    • value: string

    Returns void

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';

obliquingAngle

  • get obliquingAngle(): number

  • Gets or sets the obliquing angle.

    The obliquing angle is the angle from the text's vertical; that is, the top of the text "slants" relative to the bottom--the same as the slope in this italic text. Positive angles slant characters forward at their tops. Negative angles have 2pi added to them to convert them to their positive equivalent.

    Returns number

    The obliquing angle in radians

    Example

    const angle = record.obliquingAngle;
    record.obliquingAngle = Math.PI / 6; // 30 degrees
  • set obliquingAngle(value: number): void

  • Parameters

    • value: number

    Returns void

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';

priorSize

  • get priorSize(): number

  • Gets or sets the text height used for the last text created using this text style.

    This value is updated automatically by AutoCAD after the creation of any text object that references this text style table record. If the textSize value for this text style is 0, then the priorSize value is used by AutoCAD as the default text height for the next text created using this text style.

    This value is automatically changed by the use of the text command. It will only be automatically changed if the textSize is set to 0 so that users are prompted for a height.

    Returns number

    The prior text size

    Example

    const priorSize = record.priorSize;
    record.priorSize = 12.0;
  • set priorSize(value: number): void

  • Parameters

    • value: number

    Returns void

textSize

  • get textSize(): number

  • Gets or sets the default size of the text drawn with this text style.

    If the text size is set to 0, then each use of the AutoCAD text commands prompt for a text height to use in creating the text entity. If textSize is non-zero, the text command will not prompt for a text height and will use this value.

    Returns number

    The default text size

    Example

    const textSize = record.textSize;
    record.textSize = 10.0; // Fixed text height
  • set textSize(value: number): void

  • Parameters

    • value: number

    Returns void

textStyle

xScale

  • get xScale(): number

  • Gets or sets the width factor (also referred to as the relative X-scale factor) for the text style.

    The width factor is applied to the text's width to allow the width to be adjusted independently of the height. For example, if the width factor value is 0.8, then the text is drawn with a width that is 80% of its normal "unadjusted" width.

    Returns number

    The width factor

    Example

    const xScale = record.xScale;
    record.xScale = 0.8; // 80% width
  • set xScale(value: number): void

  • Parameters

    • value: number

    Returns void

Methods

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();

createExtensionDictionary

  • createExtensionDictionary(): undefined | string

  • Creates the extension dictionary for this object if it does not already exist.

    This method closely mirrors the behavior of AcDbObject::createExtensionDictionary() in ObjectARX.

    • If the object already owns an extension dictionary, no new dictionary is created and the existing dictionary's objectId is returned.
    • Otherwise, a new AcDbDictionary is created, added to the same database, owned by this object, and its objectId is stored on this object.

    Returns undefined | string

    The objectId of the extension dictionary

    Example

    const dictId = obj.createExtensionDictionary()

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
    }

getXData

  • getXData(appId: string): undefined | AcDbResultBuffer

  • Retrieves the XData associated with this object for a given application ID.

    Extended Entity Data (XData) allows applications to attach arbitrary, application-specific data to an AcDbObject. Each XData entry is identified by a registered application name (AppId) and stored as an AcDbResultBuffer.

    This method is conceptually equivalent to AcDbObject::xData() in ObjectARX, but simplified to return the entire result buffer for the specified AppId.

    Parameters

    • appId: string

      The application ID (registered AppId name) that owns the XData

    Returns undefined | AcDbResultBuffer

    The AcDbResultBuffer associated with the AppId, or undefined if no XData exists for that AppId

    Example

    const xdata = obj.getXData('MY_APP')
    if (xdata) {
      // Read values from the result buffer
    }

removeXData

  • removeXData(appId: string): void

  • Removes the XData associated with the specified application ID.

    After removal, calls to getXData() for the same AppId will return undefined. If no XData exists for the given AppId, this method has no effect.

    This mirrors the behavior of clearing XData for a specific application in ObjectARX rather than removing all XData from the object.

    Parameters

    • appId: string

      The application ID whose XData should be removed

    Returns void

    Example

    obj.removeXData('MY_APP')

setAttr

setXData

  • setXData(resbuf: AcDbResultBuffer): void

  • Attaches or replaces XData for this object.

    If XData already exists for the given AppId, it is replaced by the provided AcDbResultBuffer. The caller is responsible for ensuring that:

    • The AppId is registered in the database's AppId table
    • The result buffer follows valid DXF/XData conventions (e.g. starts with a 1001 group code for the AppId)

    This method is conceptually similar to AcDbObject::setXData() in ObjectARX.

    Parameters

    Returns void

    Example

    const rb = new AcDbResultBuffer([
      { code: AcDbDxfCode.ExtendedDataRegAppName, value: 'MY_APP' },
      { code: AcDbDxfCode.ExtendedDataAsciiString, value: 'custom value' }
    ])

    obj.setXData('MY_APP', rb)

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods