Class AcApLogCmdInternal

This is an internal command used to log some debug information in console.

Hierarchy (View Summary)

Constructors

constructor

Properties

events

Accessors

globalName localName

Methods

execute tirgger

Constructors

constructor

  • new AcApLogCmd(): AcApLogCmd

    Creates a new command instance.

    Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.

    Returns AcApLogCmd

Properties

Readonlyevents

events: {
    commandEnded: AcCmEventManager<AcEdCommandEventArgs>;
    commandWillStart: AcCmEventManager<AcEdCommandEventArgs>;
}

Events fired during command execution lifecycle

Type declaration

Accessors

globalName

  • get globalName(): string

    Gets the global (untranslated) name of the command.

    The global name is typically used for programmatic access and should remain consistent across different language localizations.

    Returns string

    The global command name

  • set globalName(value: string): void

    Sets the global (untranslated) name of the command.

    Parameters

    • value: string

      The global command name (e.g., 'LINE', 'CIRCLE', 'ZOOM')

    Returns void

localName

  • get localName(): string

    Gets the local (translated) name of the command.

    The local name is displayed to users and should be localized to the current language/region.

    Returns string

    The localized command name

  • set localName(value: string): void

    Sets the local (translated) name of the command.

    Parameters

    • value: string

      The localized command name (e.g., 'Draw Line', 'Zoom In')

    Returns void

Methods

execute

  • execute(context: AcApContext): void

    Executes the command logic.

    This abstract method must be implemented by subclasses to define the specific behavior of the command. The method receives the current application context providing access to the view and document.

    Parameters

    Returns void

    Example

    execute(context: AcApContext) {
      const view = context.view;
      const doc = context.doc;

      // Get user input
      const point = await view.editor.getPoint();

      // Create entity in document
      const entity = new SomeEntity(point);
      doc.database.addEntity(entity);
    }

tirgger

  • tirgger(context: AcApContext): void

    Triggers the command execution with proper event handling.

    This method should not be overridden by subclasses as it handles the event notification workflow. Subclasses should implement the execute() method instead.

    The execution flow:

    1. Fires commandWillStart event
    2. Calls the execute() method
    3. Fires commandEnded event

    Parameters

    • context: AcApContext

      The current application context containing view and document

    Returns void

    Example

    const command = new MyCommand();
    command.trigger(docManager.context);

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods