Skip to content
Last updated

API / geotoolkit / report / dom / CollectionEventArgs.ts / CollectionEventArgs

Class: CollectionEventArgs

dom.CollectionEventArgs.ts.CollectionEventArgs

DOM Node collection event class.

Hierarchy

Table of contents

Constructors
  • [new CollectionEventArgs(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.report.dom.collectioneventargs.ts.collectioneventargs.md#new collectioneventargs(options))
Accessors
Methods

Contents

Constructors

new CollectionEventArgs(options)

• new CollectionEventArgs(options)

Parameters

Name Type Description
optionsOptionsnode event args options

Overrides

NodeEventArgs.constructor

Accessors

changes

• get changes(): CollectionChangesType

Changes

Name

module:geotoolkit/report/dom/NodeEventArgs~CollectionEventArgs#changes

Returns

CollectionChangesType


name

• get name(): string | string[]

Name

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#name

Returns

string | string[]

Inherited from

NodeEventArgs.name


newValue

• get newValue(): any

New Value

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#newValue

Returns

any

Inherited from

NodeEventArgs.newValue


oldValue

• get oldValue(): any

Old Value

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#oldValue

Returns

any

Inherited from

NodeEventArgs.oldValue


reference

• get reference(): Node

Reference

Name

module:geotoolkit/report/dom/NodeEventArgs~CollectionEventArgs#reference

Returns

Node


reset

• get reset(): boolean

Reset flag

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#reset

Returns

boolean

Inherited from

NodeEventArgs.reset


silent

• get silent(): boolean

Silent flag

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#silent

Returns

boolean

Inherited from

NodeEventArgs.silent


source

• get source(): Node

Source

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#source

Returns

Node

Inherited from

NodeEventArgs.source

• set source(value): void

Source

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#source

Parameters

Name Type
valueNode

Returns

void

Inherited from

NodeEventArgs.source


type

• get type(): NodeChanges

Node changes type

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#type

Returns

NodeChanges

Inherited from

NodeEventArgs.type


value

• get value(): any

Value

Name

module:geotoolkit/report/dom/NodeEventArgs~NodeEventArgs#value

Returns

any

Inherited from

NodeEventArgs.value

Methods

getChanges

▸ getChanges(): CollectionChangesType

Return Collection changes type

Returns

CollectionChangesType

Collection changes type


getEventName

▸ getEventName(): string

Returns event name

Returns

string

Inherited from

NodeEventArgs.getEventName


getName

▸ getName(): string | string[]

Return Node changes name

Returns

string | string[]

Node changes name

Inherited from

NodeEventArgs.getName


getNewValue

▸ getNewValue(): any

Return Node changes new-value

Returns

any

Node changes new-value

Inherited from

NodeEventArgs.getNewValue


getOldValue

▸ getOldValue(): any

Return Node changes old-value

Returns

any

Node changes old-value

Inherited from

NodeEventArgs.getOldValue


getReference

▸ getReference(): Node

Return Collection changes reference

Returns

Node

Collection changes reference


getReset

▸ getReset(): boolean

Return Node changes reset flag

Returns

boolean

Node changes reset flag

Inherited from

NodeEventArgs.getReset


getSilent

▸ getSilent(): boolean

Return Node changes silent flag

Returns

boolean

Node changes silent flag

Inherited from

NodeEventArgs.getSilent


getSource

▸ getSource(): Node

Return Node changes source

Returns

Node

Node changes source

Inherited from

NodeEventArgs.getSource


getType

▸ getType(): NodeChanges

Return Node changes type

Returns

NodeChanges

Node changes type

Inherited from

NodeEventArgs.getType


getValue

▸ getValue(): any

Return Node changes value

Returns

any

Node changes value

Inherited from

NodeEventArgs.getValue


isCanceled

▸ isCanceled(): boolean

Returns whether event has been cancelled

Returns

boolean

Inherited from

NodeEventArgs.isCanceled


isPreventDefault

▸ isPreventDefault(): boolean

Returns whether event has been prevented default

Returns

boolean

Inherited from

NodeEventArgs.isPreventDefault


preventDefault

▸ preventDefault(): CollectionEventArgs

Prevents default

Returns

CollectionEventArgs

this

Inherited from

NodeEventArgs.preventDefault


setSource

▸ setSource(source): CollectionEventArgs

Set Node changes source

Parameters

Name Type Description
sourceNodeNode Changes source

Returns

CollectionEventArgs

Inherited from

NodeEventArgs.setSource


stopPropagation

▸ stopPropagation(): CollectionEventArgs

Stops propagation

Returns

CollectionEventArgs

this

Inherited from

NodeEventArgs.stopPropagation