API / geotoolkit / controls / tools / editors / commands / Translation / Translation
commands.Translation.Translation
Command for translating node
↳
Translation
Constructors
Methods
Constructors
• new Translation(dx, dy)
| Name | Type | Description |
|---|---|---|
dx | number | x-ordinate translation value |
dy | number | y-ordinate translation value |
AbstractCommand.constructor
Methods
▸ createInverse(): AbstractCommand
Returns inverse command
▸ getClassName(): string
string
▸ getEventName(): string
Returns event to be fired when command is applied
string
Returns target command node
▸ getOptions(): Record<string, any>
Returns command options
Record<string, any>
▸ getTranslateX(): number
Returns X translation (dx)
number
▸ getTranslateY(): number
Returns Y translation (dy)
number
▸ 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(): Translation
Rejects action
this
▸ setNode(node): Translation
Sets target node for the command
this
▸ setOptions(options): Translation
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): Translation
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 getClassName(): string
string