Class AcDbLayerTableRecord

Represents a record in the layer table.

This class contains information about a layer in the drawing database, including color, visibility settings, linetype, and other layer properties. Layers are used to organize and control the display of entities in the drawing.

Example

const layer = new AcDbLayerTableRecord({
  name: 'MyLayer',
  color: new AcCmColor(255, 0, 0), // Red
  isOff: false,
  isPlottable: true
});

Hierarchy (View Summary)

AcDbSymbolTableRecord<AcDbLayerTableRecordAttrs>
- AcDbLayerTableRecord

Index

Constructors

constructor

new AcDbLayerTableRecord(
attrs?: Partial<AcDbLayerTableRecordAttrs>,
defaultAttrs?: Partial<AcDbLayerTableRecordAttrs>,
): AcDbLayerTableRecord
Creates a new AcDbLayerTableRecord instance.
Parameters
- Optionalattrs: Partial<AcDbLayerTableRecordAttrs>
  Input attribute values for this layer table record
- OptionaldefaultAttrs: Partial<AcDbLayerTableRecordAttrs>
  Default values for attributes of this layer table record
Returns AcDbLayerTableRecord
Example
```
const layer = new AcDbLayerTableRecord({
  name: 'MyLayer',
  color: new AcCmColor(255, 0, 0)
});
```
Overrides AcDbSymbolTableRecord.constructor
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:71

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 AcDbSymbolTableRecord.attrs
- Defined in data-model/src/base/AcDbObject.ts:80

color

get color(): AcCmColor
Gets or sets the color value of this layer.

Returns AcCmColor
The color of the layer
Example
```
const color = layer.color;
layer.color = new AcCmColor(255, 0, 0); // Red
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:110
set color(value: AcCmColor): void
Parameters
- value: AcCmColor
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:113

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 AcDbSymbolTableRecord.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 AcDbSymbolTableRecord.database
- Defined in data-model/src/base/AcDbObject.ts:242

description

get description(): string
Gets or sets the description of this layer.

Returns string
The description of the layer
Example
```
const description = layer.description;
layer.description = 'My custom layer';
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:128
set description(value: string): void
Parameters
- value: string
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:131

isFrozen

get isFrozen(): boolean
Gets or sets whether this layer is frozen.

When a layer is frozen, its entities are not displayed and cannot be modified.

Returns boolean
True if the layer is frozen, false otherwise
Example
```
if (layer.isFrozen) {
  console.log('Layer is frozen');
}
layer.isFrozen = true;
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:176
set isFrozen(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:179

isHidden

get isHidden(): boolean
Gets or sets whether this layer is hidden.

When a layer is hidden, it isn't shown in the user interface of the host application, but entities on the layer are still displayed.

Returns boolean
True if the layer is hidden, false otherwise
Example
```
if (layer.isHidden) {
  console.log('Layer is hidden from UI');
}
layer.isHidden = true;
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:200
set isHidden(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:203

isInUse

get isInUse(): boolean
Gets or sets whether this layer is in use.

A layer is considered in use if it contains entities or is referenced by other objects in the drawing.

Returns boolean
True if the layer is in use, false otherwise
Example
```
if (layer.isInUse) {
  console.log('Layer contains entities');
}
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:222
set isInUse(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:225

isLocked

get isLocked(): boolean
Gets or sets whether this layer is locked.

When a layer is locked, its entities cannot be modified but are still visible.

Returns boolean
True if the layer is locked, false otherwise
Example
```
if (layer.isLocked) {
  console.log('Layer is locked');
}
layer.isLocked = true;
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:244
set isLocked(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:247

isOff

get isOff(): boolean
Gets or sets whether this layer is turned off.

When a layer is turned off, its entities are not displayed but can still be modified.

Returns boolean
True if the layer is turned off, false otherwise
Example
```
if (layer.isOff) {
  console.log('Layer is turned off');
}
layer.isOff = true;
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:267
set isOff(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:270

isPlottable

get isPlottable(): boolean
Gets or sets whether this layer is plottable.

When a layer is plottable, its entities will be included when the drawing is plotted or printed.

Returns boolean
True if the layer is plottable, false otherwise
Example
```
if (layer.isPlottable) {
  console.log('Layer will be included in plots');
}
layer.isPlottable = false;
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:289
set isPlottable(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:292

linetype

get linetype(): string
Gets or sets the linetype name for this layer.

The linetype defines the pattern of dashes, dots, and spaces used to display lines and curves on this layer.

Returns string
The linetype name
Example
```
const linetype = layer.linetype;
layer.linetype = 'DASHED';
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:330
set linetype(value: string): void
Parameters
- value: string
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:333

lineWeight

get lineWeight(): number
Gets or sets the line weight for this layer.

Line weight determines the thickness of lines and curves on this layer.

Returns number
The line weight value
Example
```
const weight = layer.lineWeight;
layer.lineWeight = 2.0; // 2.0mm line weight
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:350
set lineWeight(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:353

materialId

get materialId(): string
Gets or sets the material ID associated with this layer.

Material IDs are used for rendering and visualization purposes.

Returns string
The material ID
Example
```
const materialId = layer.materialId;
layer.materialId = 'concrete';
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:370
set materialId(value: string): void
Parameters
- value: string
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:373

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';
```
Inherited from AcDbSymbolTableRecord.name
- Defined in data-model/src/database/AcDbSymbolTableRecord.ts:69
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from AcDbSymbolTableRecord.name
- Defined in data-model/src/database/AcDbSymbolTableRecord.ts:72

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 AcDbSymbolTableRecord.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 AcDbSymbolTableRecord.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 AcDbSymbolTableRecord.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 AcDbSymbolTableRecord.ownerId
- Defined in data-model/src/base/AcDbObject.ts:205

standardFlags

get standardFlags(): number
Gets or sets the standard flags for this layer.

Standard flags are bit-coded values:
- 1 = Layer is frozen; otherwise layer is thawed
- 2 = Layer is frozen by default in new viewports
- 4 = Layer is locked
- 16 = If set, table entry is externally dependent on an xref
- 32 = If both this bit and bit 16 are set, the externally dependent xref has been successfully resolved
- 64 = If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited
Returns number
The standard flags value
Example
```
const flags = layer.standardFlags;
layer.standardFlags = 1; // Freeze the layer
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:154
set standardFlags(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:157

transparency

get transparency(): number
Gets or sets the transparency level of this layer.

Transparency values range from 0 (opaque) to 1 (fully transparent).

Returns number
The transparency level (0-1)
Example
```
const transparency = layer.transparency;
layer.transparency = 0.5; // 50% transparent
```
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:309
set transparency(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbLayerTableRecord.ts:312

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

setAttr

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

Class AcDbLayerTableRecord

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcDbLayerTableRecord

Example

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

color

Returns AcCmColor

Example

Parameters

Returns void

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

description

Returns string

Example

Parameters

Returns void

isFrozen

Returns boolean

Example

Parameters

Returns void

isHidden

Returns boolean

Example

Parameters

Returns void

isInUse

Returns boolean

Example

Parameters

Returns void

isLocked

Returns boolean

Example

Parameters

Returns void

isOff

Returns boolean

Example

Parameters

Returns void

isPlottable

Returns boolean

Example

Parameters

Returns void

linetype

Returns string

Example

Parameters

Returns void

lineWeight

Returns number

Example

Parameters

Returns void

materialId

Returns string

Example

Parameters

Returns void

name

Returns string

Example