Class AcDbDatabase

The AcDbDatabase class represents an AutoCAD drawing file.

Each AcDbDatabase object contains the various header variables, symbol tables, table records, entities, and objects that make up the drawing. The AcDbDatabase class has member functions to allow access to all the symbol tables, to read and write to DWG files, to get or set database defaults, to execute various database-level operations, and to get or set all header variables.

Example

const database = new AcDbDatabase();
await database.read(dxfData, { readOnly: true });
const entities = database.tables.blockTable.modelSpace.entities;

Hierarchy (View Summary)

AcDbObject
- AcDbDatabase

Index

Constructors

constructor

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

Returns AcDbDatabase
Overrides AcDbObject.constructor
- Defined in data-model/src/database/AcDbDatabase.ts:279

Properties

`Readonly`events

events: {
    entityAppended: AcCmEventManager<AcDbEntityEventArgs>;
    entityModified: AcCmEventManager<AcDbEntityEventArgs>;
    headerSysVarChanged: AcCmEventManager<AcDbHeaderSysVarEventArgs>;
    layerAppended: AcCmEventManager<AcDbLayerEventArgs>;
    layerErased: AcCmEventManager<AcDbLayerEventArgs>;
    layerModified: AcCmEventManager<AcDbLayerModifiedEventArgs>;
    openProgress: AcCmEventManager<AcDbProgressdEventArgs>;
} = ...

Events that can be triggered by the database.

These events allow applications to respond to various database operations such as entity modifications, layer changes, and progress updates.

Type declaration

entityAppended: AcCmEventManager<AcDbEntityEventArgs>
Fired when an entity is appended to the database
entityModified: AcCmEventManager<AcDbEntityEventArgs>
Fired when an entity is modified in the database
headerSysVarChanged: AcCmEventManager<AcDbHeaderSysVarEventArgs>
Fired when a header system variable is changed
layerAppended: AcCmEventManager<AcDbLayerEventArgs>
Fired when a layer is appended to the database
layerErased: AcCmEventManager<AcDbLayerEventArgs>
Fired when a layer is erased from the database
layerModified: AcCmEventManager<AcDbLayerModifiedEventArgs>
Fired when a layer is modified in the database
openProgress: AcCmEventManager<AcDbProgressdEventArgs>
Fired during database opening operations to report progress

Accessors

angBase

get angBase(): number
The zero (0) base angle with respect to the current UCS in radians.

Returns number
- Defined in data-model/src/database/AcDbDatabase.ts:514
set angBase(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbDatabase.ts:517

angDir

get angDir(): number
The direction of positive angles.
- 0: Counterclockwise
- 1: Clockwise
Returns number
- Defined in data-model/src/database/AcDbDatabase.ts:527
set angDir(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbDatabase.ts:530

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

aunits

get aunits(): number
Gets the angle units for the database.

This is the current AUNITS value for the database.

Returns number
The angle units value
Example
```
const angleUnits = database.aunits;
```
- Defined in data-model/src/database/AcDbDatabase.ts:389
set aunits(value: number): void
Sets the angle units for the database.
Parameters
- value: number
  The new angle units value
Returns void
Example
```
database.aunits = AcDbAngleUnits.DecimalDegrees;
```
- Defined in data-model/src/database/AcDbDatabase.ts:403

cecolor

get cecolor(): AcCmColor
Gets the color of new objects as they are created.

Returns AcCmColor
The current entity color
Example
```
const currentColor = database.cecolor;
```
- Defined in data-model/src/database/AcDbDatabase.ts:479
set cecolor(value: AcCmColor): void
Sets the color of new objects as they are created.
Parameters
- value: AcCmColor
  The new current entity color
Returns void
Example
```
database.cecolor = new AcCmColor(0xFF0000);
```
- Defined in data-model/src/database/AcDbDatabase.ts:493

celtscale

get celtscale(): number
The line type scaling for new objects relative to the ltscale setting. A line created with celtscale = 2 in a drawing with ltscale set to 0.5 would appear the same as a line created with celtscale = 1 in a drawing with ltscale = 1.

Returns number
- Defined in data-model/src/database/AcDbDatabase.ts:503
set celtscale(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbDatabase.ts:506

currentSpaceId

get currentSpaceId(): string
Gets the object ID of the AcDbBlockTableRecord of the current space.

The current space can be either model space or paper space.

Returns string
The object ID of the current space
Example
```
const currentSpaceId = database.currentSpaceId;
```
- Defined in data-model/src/database/AcDbDatabase.ts:348
set currentSpaceId(value: string): void
Sets the current space by object ID.
Parameters
- value: string
  The object ID of the block table record to set as current space
Returns void
Throws
When the specified block table record ID doesn't exist
Example
```
database.currentSpaceId = 'some-block-record-id';
```
- Defined in data-model/src/database/AcDbDatabase.ts:366

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

dictionaries

get dictionaries(): {
imageDefs: AcDbDictionary<AcDbRasterImageDef>;
layouts: AcDbLayoutDictionary;
}
Gets all named object dictionaries in this drawing database.

Returns { imageDefs: AcDbDictionary<AcDbRasterImageDef>; layouts: AcDbLayoutDictionary }
Object containing all the dictionaries in the database
Example
```
const dictionaries = database.dictionaries;
const layouts = dictionaries.layouts;
```
- Defined in data-model/src/database/AcDbDatabase.ts:332

insunits

get insunits(): number
Gets the drawing-units value for automatic scaling of blocks, images, or xrefs.

This is the current INSUNITS value for the database.

Returns number
The insertion units value
Example
```
const insertionUnits = database.insunits;
```
- Defined in data-model/src/database/AcDbDatabase.ts:420
set insunits(value: number): void
Sets the drawing-units value for automatic scaling.
Parameters
- value: number
  The new insertion units value
Returns void
Example
```
database.insunits = AcDbUnitsValue.Millimeters;
```
- Defined in data-model/src/database/AcDbDatabase.ts:434

ltscale

get ltscale(): number
Gets the line type scale factor.

Returns number
The line type scale factor
Example
```
const lineTypeScale = database.ltscale;
```
- Defined in data-model/src/database/AcDbDatabase.ts:450
set ltscale(value: number): void
Sets the line type scale factor.
Parameters
- value: number
  The new line type scale factor
Returns void
Example
```
database.ltscale = 2.0;
```
- Defined in data-model/src/database/AcDbDatabase.ts:464

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

pdmode

get pdmode(): number
Point display mode. Please get more details on value of this property from this page.

Returns number
- Defined in data-model/src/database/AcDbDatabase.ts:538
set pdmode(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbDatabase.ts:541

pdsize

get pdsize(): number
Point display size.
- 0: Create a point at 5 percent of the drawing area height
- 0: Specifie an absolute size
- < 0: Specifie a percentage of the viewport size
Returns number
- Defined in data-model/src/database/AcDbDatabase.ts:552
set pdsize(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbDatabase.ts:555

tables

get tables(): AcDbTables
Gets all tables in this drawing database.

Returns AcDbTables
Object containing all the symbol tables in the database
Example
```
const tables = database.tables;
const layers = tables.layerTable;
const blocks = tables.blockTable;
```
- Defined in data-model/src/database/AcDbDatabase.ts:317

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

openUri

openUri(url: string, options: AcDbOpenDatabaseOptions): Promise<void>
Read AutoCAD DXF or DWG drawing specified by the URL into the database object. The method automatically detects the file type based on the URL extension:
- .dxf files are read as text using readAsText()
- .dwg files are read as binary data using readAsArrayBuffer()
Parameters
- url: string
  Input the URL linked to one AutoCAD DXF or DWG file
- options: AcDbOpenDatabaseOptions
  Input options to read drawing data
Returns Promise<void>
- Defined in data-model/src/database/AcDbDatabase.ts:636

read

read(
    data: string | ArrayBuffer,
    options: AcDbOpenDatabaseOptions,
    fileType?: AcDbFileType,
): Promise<void>
Reads drawing data from a string or ArrayBuffer.

This method parses the provided data and populates the database with the resulting entities, tables, and objects. The method supports both DXF and DWG file formats.
Parameters
- data: string | ArrayBuffer
  The drawing data as a string or ArrayBuffer
  - For DXF files: Pass a string containing the DXF content
  - For DWG files: Pass an ArrayBuffer instance containing the binary DWG data
- options: AcDbOpenDatabaseOptions
  Options for reading the database
- fileType: AcDbFileType = AcDbFileType.DXF
  The type of file being read (defaults to DXF)
Returns Promise<void>
Example
```
// Reading a DXF file (string)
const database = new AcDbDatabase();
await database.read(dxfString, { readOnly: true }, AcDbFileType.DXF);

// Reading a DWG file (ArrayBuffer)
const database = new AcDbDatabase();
await database.read(dwgArrayBuffer, { readOnly: true }, AcDbFileType.DWG);
```
- Defined in data-model/src/database/AcDbDatabase.ts:584

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 AcDbDatabase

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AcDbDatabase

Properties

Readonlyevents

Type declaration

entityAppended: AcCmEventManager<AcDbEntityEventArgs>

entityModified: AcCmEventManager<AcDbEntityEventArgs>

headerSysVarChanged: AcCmEventManager<AcDbHeaderSysVarEventArgs>

layerAppended: AcCmEventManager<AcDbLayerEventArgs>

layerErased: AcCmEventManager<AcDbLayerEventArgs>

layerModified: AcCmEventManager<AcDbLayerModifiedEventArgs>

openProgress: AcCmEventManager<AcDbProgressdEventArgs>

Accessors

angBase

Returns number

Parameters

Returns void

angDir

Returns number

Parameters

Returns void

attrs

Returns AcCmObject<ATTRS>

Example

aunits

Returns number

Example

Parameters

Returns void

Example

cecolor

Returns AcCmColor

Example

Parameters

Returns void

Example

celtscale

Returns number

Parameters

Returns void

currentSpaceId

Returns string

Example

Parameters

Returns void

Throws

Example

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

dictionaries

Returns { imageDefs: AcDbDictionary<AcDbRasterImageDef>; layouts: AcDbLayoutDictionary }

Example

insunits

Returns number

Example

Parameters

Returns void

Example

ltscale

Returns number

Example

Parameters

Returns void

Example

objectId

Returns string

Example

`Readonly`events