Class AcDbLayoutDictionary

Dictionary for storing and managing AcDbLayout objects.

This class extends AcDbDictionary to provide specialized functionality for managing layout objects, including searching by block table record ID and tracking the maximum tab order.

Example

const layoutDict = new AcDbLayoutDictionary(database);
const layout = layoutDict.getBtrIdAt('some-block-id');
const maxOrder = layoutDict.maxTabOrder;

Hierarchy (View Summary)

Constructors

constructor

Properties

_recordsById _recordsByName

Accessors

attrs database extensionDictionary maxTabOrder numEntries objectId ownerId

Methods

close createExtensionDictionary getAt getAttr getAttrWithoutException getBtrIdAt getIdAt getXData has hasId newIterator remove removeAll removeId removeXData setAt setAttr setXData

Constructors

constructor

Properties

Protected_recordsById

_recordsById: Map<string, AcDbLayout>

Map of records indexed by object ID

Protected_recordsByName

_recordsByName: Map<string, AcDbLayout>

Map of records indexed by name

Accessors

attrs

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

maxTabOrder

  • get maxTabOrder(): number

  • Gets the maximum tab order value of layouts in the layout dictionary.

    Returns number

    The maximum tab order value, or -1 if no layouts exist

    Example

    const maxOrder = layoutDict.maxTabOrder;
    console.log('Maximum tab order:', maxOrder);

numEntries

  • get numEntries(): number

  • Gets the number of entries in the dictionary.

    Returns number

    The number of entries in the dictionary

    Example

    const count = dictionary.numEntries;
    console.log(`Dictionary has ${count} entries`);

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

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

getAt

  • getAt(name: string): undefined | AcDbLayout

  • Gets the object with the specified name from the dictionary.

    Parameters

    • name: string

      Name of the object to retrieve

    Returns undefined | AcDbLayout

    The object with the specified name, or undefined if not found

    Example

    const layout = dictionary.getAt('MyLayout');
    if (layout) {
      console.log('Layout found:', layout);
    }

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
    }

getBtrIdAt

  • getBtrIdAt(id: string): undefined | AcDbLayout

  • Searches the dictionary for a layout associated with the specified block table record ID.

    Parameters

    • id: string

      The block table record ID to search for

    Returns undefined | AcDbLayout

    The layout associated with the block table record ID, or undefined if not found

    Example

    const layout = layoutDict.getBtrIdAt('some-block-id');
    if (layout) {
      console.log('Found layout:', layout.layoutName);
    }

getIdAt

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
    }

has

  • has(name: string): boolean

  • Checks if the dictionary contains an object with the specified name.

    Parameters

    • name: string

      Name to search for

    Returns boolean

    True if the dictionary contains an object with the specified name, false otherwise

    Example

    if (dictionary.has('MyLayout')) {
      console.log('Layout exists');
    }

hasId

  • hasId(id: string): boolean

  • Checks if the dictionary contains an object with the specified ID.

    Parameters

    • id: string

      ID to search for

    Returns boolean

    True if the dictionary contains an object with the specified ID, false otherwise

    Example

    if (dictionary.hasId('some-object-id')) {
      console.log('Object exists');
    }

newIterator

remove

  • remove(name: string): boolean

  • Removes the entry specified by name from the dictionary.

    Parameters

    • name: string

      String representing the entry's key (or name)

    Returns boolean

    True if the entry was found and removed, false otherwise

    Example

    const removed = dictionary.remove('MyLayout');
    if (removed) {
      console.log('Layout removed successfully');
    }

removeAll

removeId

  • removeId(id: string): boolean

  • Removes the entry specified by object ID from the dictionary.

    Parameters

    • id: string

      ID of the object to delete

    Returns boolean

    True if the entry was found and removed, false otherwise

    Example

    const removed = dictionary.removeId('some-object-id');

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

setAt

  • setAt(key: string, value: AcDbLayout): void

  • Adds a new entry to the dictionary.

    If an entry with the specified key already exists, the existing entry is erased and replaced with the new one.

    Parameters

    • key: string

      String representing the object's search key name

    • value: AcDbLayout

      The new object to add to the dictionary

    Returns void

    Example

    const layout = new AcDbLayout();
    dictionary.setAt('MyLayout', layout);

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
Properties
Accessors
Methods