Class AcDbSymbolTable<RecordType>

Base class for all symbol tables in AutoCAD.

AcDbSymbolTable is the base class for all classes used to manage AutoCAD's built-in symbol tables. Symbol tables organize and store various types of records such as layers, linetypes, text styles, dimension styles, etc.

Example

class MySymbolTable extends AcDbSymbolTable<MySymbolTableRecord> {
  constructor(db: AcDbDatabase) {
    super(db);
  }
}

Type Parameters

RecordType extends AcDbSymbolTableRecord = AcDbSymbolTableRecord
The type of records this symbol table manages

Hierarchy (View Summary)

AcDbObject
- AcDbSymbolTable

Index

Constructors

constructor

new AcDbSymbolTable<
    RecordType extends
        AcDbSymbolTableRecord<AcDbSymbolTableRecordAttrs> = AcDbSymbolTableRecord<
        AcDbSymbolTableRecordAttrs,
    >,
>(
    db: AcDbDatabase,
): AcDbSymbolTable<RecordType>
Creates a new AcDbSymbolTable instance.
Type Parameters
- RecordType extends AcDbSymbolTableRecord<AcDbSymbolTableRecordAttrs> = AcDbSymbolTableRecord<AcDbSymbolTableRecordAttrs>
Parameters
- db: AcDbDatabase
  The database this symbol table belongs to
Returns AcDbSymbolTable<RecordType>
Example
```
const symbolTable = new AcDbSymbolTable(database);
```
Overrides AcDbObject.constructor
- Defined in data-model/src/database/AcDbSymbolTable.ts:42

Properties

`Protected`_recordsById

_recordsById: Map<string, RecordType>

Map of records indexed by object ID

`Protected`_recordsByName

_recordsByName: Map<string, RecordType>

Map of records indexed by name

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

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

add

add(record: RecordType): void
Adds a record to both the database containing the table and the table itself.
Parameters
- record: RecordType
  The record to add to the table
Returns void
Example
```
const record = new AcDbSymbolTableRecord({ name: 'MyRecord' });
symbolTable.add(record);
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:60

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

getAt

getAt(name: string): undefined | RecordType
Searches the table for a record with the specified name.
Parameters
- name: string
  The name to search for
Returns undefined | RecordType
The record with the specified name, or undefined if not found
Example
```
const record = symbolTable.getAt('MyRecord');
if (record) {
  console.log('Found record:', record.name);
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:176

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

getIdAt

getIdAt(id: string): undefined | RecordType
Searches the table for a record with the specified ID.
Parameters
- id: string
  The ID to search for
Returns undefined | RecordType
The record with the specified ID, or undefined if not found
Example
```
const record = symbolTable.getIdAt('some-object-id');
if (record) {
  console.log('Found record:', record.name);
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:194

getOwnerIdAt

getOwnerIdAt(id: string): undefined | RecordType
Gets the owner ID of a record with the specified ID.
Parameters
- id: string
  The ID to search for
Returns undefined | RecordType
The record with the specified ID, or undefined if not found
Example
```
const record = symbolTable.getOwnerIdAt('some-object-id');
if (record) {
  console.log('Owner ID:', record.ownerId);
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:212

has

has(name: string): boolean
Checks if the table contains a record with the specified name.
Parameters
- name: string
  The name to search for
Returns boolean
True if a record with the specified name exists, false otherwise
Example
```
if (symbolTable.has('MyRecord')) {
  console.log('Record exists');
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:141

hasId

hasId(id: string): boolean
Checks if the table contains a record with the specified ID.
Parameters
- id: string
  The ID to search for
Returns boolean
True if a record with the specified ID exists, false otherwise
Example
```
if (symbolTable.hasId('some-object-id')) {
  console.log('Record exists');
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:158

newIterator

newIterator(): AcDbObjectIterator<RecordType>
Creates an iterator object that can be used to iterate over the records in the table.

Returns AcDbObjectIterator<RecordType>
An iterator object that can be used to iterate over the records
Example
```
const iterator = symbolTable.newIterator();
for (const record of iterator) {
  console.log('Record:', record.name);
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:229

remove

remove(name: string): boolean
Removes the record with the specified name.
Parameters
- name: string
  The name of the record to remove
Returns boolean
True if the record was found and removed, false otherwise
Example
```
const removed = symbolTable.remove('MyRecord');
if (removed) {
  console.log('Record removed successfully');
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:80

removeAll

removeAll(): void
Removes all records from the table.

Returns void
Example
```
symbolTable.removeAll();
console.log('All records removed');
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:123

removeId

removeId(id: string): boolean
Removes the record with the specified ID.
Parameters
- id: string
  The object ID of the record to remove
Returns boolean
True if the record was found and removed, false otherwise
Example
```
const removed = symbolTable.removeId('some-object-id');
if (removed) {
  console.log('Record removed successfully');
}
```
- Defined in data-model/src/database/AcDbSymbolTable.ts:104

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 AcDbSymbolTable<RecordType>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AcDbSymbolTable<RecordType>

Example

Properties

Protected_recordsById

Protected_recordsByName

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

Methods

add

Parameters

Returns void

Example

close

Returns void

Example

getAt

Parameters

Returns undefined | RecordType

Example

getAttr

Parameters

Returns any

Throws

Example

getAttrWithoutException

Parameters

Returns any

Example

getIdAt

Parameters

Returns undefined | RecordType

Example

getOwnerIdAt

Parameters

Returns undefined | RecordType

Example

has

Parameters

Returns boolean

Example

hasId

Parameters

Returns boolean

Example

newIterator

Returns AcDbObjectIterator<RecordType>

Example

`Protected`_recordsById

`Protected`_recordsByName