Class AcDbSymbolTableRecord<ATTRS>

Base class for all symbol table records.

This class provides the fundamental functionality for all symbol table records, including name management and common attributes. Symbol table records represent entries in various symbol tables such as layer tables, linetype tables, text style tables, etc.

Example

class MySymbolTableRecord extends AcDbSymbolTableRecord<MySymbolTableRecordAttrs> {
  constructor(attrs?: Partial<MySymbolTableRecordAttrs>) {
    super(attrs);
  }
}

Type Parameters

ATTRS extends AcDbSymbolTableRecordAttrs = AcDbSymbolTableRecordAttrs
The type of attributes this symbol table record can have

Hierarchy (View Summary)

AcDbObject<ATTRS>
- AcDbSymbolTableRecord

Index

Constructors

constructor

new AcDbSymbolTableRecord<
    ATTRS extends AcDbSymbolTableRecordAttrs = AcDbSymbolTableRecordAttrs,
>(
    attrs?: Partial<ATTRS>,
    defaultAttrs?: Partial<ATTRS>,
): AcDbSymbolTableRecord<ATTRS>
Creates a new AcDbSymbolTableRecord instance.
Type Parameters
- ATTRS extends AcDbSymbolTableRecordAttrs = AcDbSymbolTableRecordAttrs
Parameters
- Optionalattrs: Partial<ATTRS>
  Input attribute values for this symbol table record
- OptionaldefaultAttrs: Partial<ATTRS>
  Default values for attributes of this symbol table record
Returns AcDbSymbolTableRecord<ATTRS>
Example
```
const record = new AcDbSymbolTableRecord({ name: 'MyRecord' });
```
Overrides AcDbObject.constructor
- Defined in data-model/src/database/AcDbSymbolTableRecord.ts:49

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

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

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

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: AcCmStringKey<ATTRS>,
): ATTRS[AcCmStringKey<ATTRS>] & (null | {})
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: AcCmStringKey<ATTRS>
  The name of the attribute to retrieve
Returns ATTRS[AcCmStringKey<ATTRS>] & (null | {})
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: AcCmStringKey<ATTRS>,
): undefined | ATTRS[AcCmStringKey<ATTRS>]
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: AcCmStringKey<ATTRS>
  The name of the attribute to retrieve
Returns undefined | ATTRS[AcCmStringKey<ATTRS>]
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?: ATTRS[A]): void
Sets the value of an attribute.
Type Parameters
- A extends string
Parameters
- attrName: A
  The name of the attribute to set
- Optionalval: ATTRS[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 AcDbSymbolTableRecord<ATTRS>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AcDbSymbolTableRecord<ATTRS>

Example

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

name

Returns string

Example

Parameters

Returns void

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

Methods

close

Returns void

Example

getAttr

Parameters

Returns ATTRS[AcCmStringKey<ATTRS>] & (null | {})

Throws

Example

getAttrWithoutException

Parameters

Returns undefined | ATTRS[AcCmStringKey<ATTRS>]

Example

setAttr

Type Parameters

Parameters

Returns void

Example

Settings

On This Page