CAD-Viewer

https://mlightcad.github.io/cad-viewer/docs
Admin
CAD-Viewer is a high-performance, web-based CAD editor that enables users to view and edit DWG/DXF...
Tokens:191,458
Snippets:2,371
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Development Setup for MlCadViewer

Source: https://mlightcad.github.io/cad-viewer/docs/modules/_mlightcad_cad-viewer.html

Instructions for setting up the development environment, including installing dependencies, starting the development server, building, and previewing the project.

```bash
# Install dependencies  
pnpm install  
  
# Start development server  
pnpm dev  
  
# Build the library  
pnpm build  
  
# Preview the build  
pnpm preview
```

--------------------------------

### onCommandWillStart Method

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApBaseRevCmd.html

Called right before the command starts executing. Intended for setup work before execute() runs.

```APIDOC
### `Protected`onCommandWillStart
  * onCommandWillStart(context: AcApContext): void
Called right before the command starts executing.
#### Parameters
    * context: AcApContext
The current application context
#### Returns void
```

--------------------------------

### Basic MlCadViewer Setup

Source: https://mlightcad.github.io/cad-viewer/docs/modules/_mlightcad_cad-viewer.html

This snippet shows the basic Vue component setup for integrating the MlCadViewer. Ensure all listed dependencies are installed.

```vue
<template>
  <MlCadViewer />
</template>

<script setup>
import MlCadViewer from '@mlightcad/cad-viewer'
</script>

<style>
.mlightcad-cad-viewer {
  width: 100%;
  height: 100%;
}
</style>
```

--------------------------------

### Install MLightCAD CAD-Viewer

Source: https://mlightcad.github.io/cad-viewer/docs

Clone the repository, navigate to the directory, and install dependencies using pnpm.

```bash
git clone https://github.com/mlightcad/cad-viewer.git  
cd cad-viewer  
pnpm install
```

--------------------------------

### onCommandWillStart

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdCommand.html

Called right before the command starts executing. This lifecycle hook is intended for subclasses that need to perform setup work before `execute()` runs.

```APIDOC
## onCommandWillStart

### Description
Called right before the command starts executing. This lifecycle hook is intended for subclasses that need to perform setup work before `execute()` runs, such as:
    * Initializing temporary state
    * Locking resources
    * Preparing UI or editor state
The default implementation does nothing.

### Method
onCommandWillStart

### Parameters
#### Path Parameters
* `_context` (AcApContext) - The current application context

### Returns
void
```

--------------------------------

### Setting and Getting Values

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSettingManager.html

Illustrates how to set and retrieve specific setting values using the `set` and `get` methods.

```APIDOC
## Setting and Getting Values

### Description
Use the `set` method to update a setting's value and the `get` method to retrieve its current value.

### Methods
- `set(key: string, value: any): void`
- `get(key: string): any`

### Example
```javascript
// Set a setting value
settings.set('isShowToolbar', false);

// Get a setting value
const showToolbar = settings.get('isShowToolbar');
```
```

--------------------------------

### Install @mlightcad/cad-viewer

Source: https://mlightcad.github.io/cad-viewer/docs/modules/_mlightcad_cad-viewer.html

Install the CAD viewer component using npm.

```bash
npm install @mlightcad/cad-viewer
Copy
```

--------------------------------

### AcApLayerPCmd.onCommandWillStart Method

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApLayerPCmd.html

Protected method called right before the command starts executing. Intended for setup work before execute() runs.

```APIDOC
### `Protected`onCommandWillStart
  * onCommandWillStart(_context: AcApContext): void
Called right before the command starts executing.
#### Parameters
    * _context: AcApContext
The current application context
#### Returns void
```

--------------------------------

### onCommandWillStart

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApHatchCmd.html

Lifecycle hook called right before the command starts executing. Intended for subclasses to perform setup work, such as initializing state or locking resources.

```APIDOC
## onCommandWillStart

### Description
Called right before the command starts executing.
This lifecycle hook is intended for subclasses that need to perform setup work before `execute()` runs, such as:
    * Initializing temporary state
    * Locking resources
    * Preparing UI or editor state
The default implementation does nothing.

### Method
onCommandWillStart(_context: AcApContext): void

### Parameters
#### Path Parameters
* _context (AcApContext) - The current application context

### Returns void

```

--------------------------------

### Install @mlightcad/cad-simple-viewer

Source: https://mlightcad.github.io/cad-viewer/docs/modules/_mlightcad_cad-simple-viewer.html

Install the package using npm. This command adds the core CAD viewer components to your project.

```bash
npm install @mlightcad/cad-simple-viewer
```

--------------------------------

### AcApPropertiesCmd.onCommandWillStart Method

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-viewer.AcApPropertiesCmd.html

Handles the command will start event. This method can be overridden by subclasses.

```APIDOC
## onCommandWillStart
  * onCommandWillStart(): void
Handles the command will start event. This method can be overridden by subclasses to perform initialization tasks before the command begins execution.
#### Returns void
```

--------------------------------

### Example Usage of AcEdPromptStateMachine

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptStateMachine.html

Demonstrates how to define states and run the state machine to chain editor prompts. This example shows a two-step process for collecting two numerical values and calculating their sum.

```typescript
type Prompt = { message: string }
type Result = { status: 'ok' | 'cancel'; value?: number }

class FirstState implements AcEdPromptState<Prompt, Result> {
  constructor(private sm: AcEdPromptStateMachine<Prompt, Result>) {}

  buildPrompt() {
    return { message: 'Enter first value:' }
  }

  handleResult(result: Result) {
    if (result.status !== 'ok') return 'finish'
    this.sm.setState(new SecondState(this.sm, result.value ?? 0))
    return 'continue'
  }
}

class SecondState implements AcEdPromptState<Prompt, Result> {
  constructor(
    private sm: AcEdPromptStateMachine<Prompt, Result>,
    private firstValue: number
  ) {}

  buildPrompt() {
    return { message: 'Enter second value:' }
  }

  handleResult(result: Result) {
    if (result.status !== 'ok') return 'finish'
    const sum = this.firstValue + (result.value ?? 0)
    console.log('sum', sum)
    return 'finish'
  }
}

const sm = new AcEdPromptStateMachine<Prompt, Result>()
sm.setState(new FirstState(sm))
await sm.run(async prompt => {
  // Editor interaction happens here:
  return { status: 'ok', value: 1 }
})
```

--------------------------------

### Using AcApSettingManager for Application Settings

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSettingManager.html

Demonstrates how to get the singleton instance, set, get, and toggle setting values. It also shows how to listen for setting modification events.

```typescript
// Get the singleton instance  
const settings = AcApSettingManager.instance;  
  
// Set a setting value  
settings.set('isShowToolbar', false);  
  
// Get a setting value  
const showToolbar = settings.get('isShowToolbar');  
  
// Toggle a boolean setting  
settings.toggle('isDebug');  
  
// Listen for setting changes  
settings.events.modified.addEventListener(args => {  
  console.log(`Setting ${args.key} changed to:`, args.value);  
});
```

--------------------------------

### AcApRevCircleCmd onCommandWillStart Method

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApRevCircleCmd.html

A protected lifecycle hook called right before the command starts executing. Use this for setup work before the execute() method runs.

```typescript
onCommandWillStart(context: AcApContext): void
```

--------------------------------

### Methods: onCommandWillStart

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDimLinearCmd.html

A protected lifecycle hook called just before the command begins execution, for setup.

```APIDOC
## `Protected`onCommandWillStart
  * onCommandWillStart(_context: AcApContext): void
Called right before the command starts executing.
This lifecycle hook is intended for subclasses that need to perform setup work before `execute()` runs, such as:
    * Initializing temporary state
    * Locking resources
    * Preparing UI or editor state
The default implementation does nothing.
#### Parameters
    * _context: AcApContext
The current application context
#### Returns void
```

--------------------------------

### Instantiate and Start AcEdConditionWaiter

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdConditionWaiter.html

Create an instance of AcEdConditionWaiter with a condition, action, check interval, and timeout. The waiter starts checking the condition immediately after calling start().

```javascript
const waiter = new AcEdConditionWaiter(  
  () => isDataReady(),     // condition  
  () => log.info('Ready or timed out'), // action  
  1000,                    // check every 1s  
  10000                    // timeout after 10s  
);  
  
waiter.start();
```

--------------------------------

### Implement AcApPlugin Interface

Source: https://mlightcad.github.io/cad-viewer/docs/interfaces/_mlightcad_cad-simple-viewer.AcApPlugin.html

Example of a plugin implementing the AcApPlugin interface, demonstrating command registration and cleanup.

```typescript
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 = []
  }
}
```

--------------------------------

### Command Lifecycle Example

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdCommand.html

Illustrates how to create a custom command by extending AcEdCommand and implementing the execute method.

```APIDOC
#### Example
```
class MyDrawCommand extends AcEdCommand {
  constructor() {
    super();
    this.globalName = 'DRAW';
    this.localName = 'Draw Line';
  }

  execute(context: AcApContext) {
    // Implement command logic here
    const view = context.view;
    const document = context.doc;
    // ... drawing logic
  }
}

// Usage
const command = new MyDrawCommand();
command.events.commandWillStart.addEventListener(args => {
  console.log('Command starting:', args.command.globalName);
});
command.trigger(context);
```
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptStateMachine.html

Creates a new instance of the AcEdPromptStateMachine. An optional initial state can be provided to start the machine.

```APIDOC
## constructor
  * new AcEdPromptStateMachine<TPromptOptions, TResult>(
initialState?: AcEdPromptState<TPromptOptions, TResult>
): AcEdPromptStateMachine<TPromptOptions, TResult>
Create a new state machine with an optional initial state.
#### Type Parameters
    * TPromptOptions
    * TResult
#### Parameters
    * `Optional`initialState: AcEdPromptState<TPromptOptions, TResult>
The first state to run, if any.
#### Returns AcEdPromptStateMachine<TPromptOptions, TResult>
```

--------------------------------

### AcApClearMeasurementsCmd.onCommandWillStart Method

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApClearMeasurementsCmd.html

Handles the event when a command is about to start. This method can be overridden by subclasses.

```APIDOC
## onCommandWillStart
  * onCommandWillStart(): void
Handles the event when a command is about to start. This method can be overridden by subclasses to perform initialization or pre-command setup.
#### Returns void
```

--------------------------------

### Get User Input with AcEditor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEditor.html

Demonstrates how to use the AcEditor to get user input for points, entity selections, and to change the cursor appearance. Ensure the editor instance is properly initialized before use.

```javascript
// Get user input for a point  
const point = await editor.getPoint();  
console.log('User clicked at:', point);  
  
// Get entity selection  
const selection = await editor.getSelection();  
console.log('Selected entities:', selection.ids);  
  
// Change cursor appearance  
editor.setCursor(AcEdCorsorType.Crosshair);
```

--------------------------------

### Initialize and Use AcEdCommandStack

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdCommandStack.html

Demonstrates how to get the command stack instance, add a custom command, and then look it up.

```typescript
const commandStack = AcApDocManager.instance.commandManager;  
commandStack.addCommand('USER', 'MYCOMMAND', 'MYCOMMAND', myCommandInstance);  
const command = commandStack.lookupGlobalCmd('MYCOMMAND');
```

--------------------------------

### Develop MLightCAD CAD-Viewer

Source: https://mlightcad.github.io/cad-viewer/docs

Start the full-featured or simple viewer using pnpm dev commands.

```bash
# Start the full-featured viewer (cad-viewer)  
pnpm dev  
  
# Or start the simple viewer  
pnpm dev:simple
```

--------------------------------

### AcEdConditionWaiter.start

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdConditionWaiter.html

Starts the condition checking process. The action will be executed once the condition is met or the timeout is reached.

```APIDOC
## start
  * start(): void
Starts checking the condition at the defined interval. Executes the action once when the condition becomes true or when timeout is reached.
#### Returns void
```

--------------------------------

### Script-style Command Input Example

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApZoomCmd.html

Demonstrates how to use script-style input for the zoom command, allowing multiple commands in sequence.

```plaintext
zoom
window
Copy
```

--------------------------------

### AcApRectJig Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApRectJig.html

Creates a dynamic rectangle preview jig with the specified view, start point, and settings provider.

```APIDOC
## constructor
  * new AcApRectJig(
view: AcEdBaseView,
start: AcGeVector2dLike,
settingsProvider: () => RectSettings,
): AcApRectJig

### Description
Creates a dynamic rectangle preview jig.

### Parameters
* **view** (AcEdBaseView) - Active editor view used to render transient geometry.
* **start** (AcGeVector2dLike) - First corner point of the rectangle.
* **settingsProvider** (() => RectSettings) - Callback that returns current command settings.

### Returns
AcApRectJig
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdCommandLine.html

Initializes a new instance of the AcEdCommandLine class.

```APIDOC
## constructor
  * new AcEdCommandLine(container?: HTMLElement): AcEdCommandLine
#### Parameters
    * container: HTMLElement = document.body
#### Returns AcEdCommandLine
```

--------------------------------

### Plugin Management Example - AcApPluginManager

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApPluginManager.html

Demonstrates loading, unloading, checking status, and retrieving loaded plugins using the AcApPluginManager. Ensure plugins implement onLoad and onUnload hooks.

```javascript
const pluginManager = AcApDocManager.instance.pluginManager;

// Load a plugin
const myPlugin = new MyPlugin();
await pluginManager.loadPlugin(myPlugin);

// Unload a plugin
await pluginManager.unloadPlugin('MyPlugin');

// Check if a plugin is loaded
if (pluginManager.isPluginLoaded('MyPlugin')) {
  log.info('Plugin is loaded');
}

// Get all loaded plugins
const loadedPlugins = pluginManager.getLoadedPlugins();
```

--------------------------------

### Set and Get ACI Color

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.MTextColor.html

Set or get the ACI color value. Setting an ACI color automatically disables any previously set RGB color. The value should be between 0 and 256.

```typescript
const textColor = new MTextColor();
textColor.aci = 10; // Set ACI color to 10
const aciValue = textColor.aci; // Get ACI color value
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSwitchBgCmd.html

Creates a new instance of the AcApSwitchBgCmd. Initializes the command with empty names. Subclasses should set appropriate global and local names.

```APIDOC
## constructor
  * new AcApSwitchBgCmd(): AcApSwitchBgCmd
Creates a new command instance.
Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.
#### Returns AcApSwitchBgCmd
```

--------------------------------

### Set and Get RGB Color

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.MTextColor.html

Set or get the RGB color as a tuple [r, g, b]. Setting an RGB color disables any previously set ACI color. The values for r, g, and b should be between 0 and 255.

```typescript
const textColor = new MTextColor();
textColor.rgb = [255, 165, 0]; // Set color to orange
const rgbValue = textColor.rgb; // Get RGB color tuple
```

--------------------------------

### isReadOnly Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptKeywordOptions.html

Gets whether this AcEdPromptOptions is read-only.

```APIDOC
### isReadOnly
  * get isReadOnly(): boolean
Gets whether this `AcEdPromptOptions` is read-only. When read-only, properties such as `message` and `appendKeywordsToMessage` cannot be changed. Corresponds to `PromptOptions.IsReadOnly`.
#### Returns boolean
```

--------------------------------

### keywords Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptBoxOptions.html

Gets the collection of keywords for this prompt.

```APIDOC
## keywords
  * get keywords(): AcEdKeywordCollection
Gets the collection of keywords for this prompt. Mirrors `PromptOptions.Keywords` in AutoCAD .NET API.
#### Returns AcEdKeywordCollection
```

--------------------------------

### AcApDocManager.curDocument

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

Gets the currently open CAD document.

```APIDOC
## curDocument

### Description
Gets the currently open CAD document.

### Returns
AcApDocument - The current document instance
```

--------------------------------

### AcApPointCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApPointCmd.html

Initializes a new instance of the AcApPointCmd class.

```APIDOC
## constructor
  * new AcApPointCmd(): AcApPointCmd

### Returns AcApPointCmd
```

--------------------------------

### AcApDocManager.baseUrl

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

Gets the base URL to load fonts.

```APIDOC
## baseUrl

### Description
Base URL to load fonts

### Returns
string
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-viewer.AcApHatchRibbonCmd.html

Initializes a new instance of the AcApHatchRibbonCmd class.

```APIDOC
## constructor
  * new AcApHatchRibbonCmd(): AcApHatchRibbonCmd

#### Returns AcApHatchRibbonCmd
```

--------------------------------

### Canvas Width

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdBaseView.html

Get or set the width of the canvas in pixels.

```APIDOC
## get width
### Description
Width of canvas (not width of window) in pixel
### Returns
number

## set width(value: number)
### Parameters
* value: number
### Returns
void
```

--------------------------------

### Selection Set

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdBaseView.html

Get the current selection set in the view.

```APIDOC
## get selectionSet
### Description
The selection set in current view.
### Returns
AcEdSelectionSet
```

--------------------------------

### AcApPolylineCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApPolylineCmd.html

Initializes a new instance of the AcApPolylineCmd class.

```APIDOC
## constructor
  * new AcApPolylineCmd(): AcApPolylineCmd

### Returns AcApPolylineCmd
```

--------------------------------

### Canvas Height

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdBaseView.html

Get or set the height of the canvas in pixels.

```APIDOC
## get height
### Description
Height of canvas (not height of window) in pixel
### Returns
number

## set height(value: number)
### Parameters
* value: number
### Returns
void
```

--------------------------------

### Container Element

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdBaseView.html

Get the HTML element that contains this view.

```APIDOC
## get container
### Description
The HTML element to contain this view
### Returns
HTMLElement
```

--------------------------------

### Instantiate and Trigger AcApOpenCmd

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApOpenCmd.html

Demonstrates how to create an instance of AcApOpenCmd, set its names, and trigger the command. The command will then emit an 'open-file' event for UI components to handle.

```javascript
const openCommand = new AcApOpenCmd();
openCommand.globalName = 'OPEN';
openCommand.localName = 'Open File';

// Trigger the command
openCommand.trigger(docManager.context);

// The command will emit 'open-file' event for UI components to handle
```

--------------------------------

### message Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptBoxOptions.html

Gets or sets the message displayed in the prompt.

```APIDOC
## message
  * get message(): string
Gets or sets the message displayed in the prompt. Corresponds to `PromptOptions.Message` in AutoCAD .NET API.
#### Returns string
  * set message(msg: string): void
#### Parameters
    * msg: string
#### Returns void
```

--------------------------------

### AcApMLineCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApMLineCmd.html

Initializes a new instance of the AcApMLineCmd class.

```APIDOC
## constructor
  * new AcApMLineCmd(): AcApMLineCmd

#### Returns AcApMLineCmd
```

--------------------------------

### build

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApHtmlSnapshotBuilder.html

Builds a snapshot synchronously in one pass. Prefer buildAsync for interactive export to keep the UI responsive.

```APIDOC
## build
  * build(
scene: AcTrScene,
database: AcDbDatabase,
options?: AcApHtmlSnapshotBuilderOptions,
): AcExSnapshotV1
Builds a snapshot synchronously in one pass.
Prefer buildAsync for interactive export so the UI can stay responsive.
#### Parameters
    * scene: AcTrScene
Current renderer scene (layouts, layers, active layout).
    * database: AcDbDatabase
Open drawing database used for layout names and metadata.
    * options: AcApHtmlSnapshotBuilderOptions = {}
Optional title, background, and locale overrides.
#### Returns AcExSnapshotV1
A complete v1 snapshot ready for `packHtml`.
```

--------------------------------

### jig Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptBoxOptions.html

Gets or sets the preview jig in the prompt.

```APIDOC
## jig
  * get jig(): AcEdPreviewJig<T> | undefined
Gets or sets the preview jig in the prompt.
#### Returns AcEdPreviewJig<T> | undefined
  * set jig(jig: AcEdPreviewJig<T> | undefined): void
#### Parameters
    * jig: AcEdPreviewJig<T> | undefined
#### Returns void
```

--------------------------------

### AcApDocManager.pluginManager

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

Gets the plugin manager to load and unload plugins.

```APIDOC
## pluginManager

### Description
Gets plugin manager to load and unload plugins

### Returns
AcApPluginManager - The plugin manager
```

--------------------------------

### Build MLightCAD CAD-Viewer

Source: https://mlightcad.github.io/cad-viewer/docs

Build the MLightCAD CAD-Viewer project using the pnpm build command.

```bash
pnpm build
```

--------------------------------

### AcApDocManager.editor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

Gets the editor instance for handling user input.

```APIDOC
## editor

### Description
Gets the editor instance for handling user input.

### Returns
AcEditor - The current editor instance
```

--------------------------------

### AcApDocManager.commandManager

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

Gets the command manager to look up and register commands.

```APIDOC
## commandManager

### Description
Gets command manager to look up and register commands

### Returns
AcEdCommandStack - The command manager
```

--------------------------------

### Load Plugins from Configuration or Folder

Source: https://mlightcad.github.io/cad-viewer/docs/interfaces/_mlightcad_cad-simple-viewer.AcApDocManagerOptions.html

Configure automatic plugin loading during viewer initialization. Plugins can be provided as instances or factory functions, or loaded from a specified folder.

```typescript
AcApDocManager.createInstance({
  plugins: {
    fromConfig: [
      new MyPlugin1(),
      () => new MyPlugin2()
    ]
  }
});
```

```typescript
AcApDocManager.createInstance({
  plugins: {
    fromFolder: {
      folderPath: './plugins',
      pluginList: ['Plugin1.js', 'Plugin2.js'],
      continueOnError: true
    }
  }
});
```

--------------------------------

### AcApI18n.currentLocale Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApI18n.html

Gets the currently active locale for translation.

```APIDOC
## currentLocale
  * get currentLocale(): AcApLocale
Get the currently active locale.
#### Returns AcApLocale
The locale currently used for translation.
#### Example
```
console.log(AcApI18n.currentLocale)  // "en" or "zh"
Copy
```
```

--------------------------------

### initialize

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcTrView2d.html

Initializes the viewer after the renderer and camera are created. This method can be overridden for custom initialization.

```APIDOC
## initialize

### Description
Initializes the viewer after renderer and camera are created. This method sets up the initial cursor and can be overridden by child classes to add custom initialization logic.

### Method
initialize

### Returns void
```

--------------------------------

### Editor Instance

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdBaseView.html

Get the input manager for handling user interactions.

```APIDOC
## get editor
### Description
Gets the input manager for handling user interactions.
The editor provides high-level methods for getting user input like point selection, entity selection, and cursor management.
### Returns
AcEditor - The editor instance
```

--------------------------------

### Get Setting Value

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSettingManager.html

Retrieve a specific setting value by its key.

```APIDOC
## Get Setting Value

### Description
Retrieves a setting value by its key, returning the stored value or the default if not set.

### Methods

#### `get<K extends string | number | symbol>(key: K): NonNullable<AcApSettings & T>[K]`
Gets a setting value.

##### Type Parameters
- `K` extends `string | number | symbol`: The setting key type.

##### Parameters
- `key` (K): The setting key to retrieve.

##### Returns
- `NonNullable<AcApSettings & T>[K]`: The setting value.

##### Example
```javascript
const isDebug = settings.get('isDebug');
const fontMapping = settings.get('fontMapping');
```
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApLayerIsoCmd.html

Creates a write-enabled LAYISO command instance.

```APIDOC
## constructor
  * new AcApLayerIsoCmd(): AcApLayerIsoCmd
Creates a write-enabled `LAYISO` command instance.
#### Returns AcApLayerIsoCmd
```

--------------------------------

### Get Accumulated Points

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSketchJig.html

Retrieves all the points that have been accumulated by the jig during its operation.

```typescript
jig.points
```

--------------------------------

### AcApPointStyleCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-viewer.AcApPointStyleCmd.html

Creates a new command instance. Subclasses should set appropriate global and local names in their constructors.

```APIDOC
## constructor
  * new AcApPointStyleCmd(): AcApPointStyleCmd
Creates a new command instance.
Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.
#### Returns AcApPointStyleCmd
```

--------------------------------

### AcApDocManager.curView

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDocManager.html

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

```APIDOC
## curView

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

### Returns
AcTrView2d - The current 2D view instance
```

--------------------------------

### AcApPropertiesCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-viewer.AcApPropertiesCmd.html

Creates a new command instance. Subclasses should set appropriate global and local names in their constructors.

```APIDOC
## constructor
  * new AcApPropertiesCmd(): AcApPropertiesCmd
Creates a new command instance.
Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.
#### Returns AcApPropertiesCmd
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApPolylineJig.html

Creates an instance of AcApPolylineJig for polyline preview.

```APIDOC
## constructor
  * new AcApPolylineJig(
view: AcEdBaseView,
points: AcGePoint2d[],
bulges: (number | undefined)[],
currentBulge?: number,
bulgeProvider?: (endPoint: AcGeVector2dLike) => number | undefined,
): AcApPolylineJig

Create a polyline preview jig for point acquisition.

### Parameters
    * view: AcEdBaseView
The associated view for transient rendering.
    * points: AcGePoint2d[]
Confirmed polyline vertices.
    * bulges: (number | undefined)[]
Bulge values aligned with `points`.
    * `Optional`currentBulge: number
Optional fixed bulge used for the preview segment.
    * `Optional`bulgeProvider: (endPoint: AcGeVector2dLike) => number | undefined
Optional function to compute bulge based on the current cursor point.

### Returns AcApPolylineJig
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApDimLinearCmd.html

Initializes a new instance of the AcApDimLinearCmd class.

```APIDOC
## constructor
  * new AcApDimLinearCmd(): AcApDimLinearCmd
#### Returns AcApDimLinearCmd
```

--------------------------------

### allowArbitraryInput Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptKeywordOptions.html

Gets or sets whether arbitrary input is accepted by the prompt.

```APIDOC
## Accessors
### allowArbitraryInput
  * get allowArbitraryInput(): boolean
Gets or sets whether arbitrary input is accepted. If true, the prompt may allow strings or other input, depending on implementation. Corresponds to `PromptKeywordOptions.AllowArbitraryInput` in AutoCAD .NET API.
#### Returns boolean
  * set allowArbitraryInput(flag: boolean): void
#### Parameters
    * flag: boolean
#### Returns void
```

--------------------------------

### singleOnly Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptSelectionOptions.html

Gets or sets whether to force single object selection only.

```APIDOC
## singleOnly
  * get singleOnly(): boolean
Gets or sets whether to force single object selection only
#### Returns boolean
  * set singleOnly(value: boolean): void
#### Parameters
    * value: boolean
#### Returns void
```

--------------------------------

### Listening for Setting Changes

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSettingManager.html

Demonstrates how to subscribe to setting modification events to react to changes in real-time.

```APIDOC
## Listening for Setting Changes

### Description
Listen for changes to settings using the `events.modified` event listener.

### Event
`events.modified.addEventListener(callback: (args: AcApSettingManagerEventArgs<T>) => void): void`

### Example
```javascript
// Listen for setting changes
settings.events.modified.addEventListener(args => {
  console.log(`Setting ${args.key} changed to:`, args.value);
});
```
```

--------------------------------

### AcApLayerStateCmd Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-viewer.AcApLayerStateCmd.html

Initializes a new command instance. Subclasses should set appropriate global and local names.

```APIDOC
## constructor
  * new AcApLayerStateCmd(): AcApLayerStateCmd
Creates a new command instance.
Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.
#### Returns AcApLayerStateCmd
```

--------------------------------

### secondCornerMessage Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptBoxOptions.html

Gets or sets the message displayed for the second corner selection.

```APIDOC
## secondCornerMessage
  * get secondCornerMessage(): string
#### Returns string
  * set secondCornerMessage(value: string): void
#### Parameters
    * value: string
#### Returns void
```

--------------------------------

### firstCornerMessage Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptBoxOptions.html

Gets or sets the message displayed for the first corner selection.

```APIDOC
## firstCornerMessage
  * get firstCornerMessage(): string
#### Returns string
  * set firstCornerMessage(value: string): void
#### Parameters
    * value: string
#### Returns void
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptEntityOptions.html

Initializes a new instance of the AcEdPromptEntityOptions class.

```APIDOC
## new AcEdPromptEntityOptions

### Description
Initializes a new instance of the AcEdPromptEntityOptions class.

### Parameters
- **message** (string) - The message to display to the user.
- **globalKeywords** (string) - Optional. A string containing global keywords.

### Returns
AcEdPromptEntityOptions
```

--------------------------------

### AcEdCommand Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdCommand.html

Initializes a new command instance. Subclasses should set global and local names.

```APIDOC
## constructor
  * new AcEdCommand<TUserData extends object = {}>(): AcEdCommand<TUserData>
Creates a new command instance.
Initializes the command with empty names. Subclasses should set appropriate global and local names in their constructors.
#### Type Parameters
    * TUserData extends object = {}
#### Returns AcEdCommand<TUserData>
```

--------------------------------

### AcEdMarker Accessors

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdMarker.html

Provides methods to get and set the color and type of the marker.

```APIDOC
## Accessors

### color
  * get color(): string
Gets the current marker color.

  * set color(value: string): void
Sets marker color and updates DOM immediately.

### type
  * get type(): AcEdMarkerType
Gets the current marker type.

  * set type(value: AcEdMarkerType): void
Sets the marker type and updates DOM shape instantly.
```

--------------------------------

### AcApSplineJig Accessor: entity

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApSplineJig.html

Gets the transient spline entity used by this jig.

```APIDOC
## entity
  * get entity(): AcDbSpline

### Description
Gets transient spline entity used by this jig.

### Returns
* AcDbSpline
```

--------------------------------

### Using AcEdOpenMode for Database Access

Source: https://mlightcad.github.io/cad-viewer/docs/enums/_mlightcad_cad-simple-viewer.AcEdOpenMode.html

Demonstrates how to use the AcEdOpenMode enumeration to set and check database access modes. Higher values are compatible with lower ones.

```javascript
const mode = AcEdOpenMode.Write;
if (mode >= AcEdOpenMode.Review) {
  // Can perform review operations
}
```

--------------------------------

### Example Usage of AcApOpenDatabaseOptions

Source: https://mlightcad.github.io/cad-viewer/docs/interfaces/_mlightcad_cad-simple-viewer.AcApOpenDatabaseOptions.html

Demonstrates how to set options when opening a CAD database, specifying write mode and a custom font loader.

```typescript
const options: AcApOpenDatabaseOptions = {
  mode: AcEdOpenMode.Write,
  fontLoader: myFontLoader
};
```

--------------------------------

### AcApLineJig Accessor: entity

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApLineJig.html

Gets the transient line entity used by this jig.

```APIDOC
## entity
  * get entity(): AcDbLine
Gets transient line entity used by this jig.

### Returns AcDbLine
```

--------------------------------

### Constructor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApRevRectCmd.html

Creates an instance of the AcApRevRectCmd class.

```APIDOC
## constructor
  * new AcApRevRectCmd(): AcApRevRectCmd
Creates revision rectangle command instance.
#### Returns AcApRevRectCmd
```

--------------------------------

### AcApExportHtmlCmd.userData Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcApExportHtmlCmd.html

Gets or sets custom user-defined data associated with this command.

```APIDOC
## userData
  * get userData(): TUserData
Gets the custom user-defined data associated with this command.
`userData` is a generic, strongly-typed container that allows consumers of the command to attach arbitrary metadata without modifying the command class itself.
The shape of `userData` is defined by the generic parameter `TUserData` when the command is declared:
#### Returns TUserData
The user-defined data object associated with this command
#### Example
```
interface MyCommandData {
  sourceLayerId: string
  isPreview: boolean
}

class MyCommand extends AcEdCommand<MyCommandData> {}

const cmd = new MyCommand()
cmd.userData.sourceLayerId = 'Layer-01'
cmd.userData.isPreview = true
```
This design provides flexibility similar to `THREE.Object3D.userData` while preserving full compile-time type safety.
```

--------------------------------

### Using NotificationCenter Composable

Source: https://mlightcad.github.io/cad-viewer/docs/interfaces/_mlightcad_cad-viewer.Notification.html

Demonstrates how to import and use the `useNotificationCenter` composable to display different types of notifications and access notification counts. Includes examples of adding basic notifications and notifications with actions.

```javascript
import { useNotificationCenter } from '@mlightcad/cad-viewer'  
  
const { info, warning, error, success, notifications, unreadCount } = useNotificationCenter()  
  
// Add different types of notifications  
info('Information', 'This is an info message')  
warning('Warning', 'This is a warning message')  
error('Error', 'This is an error message')  
success('Success', 'This is a success message')  
  
// Add notification with actions  
error('File Error', 'Failed to load file', {  
actions: [  
{ label: 'Retry', action: () => retryLoad(), primary: true },  
{ label: 'Cancel', action: () => cancel() }  
],  
persistent: true  
})  
  
// Check notification count  
console.log(`You have ${unreadCount.value} notifications`)
```

--------------------------------

### appendKeywordsToMessage Accessor

Source: https://mlightcad.github.io/cad-viewer/docs/classes/_mlightcad_cad-simple-viewer.AcEdPromptKeywordOptions.html

Gets or sets whether keywords should be appended automatically to the message when rendering.

```APIDOC
### appendKeywordsToMessage
  * get appendKeywordsToMessage(): boolean
Gets or sets whether keywords should be appended automatically to the message when rendering. In AutoCAD .NET, this is `PromptOptions.AppendKeywordsToMessage`.
#### Returns boolean
  * set appendKeywordsToMessage(value: boolean): void
#### Parameters
    * value: boolean
#### Returns void
```
Tokens:
Raw