API / geotoolkit / welllog / data / Log2DVisualData / Log2DVisualData
data.Log2DVisualData.Log2DVisualData
Log2DVisualData holds Log2DDataRow objects and is passed into a Log2DVisual.
↳
Log2DVisualData
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
Constructors
• new Log2DVisualData(depths?, values?, name?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional depths | number[] | array of depths |
Optional values | number[][] | array of values |
Optional name | string | name of dataset |
ArrayLogAbstractData.constructor
• new Log2DVisualData(props?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional props | Options | object with properties |
ArrayLogAbstractData.constructor
Methods
▸ addRow(row): Log2DVisualData
Add row
| Name | Type | Description |
|---|---|---|
row | Log2DDataRow | rows of values and angles at current depths |
this
▸ addValues(depths, values): Log2DVisualData
Add values
| Name | Type | Description |
|---|---|---|
depths | number[] | array of depths |
values | number[][] | sample values array |
this
▸ calculateLimits(calculateValues): Log2DVisualData
Recalculate depth limits and optional value limits
| Name | Type | Description |
|---|---|---|
calculateValues | boolean | Recalculate depth limits and optional value limits or not |
this
▸ clear(): Log2DVisualData
Cleans all data
▸ dataChanged(): void
Notifies this shape that the data was changed outside of its knowledge
void
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
ArrayLogAbstractData.getClassName
▸ getDataOrder(): Order
Get order of depths
enum describing order of data
▸ getDepths(): number[]
Return an array of depths
number[]
▸ getIndexUnit(): AbstractUnit
Returns index unit
ArrayLogAbstractData.getIndexUnit
▸ getMaxAngle(): number
Return maximum angle of columns in radians
number
ArrayLogAbstractData.getMaxAngle
▸ getMaxDepth(): number
Return maximum depth
number
ArrayLogAbstractData.getMaxDepth
▸ getMaxValue(): number
Return maximum value
number
ArrayLogAbstractData.getMaxValue
▸ getMinAngle(): number
Return minimum angle of columns in radians
number
ArrayLogAbstractData.getMinAngle
▸ getMinDepth(): number
Return minimum depth
number
ArrayLogAbstractData.getMinDepth
▸ getMinValue(): number
Return minimum value
number
ArrayLogAbstractData.getMinValue
▸ getNDVValue(): number
Get NDV
number
value used as NDV
▸ getName(): string
Return name of the data
string
▸ getNumberOfRows(): number
Return number of rows
number
number of rows
ArrayLogAbstractData.getNumberOfRows
▸ getRow(index): Log2DDataRow
Return a row by index
| Name | Type | Description |
|---|---|---|
index | number | index of the row |
a row
▸ getRows(): Log2DDataRow[]
A array of the rows. if the data in changed then it is necessary to call updateLimits to recalculate the data limits
▸ getTimeStamp(): number
Return the value to indicate if data source was changed
number
ArrayLogAbstractData.getTimeStamp
▸ getValues(): number[][]
Return values
number[][]
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
ArrayLogAbstractData.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
ArrayLogAbstractData.isDisposed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ 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]| Name | Type | Description |
|---|---|---|
depths | number[] | array of depths |
values | number[][] | array of array values of current depths |
Optional angles | number[][] | array angle values |
Optional offsets | number[] | array of offsets |
Optional existingOffsets | number[] | array of the current offsets. New offset will be merged to current offsets |
void
▸ notify<E>(type, source, args?): Log2DVisualData
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | ArrayLogAbstractData | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ 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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: Log2DVisualData, args: EventMap[E]) => void | function to be called |
this
▸ 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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Log2DVisualData, args: EventMap[E]) => void | to be called |
this
▸ setExtremumValues(minDepth, maxDepth, minValue, maxValue): Log2DVisualData
Set the extreme values. If unknown or unspecified, please use calculateLimits
| Name | Type | Description |
|---|---|---|
minDepth | number | min depth limit |
maxDepth | number | max depth limit |
minValue | number | min value for all rows |
maxValue | number | max value for all rows |
this
▸ setIndexUnit(unit?): Log2DVisualData
Sets index unit
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | index unit |
this
ArrayLogAbstractData.setIndexUnit
▸ 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
| Name | Type | Description |
|---|---|---|
ndv | number | value used as NDV |
this
▸ setName(name): Log2DVisualData
Set name of the data
| Name | Type | Description |
|---|---|---|
name | string | The data name |
this
▸ setSilent(bool): Log2DVisualData
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
ArrayLogAbstractData.setSilent
▸ setValues(depths?, values?, angles?): Log2DVisualData
Sets passed values
| Name | Type | Description |
|---|---|---|
Optional depths | number[] | array of depths |
Optional values | number[][] | array of array values of current depths |
Optional angles | number[][] | array of angles |
▸ Protected update(args?): void
Notify if data is changed
| Name | Type | Description |
|---|---|---|
Optional args | LogDataEvent | optional parameters |
void
▸ updateLimits(): Log2DVisualData
Recalculate depth and value limits
this
▸ Protected updateTimeStamp(): void
Update time stamp
void
ArrayLogAbstractData.updateTimeStamp
▸ Static getClassName(): string
string