Interface AcApPlugin

Plugin interface that all plugins must implement.

Plugins can extend the functionality of the CAD viewer by:

  • Registering custom commands
  • Accessing the application context (view, document)
  • Performing initialization and cleanup

Example

class MyPlugin implements AcApPlugin {
  name = 'MyPlugin'
  version = '1.0.0'

  private registeredCommands: Array<{group: string, name: string}> = []

  onLoad(context: AcApContext, commandManager: AcEdCommandStack): void {
    // Register custom commands
    commandManager.addCommand('USER', 'MYCMD', 'My Command', new MyCommand())
    this.registeredCommands.push({group: 'USER', name: 'MYCMD'})
  }

  onUnload(context: AcApContext, commandManager: AcEdCommandStack): void {
    // Clean up registered commands
    for (const cmd of this.registeredCommands) {
      commandManager.removeCmd(cmd.group, cmd.name)
    }
    this.registeredCommands = []
  }
}
interface AcApPlugin {
    description?: string;
    name: string;
    version?: string;
    onLoad(
        context: AcApContext,
        commandManager: AcEdCommandStack,
    ): void | Promise<void>;
    onUnload(
        context: AcApContext,
        commandManager: AcEdCommandStack,
    ): void | Promise<void>;
}

Implemented by

Properties

description? name version?

Methods

onLoad onUnload

Properties

Optionaldescription

description?: string

Optional description of the plugin

name

name: string

Unique identifier for the plugin

Optionalversion

version?: string

Version of the plugin

Methods

onLoad

  • onLoad(
        context: AcApContext,
        commandManager: AcEdCommandStack,
    ): void | Promise<void>

    Called when the plugin is loaded.

    This method is invoked when the plugin is registered with the plugin manager. Use this method to:

    • Register custom commands using the provided command manager
    • Initialize plugin-specific resources
    • Set up event listeners

    Parameters

    • context: AcApContext

      The current application context (view, document)

    • commandManager: AcEdCommandStack

      The command manager for registering commands

    Returns void | Promise<void>

    Example

    onLoad(context: AcApContext, commandManager: AcEdCommandStack) {
      commandManager.addCommand('USER', 'MYCMD', 'My Command', new MyCommand());
    }

onUnload

  • onUnload(
        context: AcApContext,
        commandManager: AcEdCommandStack,
    ): void | Promise<void>

    Called when the plugin is unloaded.

    This method is invoked when the plugin is removed from the plugin manager. Use this method to:

    • Clean up registered commands using commandManager.removeCmd()
    • Release resources
    • Remove event listeners

    Parameters

    • context: AcApContext

      The current application context (view, document)

    • commandManager: AcEdCommandStack

      The command manager for unregistering commands

    Returns void | Promise<void>

    Example

    onUnload(context: AcApContext, commandManager: AcEdCommandStack) {
      commandManager.removeCmd('USER', 'MYCMD');
    }

Settings

Member Visibility

On This Page

Properties
Methods