@univerjs/core v0.1.17 • Docs
Interface: ICommandService
Methods
beforeCommandExecuted()
beforeCommandExecuted(listener): IDisposable
Register a callback function that will be executed before a command is executed.
Parameters
Parameter | Type |
---|---|
listener | CommandListener |
Returns
IDisposable
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:163 (opens in a new tab)
executeCommand()
executeCommand<P, R>(
id,
params?,
options?): Promise<R>
Type Parameters
Type Parameter | Default type |
---|---|
P extends object | object |
R | boolean |
Parameters
Parameter | Type |
---|---|
id | string |
params ? | P |
options ? | IExecutionOptions |
Returns
Promise
<R
>
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:144 (opens in a new tab)
hasCommand()
hasCommand(commandId)
hasCommand(commandId): boolean
Check if a command is already registered at the current command service.
Parameters
Parameter | Type | Description |
---|---|---|
commandId | string | The id of the command. |
Returns
boolean
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:138 (opens in a new tab)
hasCommand(id)
hasCommand(id): boolean
Parameters
Parameter | Type |
---|---|
id | string |
Returns
boolean
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:150 (opens in a new tab)
onCommandExecuted()
onCommandExecuted(listener): IDisposable
Register a callback function that will be executed after a command is executed.
Parameters
Parameter | Type |
---|---|
listener | CommandListener |
Returns
IDisposable
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:157 (opens in a new tab)
registerCommand()
registerCommand(command): IDisposable
Parameters
Parameter | Type |
---|---|
command | ICommand <object , unknown > |
Returns
IDisposable
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:140 (opens in a new tab)
registerMultipleCommand()
registerMultipleCommand(command): IDisposable
Parameters
Parameter | Type |
---|---|
command | ICommand <object , unknown > |
Returns
IDisposable
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:142 (opens in a new tab)
syncExecuteCommand()
syncExecuteCommand<P, R>(
id,
params?,
options?): R
Type Parameters
Type Parameter | Default type |
---|---|
P extends object | object |
R | boolean |
Parameters
Parameter | Type |
---|---|
id | string |
params ? | P |
options ? | IExecutionOptions |
Returns
R
Defined in
submodules/univer/packages/core/src/services/command/command.service.ts:152 (opens in a new tab)