API / geotoolkit / controls / tools / editors / commands / addpoint / AddPoint
Command of adding a new point to the node
↳
AddPoint
Constructors
Methods
Constructors
• new AddPoint(point, index, isInsert?)
| Name | Type | Description |
|---|---|---|
point | Point | point to be added |
index | number | position of the point to be added |
Optional isInsert | boolean | true if new point should be inserted, false otherwise |
AbstractCommand.constructor
Methods
▸ createInverse(): AbstractCommand
Returns inverse command
▸ getClassName(): string
string
▸ getEventName(): string
Returns event to be fired when command is applied
string
▸ getIndex(): number
Returns new point index position
number
Returns target command node
▸ getOptions(): Record<string, any>
Returns command options
Record<string, any>
▸ getPoint(): Point
Returns new point
▸ getX(): number
Returns new point x-ordinate
number
▸ getY(): number
Returns new point y-ordinate
number
▸ isInsert(): boolean
Returns true if new point should be inserted, false otherwise
boolean
▸ 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(): AddPoint
Rejects action
this
▸ setNode(node): AddPoint
Sets target node for the command
this
▸ setOptions(options): AddPoint
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): AddPoint
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