Class AcApDocument

Represents a CAD document that manages a drawing database and associated metadata.

This class handles:

Opening CAD files from URIs or file content (DWG/DXF formats)
Managing document properties (title, access mode)
Providing access to the underlying database
Handling file loading errors through event emission

Index

Constructors

Accessors

database docTitle fileName openMode uri

Methods

openDocument openUri

Constructors

constructor

new AcApDocument(): AcApDocument
Creates a new document instance with an empty database.

The document is initialized with an "Untitled" title and write mode enabled.

Returns AcApDocument
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:38

Accessors

database

get database(): AcDbDatabase
Gets the database object containing all drawing data.

Returns AcDbDatabase
The underlying CAD database instance
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:136

docTitle

get docTitle(): string
Gets the display title of the document.

Returns string
The title of the document
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:154
set docTitle(value: string): void
Sets the display title of the document.

Notes: The browser tab title isn't updated on purpose because users may use it as one component and don't want to the browser tab title changed. So if you want to change the browser tab title, you can listen events AcApDocManager.events.documentActivated to change it in your event listener.
Parameters
- value: string
  The new document title
Returns void
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:169

fileName

get fileName(): string
Gets the file name of the current document.

Returns string
The file name, or an empty string for untitled documents
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:145

openMode

get openMode(): AcEdOpenMode
Gets the access mode of the document.

Returns AcEdOpenMode
The access mode (Read, Review, or Write)
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:178

uri

get uri(): string | undefined
Gets the URI of the document if opened from a URI.

Returns string | undefined
The document URI, or undefined if not opened from URI
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:127

Methods

openDocument

openDocument(
    fileName: string,
    content: ArrayBuffer,
    options: AcApOpenDatabaseOptions,
): Promise<boolean>
Opens a CAD document from file content.
Parameters
- fileName: string
  The name of the file (used to determine file type from extension)
- content: ArrayBuffer
  The file content as string or ArrayBuffer
- options: AcApOpenDatabaseOptions
  Options for opening the database
Returns Promise<boolean>
Promise resolving to true if successful, false if failed
Example
```
const fileContent = await fetch('drawing.dwg').then(r => r.arrayBuffer());
const success = await document.openDocument('drawing.dwg', fileContent, {
  mode: AcEdOpenMode.Write
});
```
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:94

openUri

openUri(uri: string, options: AcApOpenDatabaseOptions): Promise<boolean>
Opens a CAD document from a URI.
Parameters
- uri: string
  The URI of the CAD file to open
- options: AcApOpenDatabaseOptions
  Options for opening the database
Returns Promise<boolean>
Promise resolving to true if successful, false if failed
Example
```
const success = await document.openUri('https://example.com/drawing.dwg', {
  mode: AcEdOpenMode.Read
});
```
- Defined in packages/cad-simple-viewer/src/app/AcApDocument.ts:58