Class: LogAbstractData

• new LogAbstractData()

• Protected new LogAbstractData()

EventDispatcher.constructor

▸ Abstract calculateNeatLimits(logScale, centerOnZeroOnNegativeMin, displayUnit): number[]

Return an array of neat min and max

number[]

▸ Abstract clear(): LogAbstractData

Clear log data. Removes all samples and reset depth limits

LogAbstractData

this

▸ dispose(): void

Dispose.

void

EventDispatcher.dispose

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ Abstract getDataOrder(): Order

Return the order of the log data

Order

▸ getDepth(index): number

Return depth by index

number

▸ Abstract getDepths(): number[]

Return an array of depths

number[]

▸ getIndexAt(depth, fromIndex?, toIndex?): number

Return index for specified depth

number

▸ Abstract getIndexUnit(): AbstractUnit

Return the value unit

Throws

when this method is not implemented

AbstractUnit

▸ Abstract getMaxDepth(): number

Return maximum depth

Throws

when this method is not implemented

number

▸ Abstract getMaxMeaningDepth(): number

Return maximum Meaning depth (last depth with value)

number

▸ Abstract getMaxValue(): number

Return maximum data value

number

▸ Abstract getMinDepth(): number

Return minimum depth

Throws

when this method is not implemented

number

▸ Abstract getMinMeaningDepth(): number

Return minimum Meaning depth (first depth with value)

number

▸ Abstract getMinValue(): number

Return minimum data value

number

▸ Abstract getName(): string

Return name of the data

string

▸ Abstract getSize(): number

Return the count of the samples

number

▸ getState(): LogDataState

Return state

LogDataState

▸ getTimeStamp(): number

Return the value to indicate if data source was changed

number

▸ getValue(index): number

Return value by index

number

▸ getValueAt(depth, fromIndex?, toIndex?, interpolation?): number

Return the value matching the given depth or NaN if the given depth is out of the logdata depth range.

If the depths are strictly increasing:

• The returned value will be interpolated when necessary. See example 1

If the depths are not strictly increasing but never decreasing:

• The value returned will be the first one found (in the insertion order). See example 2
• The value returned will be interpolated between the last one found and its closest larger neighbor. See example 2

If the depths are not always increasing (not forward only):

• The value returned will be the last one found (in the insertion order). See example 3
• The value returned will be interpolated between the first one found and its closest larger neighbor. See example 3

Examples assume the default linear interpolation

Example

// Depth Value
// 0      0
// 100    1
// 200    2

getValueAt(100) // -> 1
getValueAt(150) // -> 1.5

Example

// Depth Value
// 0      0
// 100    1
// 100    2
// 200    3

getValueAt(100) // -> 1
getValueAt(150) // -> 2.5

Example

// Depth Value
// 0      0
// 100    1
// 200    2
// 100    3

getValueAt(100) // -> 3
getValueAt(150) // -> 1.5

number

▸ Abstract getValueInRange(depth, prev, next): number

Return value by depth, using linear interpolation if necessary. See LogAbstractData.findValueAt.

Throws

when this method is not implemented

number

▸ Abstract getValueUnit(): AbstractUnit

Return the depth unit

Throws

when this method is not implemented

AbstractUnit

▸ Abstract getValues(): number[]

Return an array of values

number[]

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

EventDispatcher.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ Abstract isForwardOnly(): boolean

Return true if data is in ascending order

boolean

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

EventDispatcher.isSilent

▸ notify<E>(type, source, args?): LogAbstractData

Notify listeners

LogAbstractData

this

EventDispatcher.notify

▸ off<E>(type?, callback?): LogAbstractData

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

LogAbstractData

this

EventDispatcher.off

▸ on<E>(type, callback): LogAbstractData

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

LogAbstractData

this

EventDispatcher.on

▸ Abstract requestData(range, scale, callback?): void

void

▸ resumeUpdate(forceUpdate): LogAbstractData

Resume update. forceUpdate updates data statistics (update min, max of values, depths...)

LogAbstractData

this

▸ Abstract setIndexUnit(unit): LogAbstractData

Sets index unit

Throws

when this method is not implemented

LogAbstractData

this

▸ Abstract setName(name): LogAbstractData

Set name of the data

LogAbstractData

this

▸ setSilent(bool): LogAbstractData

Set silent mode

LogAbstractData

this

EventDispatcher.setSilent

▸ setState(state): LogAbstractData

Sets state of data. Values can be (Empty,Normal, Warning,Error,Fetching).

LogAbstractData

this

▸ Abstract setValue(index, value): LogAbstractData

Set value by index

Throws

when this method is not implemented

LogAbstractData

this

▸ Abstract setValueUnit(unit): LogAbstractData

Sets value unit

Throws

when this method is not implemented

LogAbstractData

this

▸ suspendUpdate(): LogAbstractData

Suspend update

LogAbstractData

this

▸ Protected update(args?): void

Notify when data has been changed.

void

▸ Protected Abstract updateDataStatistics(): LogAbstractData

Update data statistics

LogAbstractData

this

▸ updateTimeStamp(): void

Update time stamp

void

▸ Static findValueAt(depth, depths, values, prev, next, interpolation?): number

Utility function to interpolate a value between two depths.

number

The interpolated value or Number.NaN if outside the range

▸ Static getClassName(): string

string

EventDispatcher.getClassName

▸ Static interpolateValueAt(depth, depthPrev, valuePrev, depthNext, valueNext, interpolation?): number

Utility function to interpolate a value between two depths.

number

The interpolated value or Number.NaN if outside the range