Last updated

API / geotoolkit / welllog / data / Log2DVisualData / Log2DVisualData

Class: Log2DVisualData

data.Log2DVisualData.Log2DVisualData

Log2DVisualData holds Log2DDataRow objects and is passed into a Log2DVisual.

Hierarchy

Table of contents

Constructors
[new Log2DVisualData(depths, values, name)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.data-4.log2dvisualdata.log2dvisualdata.md#new log2dvisualdata(depths, values, name))[new Log2DVisualData(props)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.data-4.log2dvisualdata.log2dvisualdata.md#new log2dvisualdata(props))
Methods

Contents

Constructors

new Log2DVisualData(depths, values, name)

new Log2DVisualData(depths?, values?, name?)

Constructor

Parameters

Name Type Description
Optional depthsnumber[]array of depths
Optional valuesnumber[][]array of values
Optional namestringname of dataset

Overrides

ArrayLogAbstractData.constructor


new Log2DVisualData(props)

new Log2DVisualData(props?)

Constructor

Parameters

Name Type Description
Optional propsOptionsobject with properties

Overrides

ArrayLogAbstractData.constructor

Methods

addRow

addRow(row): Log2DVisualData

Add row

Parameters

Name Type Description
rowLog2DDataRowrows of values and angles at current depths

Returns

Log2DVisualData

this


addValues

addValues(depths, values): Log2DVisualData

Add values

Parameters

Name Type Description
depthsnumber[]array of depths
valuesnumber[][]sample values array

Returns

Log2DVisualData

this


calculateLimits

calculateLimits(calculateValues): Log2DVisualData

Recalculate depth limits and optional value limits

Parameters

Name Type Description
calculateValuesbooleanRecalculate depth limits and optional value limits or not

Returns

Log2DVisualData

this


clear

clear(): Log2DVisualData

Cleans all data

Returns

Log2DVisualData


dataChanged

dataChanged(): void

Notifies this shape that the data was changed outside of its knowledge

Returns

void


dispose

dispose(): void

Dispose.

Returns

void

Inherited from

ArrayLogAbstractData.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

ArrayLogAbstractData.getClassName


getDataOrder

getDataOrder(): Order

Get order of depths

Returns

Order

enum describing order of data


getDepths

getDepths(): number[]

Return an array of depths

Returns

number[]


getIndexUnit

getIndexUnit(): AbstractUnit

Returns index unit

Returns

AbstractUnit

Inherited from

ArrayLogAbstractData.getIndexUnit


getMaxAngle

getMaxAngle(): number

Return maximum angle of columns in radians

Returns

number

Overrides

ArrayLogAbstractData.getMaxAngle


getMaxDepth

getMaxDepth(): number

Return maximum depth

Returns

number

Overrides

ArrayLogAbstractData.getMaxDepth


getMaxValue

getMaxValue(): number

Return maximum value

Returns

number

Overrides

ArrayLogAbstractData.getMaxValue


getMinAngle

getMinAngle(): number

Return minimum angle of columns in radians

Returns

number

Overrides

ArrayLogAbstractData.getMinAngle


getMinDepth

getMinDepth(): number

Return minimum depth

Returns

number

Overrides

ArrayLogAbstractData.getMinDepth


getMinValue

getMinValue(): number

Return minimum value

Returns

number

Overrides

ArrayLogAbstractData.getMinValue


getNDVValue

getNDVValue(): number

Get NDV

Returns

number

value used as NDV


getName

getName(): string

Return name of the data

Returns

string

Inherited from

ArrayLogAbstractData.getName


getNumberOfRows

getNumberOfRows(): number

Return number of rows

Returns

number

number of rows

Overrides

ArrayLogAbstractData.getNumberOfRows


getRow

getRow(index): Log2DDataRow

Return a row by index

Parameters

Name Type Description
indexnumberindex of the row

Returns

Log2DDataRow

a row

Overrides

ArrayLogAbstractData.getRow


getRows

getRows(): Log2DDataRow[]

A array of the rows. if the data in changed then it is necessary to call updateLimits to recalculate the data limits

Returns

Log2DDataRow[]


getTimeStamp

getTimeStamp(): number

Return the value to indicate if data source was changed

Returns

number

Inherited from

ArrayLogAbstractData.getTimeStamp


getValues

getValues(): number[][]

Return values

Returns

number[][]


hasEventListener

hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

ArrayLogAbstractData.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

ArrayLogAbstractData.isDisposed


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

ArrayLogAbstractData.isSilent


mergeValues

mergeValues(depths, values, angles?, offsets?, existingOffsets?): void

Inserts/Replace the given values at the correct place in the log. This function works ONLY if the existing data is ordered.

Example

// Depth Value
// 50     [0, 1]
// 100    [1, 2]
// 200    [2, 3]
// 300    [3, 4]

mergeValue([0,100,150,500], [[-1,1],[-100,-200],[-150, -123],[-500, -200]])

//   ----     Depth       Value
//   ===>       0           [-1,1]
//   ----      50            [0, 1]
//   ===>      100         [-100,-200]
//   ===>      150         [-150, -123]
//   ----      200           [2, 3]
//   ----      300           [3, 4]
//   ===>      500         [-500, -200]

Parameters

Name Type Description
depthsnumber[]array of depths
valuesnumber[][]array of array values of current depths
Optional anglesnumber[][]array angle values
Optional offsetsnumber[]array of offsets
Optional existingOffsetsnumber[]array of the current offsets. New offset will be merged to current offsets

Returns

void


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceArrayLogAbstractDataof the event
Optional argsEventMap[E]arguments of the event

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.notify


off

off<E>(type?, callback?): Log2DVisualData

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: Log2DVisualData, args: EventMap[E]) => voidfunction to be called

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.off


on

on<E>(type, callback): Log2DVisualData

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: Log2DVisualData, args: EventMap[E]) => voidto be called

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.on


setExtremumValues

setExtremumValues(minDepth, maxDepth, minValue, maxValue): Log2DVisualData

Set the extreme values. If unknown or unspecified, please use calculateLimits

Parameters

Name Type Description
minDepthnumbermin depth limit
maxDepthnumbermax depth limit
minValuenumbermin value for all rows
maxValuenumbermax value for all rows

Returns

Log2DVisualData

this


setIndexUnit

setIndexUnit(unit?): Log2DVisualData

Sets index unit

Parameters

Name Type Description
Optional unitstring | AbstractUnitindex unit

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.setIndexUnit


setNDVValue

setNDVValue(ndv): Log2DVisualData

Set NDV. All NDV values in the data will be deleted at the first rasterize If you wish to change NDV after rasterize, please reload data

Parameters

Name Type Description
ndvnumbervalue used as NDV

Returns

Log2DVisualData

this


setName

setName(name): Log2DVisualData

Set name of the data

Parameters

Name Type Description
namestringThe data name

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.setName


setSilent

setSilent(bool): Log2DVisualData

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

Log2DVisualData

this

Inherited from

ArrayLogAbstractData.setSilent


setValues

setValues(depths?, values?, angles?): Log2DVisualData

Sets passed values

Parameters

Name Type Description
Optional depthsnumber[]array of depths
Optional valuesnumber[][]array of array values of current depths
Optional anglesnumber[][]array of angles

Returns

Log2DVisualData


update

Protected update(args?): void

Notify if data is changed

Parameters

Name Type Description
Optional argsLogDataEventoptional parameters

Returns

void

Inherited from

ArrayLogAbstractData.update


updateLimits

updateLimits(): Log2DVisualData

Recalculate depth and value limits

Returns

Log2DVisualData

this


updateTimeStamp

Protected updateTimeStamp(): void

Update time stamp

Returns

void

Inherited from

ArrayLogAbstractData.updateTimeStamp


getClassName

Static getClassName(): string

Returns

string

Inherited from

ArrayLogAbstractData.getClassName