Last updated

API / geotoolkit / welllog / data / LogDataEvent / LogDataEvent

Class: LogDataEvent

data.LogDataEvent.LogDataEvent

Define event to be used to notify about data changed

Table of contents

Constructors
Methods

Contents

Constructors

new LogDataEvent(startDepth, endDepth, oldStartDepth, oldEndDepth, valueLimitsChanged, valueAddedToTail)

new LogDataEvent(startDepth?, endDepth?, oldStartDepth?, oldEndDepth?, valueLimitsChanged?, valueAddedToTail?)

Constructor

Parameters

Name Type Description
Optional startDepthnumberstart depth
Optional endDepthnumberend depth
Optional oldStartDepthnumberold start depth
Optional oldEndDepthnumberold end depth
Optional valueLimitsChangedbooleandefines if values limits are changed or not
Optional valueAddedToTailbooleandefines if values are added to the tail
Methods

getClassName

getClassName(): string

Returns

string


getEndDepth

getEndDepth(): number

Return end depth

Returns

number


getIndexRange

getIndexRange(): number[] | Range

Returns

number[] | Range


getOldEndDepth

getOldEndDepth(): number

Return old end depth

Returns

number


getOldStartDepth

getOldStartDepth(): number

Return old start depth

Returns

number


getStartDepth

getStartDepth(): number

Return start depth

Returns

number


isValueAddedToTail

isValueAddedToTail(): boolean

Return true if values are added to the tail. This could happen in case of real time

Returns

boolean


isValueLimitsChanged

isValueLimitsChanged(): boolean

Return true if values limits are changed

Returns

boolean


isValueRemovedFromEnd

isValueRemovedFromEnd(): boolean

Return true if values was removed from the bottom of the datasource

Returns

boolean


isValueRemovedFromStart

isValueRemovedFromStart(): boolean

Return true if values was removed from the top of the datasource

Returns

boolean


getClassName

Static getClassName(): string

Returns

string


getEvent

Static getEvent(startDepth?, endDepth?, oldStartDepth?, oldEndDepth?, valueLimitsChanged?, valueAddedToTail?): LogDataEvent

Returns the same instance of the event arguments to void multiple events creation. It means that this event cannot be kept.

Parameters

Name Type Description
Optional startDepthnumberstart depth
Optional endDepthnumberend depth
Optional oldStartDepthnumberold start depth
Optional oldEndDepthnumberold end depth
Optional valueLimitsChangedbooleandefines if values limits are changed or not
Optional valueAddedToTailbooleandefines if values are added to the tail

Returns

LogDataEvent

event