Class AcEdCommandLine

AutoCAD-style floating command line with Promise-based execution.

Features:

Floating command bar with left terminal glyph + down toggle and right up toggle
Command history popup
Message panel above the bar
Enter repeats last command if input empty
Esc cancels current command
Inline clickable options
Keyboard navigation
Promise-based execution for async command handling
Auto-complete popup for matching commands

Index

Constructors

constructor

new AcEdCommandLine(container?: HTMLElement): AcEdCommandLine
Parameters
- container: HTMLElement = document.body
Returns AcEdCommandLine
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:57

Accessors

visible

get visible(): boolean
Visibility of the command line

Returns boolean
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:80
set visible(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:84

Methods

cancelActiveSession

cancelActiveSession(): void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:136

clear

clear(): void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:96

clearInput

clearInput(): void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:106

clearPrompt

clearPrompt(): void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:101

executeCommand

executeCommand(cmdLine: string): void
Execute a command line string. Returns a Promise that resolves when the command is completed.
Parameters
- cmdLine: string
  Command string
Returns void
Promise
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:237

focusInput

focusInput(): void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:113

getKeywords

getKeywords(
options: AcEdPromptKeywordOptions,
allowTyping?: boolean,
): Promise<string>
Parameters
- options: AcEdPromptKeywordOptions
- allowTyping: boolean = true
Returns Promise<string>
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:142

getPromptInput

getPromptInput<T>(
    options: AcEdPromptKeywordOptions,
    parseValue: (text: string) => T | null,
    config: {
        allowNone: boolean;
        allowTyping?: boolean;
        mode: AcEdPromptInputMode;
    },
): Promise<AcEdPromptInputResult<T>>
Runs a mixed prompt-input session that accepts typed geometric or textual values together with optional keywords.
Type Parameters
- T
Parameters
- options: AcEdPromptKeywordOptions
- parseValue: (text: string) => T | null
- config: { allowNone: boolean; allowTyping?: boolean; mode: AcEdPromptInputMode }
Returns Promise<AcEdPromptInputResult<T>>
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:159

renderKeywordPrompt

renderKeywordPrompt(
options: AcEdPromptKeywordOptions,
onClick: (kw: string) => void,
): void
Render prompt message and keyword options in command line
Parameters
- options: AcEdPromptKeywordOptions
- onClick: (kw: string) => void
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:815

setInputReadOnly

setInputReadOnly(readOnly: boolean): void
Parameters
- readOnly: boolean
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:117

setPrompt

setPrompt(message?: string): void
Parameters
- Optionalmessage: string
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:88

showMessage

showMessage(message: string, type?: AcEdMessageType, msgKey?: string): void
Displays a message in the command line history panel.
Parameters
- message: string
  Text to append to the command line message panel
- type: AcEdMessageType = 'info'
  Message severity controlling the rendered style
- OptionalmsgKey: string
  Optional localization key stored with the rendered entry
Returns void
- Defined in packages/cad-simple-viewer/src/editor/input/ui/AcEdCommandLine.ts:128

Class AcEdCommandLine

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcEdCommandLine

Accessors

visible

Returns boolean

Parameters

Returns void

Methods

cancelActiveSession

Returns void

clear

Returns void

clearInput

Returns void

clearPrompt

Returns void

executeCommand

Parameters

Returns void

focusInput

Returns void

getKeywords

Parameters

Returns Promise<string>

getPromptInput

Type Parameters

Parameters

Returns Promise<AcEdPromptInputResult<T>>

renderKeywordPrompt

Parameters

Returns void

setInputReadOnly

Parameters

Returns void

setPrompt

Parameters

Returns void

showMessage

Parameters

Returns void

Settings

On This Page