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)

AcDbObject
- AcDbLayout

Index

Constructors

constructor

new AcDbLayout(): AcDbLayout
Creates a new AcDbLayout instance.

Returns AcDbLayout
Example
```
const layout = new AcDbLayout();
```
Overrides AcDbObject.constructor
- Defined in data-model/src/object/layout/AcDbLayout.ts:42

Accessors

attrs

get attrs(): AcCmObject<ATTRS>
Gets the attributes object for this AcDbObject.

Returns AcCmObject<ATTRS>
The AcCmObject instance containing all attributes
Example
```
const attrs = obj.attrs;
const value = attrs.get('someAttribute');
```
Inherited from AcDbObject.attrs
- Defined in data-model/src/base/AcDbObject.ts:80

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;
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:156
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';
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:170

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;
```
Inherited from AcDbObject.database
- Defined in data-model/src/base/AcDbObject.ts:223
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
- db: AcDbDatabase
  The database to associate with this object
Returns void
Example
```
obj.database = myDatabase;
```
Inherited from AcDbObject.database
- Defined in data-model/src/base/AcDbObject.ts:242

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);
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:219
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();
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:233

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);
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:66
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';
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:80

limits

get limits(): AcGeBox2d
Gets the limits for this layout.

Limits are defined by LIMMAX while this layout is current.

Returns AcGeBox2d
The layout limits as a 2D bounding box
Example
```
const limits = layout.limits;
console.log('Layout limits:', limits);
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:187
set limits(value: AcGeBox2d): void
Sets the limits for this layout.
Parameters
- value: AcGeBox2d
  The new layout limits as a 2D bounding box
Returns void
Example
```
layout.limits = new AcGeBox2d();
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:201

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}`);
```
Inherited from AcDbObject.objectId
- Defined in data-model/src/base/AcDbObject.ts:163
set objectId(value: string): void
Sets the object ID.
Parameters
- value: string
  The new object ID
Returns void
Example
```
obj.objectId = 'new-object-id';
```
Inherited from AcDbObject.objectId
- Defined in data-model/src/base/AcDbObject.ts:177

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;
```
Inherited from AcDbObject.ownerId
- Defined in data-model/src/base/AcDbObject.ts:191
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';
```
Inherited from AcDbObject.ownerId
- Defined in data-model/src/base/AcDbObject.ts:205

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;
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:96
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;
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:110

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;
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:128
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;
```
- Defined in data-model/src/object/layout/AcDbLayout.ts:142

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();
```
Inherited from AcDbObject.close
- Defined in data-model/src/base/AcDbObject.ts:258

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');
}
```
Inherited from AcDbObject.getAttr
- Defined in data-model/src/base/AcDbObject.ts:103

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
}
```
Inherited from AcDbObject.getAttrWithoutException
- Defined in data-model/src/base/AcDbObject.ts:130

setAttr

setAttr<A extends string>(attrName: A, val?: AcDbObjectAttrs[A]): void
Sets the value of an attribute.
Type Parameters
- A extends string
Parameters
- attrName: A
  The name of the attribute to set
- Optionalval: AcDbObjectAttrs[A]
  The value to assign to the attribute
Returns void
Example
```
obj.setAttr('objectId', 'new-id-123');
```
Inherited from AcDbObject.setAttr
- Defined in data-model/src/base/AcDbObject.ts:145

Class AcDbLayout

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns AcDbLayout

Example

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

blockTableRecordId

Returns string

Example

Parameters

Returns void

Example

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

extents

Returns AcGeBox3d

Example

Parameters

Returns void

Example

layoutName

Returns string

Example

Parameters

Returns void

Example

limits

Returns AcGeBox2d

Example

Parameters

Returns void

Example

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

tabOrder

Returns number

Example

Parameters

Returns void

Example

tabSelected

Returns boolean

Example

Parameters

Returns void

Example

Methods

close

Returns void

Example

getAttr

Parameters

Returns any

Throws

Example

getAttrWithoutException

Parameters