Last updated

API / geotoolkit / controls / tools / editors / commands / addpoint / DeletePoint

Class: DeletePoint

commands.addpoint.DeletePoint

Command to delete point from node

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new DeletePoint(point, index)

new DeletePoint(point, index)

Parameters

Name Type Description
pointPointpoint coordinates
indexnumberindex of the point to delete

Overrides

AbstractCommand.constructor

Methods

createInverse

createInverse(): AddPoint

Returns inverse command

Returns

AddPoint

Overrides

AbstractCommand.createInverse


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractCommand.getClassName


getEventName

getEventName(): string

Returns event to be fired when command is applied

Returns

string

Inherited from

AbstractCommand.getEventName


getIndex

getIndex(): number

Returns point index position

Returns

number


getNode

getNode(): Node | Node[]

Returns target command node

Returns

Node | Node[]

Inherited from

AbstractCommand.getNode


getOptions

getOptions(): Record<string, any>

Returns command options

Returns

Record<string, any>

Inherited from

AbstractCommand.getOptions


getX

getX(): number

Returns point x-ordinate

Returns

number


getY

getY(): number

Returns point y-ordinate

Returns

number


isRejected

isRejected(): boolean

Returns rejected state

Returns

boolean

the state

Inherited from

AbstractCommand.isRejected


isSeparate

isSeparate(): boolean

Returns true if command is separate, false otherwise

Returns

boolean

Inherited from

AbstractCommand.isSeparate


merge

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.

Parameters

Name Type Description
commandAbstractCommandcommand to merge

Returns

boolean

Inherited from

AbstractCommand.merge


reject

reject(): DeletePoint

Rejects action

Returns

DeletePoint

this

Inherited from

AbstractCommand.reject


setNode

setNode(node): DeletePoint

Sets target node for the command

Parameters

Name Type Description
nodeNode | Node[]node(s) for applying the command

Returns

DeletePoint

this

Inherited from

AbstractCommand.setNode


setOptions

setOptions(options): DeletePoint

Sets extra options to be stored in command

Parameters

Name Type Description
optionsRecord<string, any>some extra options for the command to store

Returns

DeletePoint

this

Inherited from

AbstractCommand.setOptions


setSeparate

setSeparate(isSeparate): DeletePoint

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.

Parameters

Name Type Description
isSeparatebooleantrue if command should be considered as a separate operation (in undo/redo history), false otherwise

Returns

DeletePoint

this

Inherited from

AbstractCommand.setSeparate


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractCommand.getClassName