Class AcApDocManager

Readonlyevents

avaiableFonts

• get avaiableFonts(): AcDbFontInfo[]

  Gets the list of available fonts that can be loaded.

  Note: These fonts are available for loading but may not be loaded yet.

  Returns AcDbFontInfo[]

  Array of available font names

baseUrl

• get baseUrl(): string

  Base URL to load fonts

  Returns string

commandManager

• get commandManager(): AcEdCommandStack

  Gets command manager to look up and register commands

  Returns AcEdCommandStack

  The command manager

context

• get context(): AcApContext

  Gets the current application context.

  The context binds the current document with its associated view.

  Returns AcApContext

  The current application context

curDocument

• get curDocument(): AcApDocument

  Gets the currently open CAD document.

  Returns AcApDocument

  The current document instance

curView

• get curView(): AcTrView2d

  Gets the current 2D view used to display the drawing.

  Returns AcTrView2d

  The current 2D view instance

editor

• get editor(): AcEditor

  Gets the editor instance for handling user input.

  Returns AcEditor

  The current editor instance

mdiActiveDocument

• get mdiActiveDocument(): AcApDocument

  Gets the currently active document.

  For now, this is the same as curDocument since only one document can be active at a time.

  Returns AcApDocument

  The current active document

pluginManager

• get pluginManager(): AcApPluginManager

  Gets plugin manager to load and unload plugins

  Returns AcApPluginManager

  The plugin manager

Staticinstance

• get instance(): AcApDocManager

  Gets the singleton instance of the document manager.

  Creates a new instance if one doesn't exist yet.

  Returns AcApDocManager

  The singleton document manager instance

destroy

• destroy(): Promise<void>

  Destroy the view and unload all plugins

  Returns Promise<void>

loadDefaultFonts

• loadDefaultFonts(fonts?: string[]): Promise<void>

  Loads default fonts for CAD text rendering.

  This method loads either the specified fonts or falls back to default Chinese fonts (specifically 'simkai') if no fonts are provided. The loaded fonts are used for rendering CAD text entities like MText and Text in the viewer.

  It is better to load default fonts when viewer is initialized so that the viewer can render text correctly if fonts used in the document are not available.

  Parameters

  • Optionalfonts: string[]

    Optional array of font names to load. If not provided or null, defaults to ['simkai'] for Chinese text support

  Returns Promise<void>

  Promise that resolves when all specified fonts are loaded

  Example

  // Load default fonts (simkai)
  await docManager.loadDefaultFonts();
  
  // Load specific fonts
  await docManager.loadDefaultFonts(['Arial', 'SimSun']);
  
  // Load no fonts (empty array)
  await docManager.loadDefaultFonts([]);
  Copy

  See

  • AcApFontLoader.load - The underlying font loading implementation
  • createExampleDoc - Method that uses this for example document creation

loadFonts

• loadFonts(fonts: string[]): Promise<void>

  Loads the specified fonts for text rendering.

  Parameters

  • fonts: string[]

    Array of font names to load

  Returns Promise<void>

  Promise that resolves when fonts are loaded

  Example

  await docManager.loadFonts(['Arial', 'Times New Roman']);
  Copy

lookupGlobalCmd

• lookupGlobalCmd(cmdName: string): undefined | AcEdCommand

  Search through all of the global and untranslated names in all of the command groups in the command stack starting at the top of the stack trying to find a match with cmdName. If a match is found, the matched AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command could not be found. If more than one command of the same name is present in the command stack (that is, in separate command groups), then the first one found is used.

  The command is only returned if it is compatible with that open mode of the current document. Higher value modes are compatible with lower value modes.

  Parameters

  • cmdName: string

    Input the command name to search for

  Returns undefined | AcEdCommand

  Return the matched AcEdCommand object if a match is found and compatible with the open mode of the current document. Otherwise, return undefined.

lookupLocalCmd

• lookupLocalCmd(cmdName: string): undefined | AcEdCommand

  Search through all of the local and translated names in all of the command groups in the command stack starting at the top of the stack trying to find a match with cmdName. If a match is found, the matched AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command could not be found. If more than one command of the same name is present in the command stack (that is, in separate command groups), then the first one found is used.

  The command which is compatible with the open mode of the current document is only returned

  Parameters

  • cmdName: string

    Input the command name to search for

  Returns undefined | AcEdCommand

  Return the matched AcEdCommand object if a match is found and compatible with the open mode of the current document. Otherwise, return undefined.

openDocument

• openDocument(
      fileName: string,
      content: ArrayBuffer,
      options: AcApOpenDatabaseOptions,
  ): Promise<boolean>

  Opens a CAD document from file content.

  This method loads a document from the provided file content (binary data) and replaces the current document. It handles the complete document lifecycle including before/after open events.

  Parameters

  • fileName: string

    The name of the file being opened (used for format detection)
  • content: ArrayBuffer

    The file content
  • options: AcApOpenDatabaseOptions

    Database opening options including font loader settings

  Returns Promise<boolean>

  Promise that resolves to true if the document was successfully opened, false otherwise

  Example

  const fileContent = await file.arrayBuffer();
  const success = await docManager.openDocument('drawing.dwg', fileContent, options);
  Copy

openUrl

• openUrl(url: string, options?: AcApOpenDatabaseOptions): Promise<boolean>

  Opens a CAD document from a URL.

  This method loads a document from the specified URL and replaces the current document. It handles the complete document lifecycle including before/after open events.

  Parameters

  • url: string

    The URL of the CAD file to open
  • Optionaloptions: AcApOpenDatabaseOptions

    Optional database opening options. If not provided, default options with font loader will be used

  Returns Promise<boolean>

  Promise that resolves to true if the document was successfully opened, false otherwise

  Example

  const success = await docManager.openUrl('https://example.com/drawing.dwg');
  if (success) {
    console.log('Document opened successfully');
  }
  Copy

regen

• regen(): void

  Redraws the current view. Currently it is used once you modified font mapping for missed fonts so that the drawing can apply new fonts.

  Returns void

searchCommandsByPrefix

• searchCommandsByPrefix(prefix: string): AcEdCommandIteratorItem[]

  Fuzzy search for commands by prefix using the command iterator.

  This method iterates through all commands in all command groups and returns those whose global or local names start with the provided prefix. The search is case-insensitive. Only commands which are compatible with that open mode of the current document are returned. Higher value modes are compatible with lower value modes.

  Parameters

  • prefix: string

    The prefix string to search for. Case-insensitive.

  Returns AcEdCommandIteratorItem[]

  An array of objects containing matched commands and their corresponding group names.

sendStringToExecute

• sendStringToExecute(cmdStr: string): void

  Executes a command by its string name.

  This method looks up a registered command by name and executes it with the current context. It checks if the command's required mode is compatible with the document's current mode. If the command is not found or not compatible, an error is thrown.

  Parameters

  • cmdStr: string

    The command string to execute (e.g., 'pan', 'zoom', 'select')

  Returns void

  Throws

  If the command is not found or if the command's mode is not compatible with the document's mode

  Example

  docManager.sendStringToExecute('zoom');
  docManager.sendStringToExecute('pan');
  Copy

setActiveLayout

• setActiveLayout(): void

  Configures layout information for the current view.

  Sets up the active layout block table record ID and model space block table record ID based on the current document's space configuration.

  Returns void

StaticcreateInstance

• createInstance(options?: AcApDocManagerOptions): undefined | AcApDocManager

  Creates the singleton instance with an optional canvas element.

  This method should be called before accessing the instance property if you want to provide a specific canvas element.

  Parameters

  • options: AcApDocManagerOptions = {}

    Options for creating AcApDocManager instance

  Returns undefined | AcApDocManager

  The singleton instance