API / geotoolkit / welllog / widgets / tools / annotations / commands / ChangeLink / ChangeLink
commands.ChangeLink.ChangeLink
The command for link/unlink the edited node
↳
ChangeLink
Constructors
- [new ChangeLink()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.widgets-4.tools-5.annotations.commands.changelink.changelink.md#new changelink())
Methods
Methods
▸ createInverse(): ChangeLink
Returns inverse command
ExecutableCommand.createInverse
▸ execute(editor): boolean
| Name | Type |
|---|---|
editor | AbstractEditorBase<Node | Node[]> |
boolean
▸ getClassName(): string
string
ExecutableCommand.getClassName
▸ getEventName(): string
Returns event to be fired when command is applied
string
ExecutableCommand.getEventName
Returns target command node
▸ getOptions(): Record<string, any>
Returns command options
Record<string, any>
▸ isRejected(): boolean
Returns rejected state
boolean
the state
▸ isSeparate(): boolean
Returns true if command is separate, false otherwise
boolean
▸ merge(command): boolean
Tries to merge current with another command. If successful, return true and second command won't be stored in history. Returns false otherwise.
| Name | Type | Description |
|---|---|---|
command | AbstractCommand | command to merge |
boolean
▸ reject(): ChangeLink
Rejects action
this
▸ setNode(node): ChangeLink
Sets target node for the command
this
▸ setOptions(options): ChangeLink
Sets extra options to be stored in command
| Name | Type | Description |
|---|---|---|
options | Record<string, any> | some extra options for the command to store |
this
▸ setSeparate(isSeparate): ChangeLink
Sets command to be separate or not (true by default). Not separate commands are ignored by history undo/redo actions and considered as a part of the last separate command.
| Name | Type | Description |
|---|---|---|
isSeparate | boolean | true if command should be considered as a separate operation (in undo/redo history), false otherwise |
this
▸ Static canLink(editor): boolean
| Name | Type |
|---|---|
editor | AbstractEditorBase<Node | Node[]> |
boolean
▸ Static getClassName(): string
string
ExecutableCommand.getClassName
▸ Static isLinked(editor): boolean
| Name | Type |
|---|---|
editor | AbstractEditorBase<Node | Node[]> |
boolean