Class AcDbLayout

Represents the stored characteristics of each paperspace layout.

Layout objects are stored in an AcDbDictionary object with an ACAD_LAYOUT key, allowing easy iteration and indexing. Each layout represents a paperspace configuration that can be used for printing or plotting.

Example

const layout = new AcDbLayout();
layout.layoutName = 'A4 Landscape';
layout.tabOrder = 1;
layout.limits = new AcGeBox2d();

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs blockTableRecordId database extensionDictionary extents layoutName limits objectId ownerId tabOrder tabSelected

Methods

close createExtensionDictionary getAttr getAttrWithoutException getXData removeXData setAttr setXData

Constructors

constructor

Accessors

attrs

blockTableRecordId

  • get blockTableRecordId(): string

  • Gets the associated block table record ID of this layout.

    Returns string

    The block table record ID

    Example

    const blockId = layout.blockTableRecordId;
  • set blockTableRecordId(value: string): void

  • Sets the associated block table record ID of this layout.

    Parameters

    • value: string

      The new block table record ID

    Returns void

    Example

    layout.blockTableRecordId = 'some-block-id';

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

extents

  • get extents(): AcGeBox3d

  • Gets the current extents setting of the layout.

    This value may not be the actual extents of the geometry in the layout, it is just the value last saved in the layout.

    Returns AcGeBox3d

    The layout extents as a 3D bounding box

    Example

    const extents = layout.extents;
    console.log('Layout extents:', extents);
  • set extents(value: AcGeBox3d): void

  • Sets the current extents setting of the layout.

    Parameters

    • value: AcGeBox3d

      The new layout extents as a 3D bounding box

    Returns void

    Example

    layout.extents = new AcGeBox3d();

layoutName

  • get layoutName(): string

  • Gets the user-friendly layout name that is displayed in the tab control.

    Currently there is no restriction on the name except that the length is limited to 256 characters.

    Returns string

    The layout name

    Example

    const name = layout.layoutName;
    console.log('Layout name:', name);
  • set layoutName(value: string): void

  • Sets the user-friendly layout name that is displayed in the tab control.

    Parameters

    • value: string

      The new layout name (limited to 256 characters)

    Returns void

    Example

    layout.layoutName = 'A4 Landscape';

limits

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

tabOrder

  • get tabOrder(): number

  • Gets the tab order field, which controls the order in which layouts are displayed.

    The tab order should be unique and sequential for each layout in the database.

    Returns number

    The tab order value

    Example

    const order = layout.tabOrder;
  • set tabOrder(value: number): void

  • Sets the tab order field, which controls the order in which layouts are displayed.

    Parameters

    • value: number

      The new tab order value

    Returns void

    Example

    layout.tabOrder = 1;

tabSelected

  • get tabSelected(): boolean

  • Gets whether the layout tab is included in the selection set for operations.

    This flag indicates whether the layout tab is included in the selection set for operations that affect multiple tabs. The user can perform multiple selection via the user interface using shift-click.

    Returns boolean

    True if the tab is selected, false otherwise

    Example

    const isSelected = layout.tabSelected;
  • set tabSelected(value: boolean): void

  • Sets whether the layout tab is included in the selection set for operations.

    Parameters

    • value: boolean

      True to select the tab, false to deselect it

    Returns void

    Example

    layout.tabSelected = true;

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