@mlightcad/data-model
Version:
The data-model package provides the core classes for interacting with AutoCAD's database and entities. This package mimics AutoCAD ObjectARX's AcDb (Database) classes and implements the drawing database structure that AutoCAD developers are familiar with.
47 lines • 1.62 kB
TypeScript
import { AcDbObjectId } from '../../base';
import { AcDbDictionary } from '../AcDbDictionary';
import { AcDbLayout } from './AcDbLayout';
/**
* 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
* ```typescript
* const layoutDict = new AcDbLayoutDictionary(database);
* const layout = layoutDict.getBtrIdAt('some-block-id');
* const maxOrder = layoutDict.maxTabOrder;
* ```
*/
export declare class AcDbLayoutDictionary extends AcDbDictionary<AcDbLayout> {
/**
* Searches the dictionary for a layout associated with the specified block table record ID.
*
* @param id - The block table record ID to search for
* @returns The layout associated with the block table record ID, or undefined if not found
*
* @example
* ```typescript
* const layout = layoutDict.getBtrIdAt('some-block-id');
* if (layout) {
* console.log('Found layout:', layout.layoutName);
* }
* ```
*/
getBtrIdAt(id: AcDbObjectId): AcDbLayout | undefined;
/**
* Gets the maximum tab order value of layouts in the layout dictionary.
*
* @returns The maximum tab order value, or -1 if no layouts exist
*
* @example
* ```typescript
* const maxOrder = layoutDict.maxTabOrder;
* console.log('Maximum tab order:', maxOrder);
* ```
*/
get maxTabOrder(): number;
}
//# sourceMappingURL=AcDbLayoutDictionary.d.ts.map