API / geotoolkit / welllog / data / ArrayLogDataSource / ArrayLogDataSource
data.ArrayLogDataSource.ArrayLogDataSource
Define data source for array log visuals like Log2DVisual wo use DataSeries
Example
// create a table from data table
import {ArrayLogDataSource} from '@int/geotoolkit/welllog/data/ArrayLogDataSource';
const datatable = new ArrayLogDataSource({
'datatable': table,
'depths': {'index': 0 },
'values': {'indices' : [1,2,3,4,5] },
'angles': { 'values': [0, Math.PI/2, Math.PI, Math.PI*3/2, Math.PI*2] }
});Example
// create a table from data series
const datatable = new ArrayLogDataSource({
'datatable': table,
'depths': {'series' : depthSeries },
'values': {'series' : [valSeries1, valSeries2, valSeries3, valSeries4, valSeries5] },
'angles': { 'values': [0, Math.PI/2, Math.PI, Math.PI*3/2, Math.PI*2] }
});↳
ArrayLogDataSource
Constructors
Methods
Constructors
• new ArrayLogDataSource(options?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional options | Options | initialization parameters |
ArrayLogAbstractData.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
ArrayLogAbstractData.getClassName
▸ getDataOrder(): Order
return the order of depths array
▸ getDataTable(): AbstractDataTable
Returns data table if any
data table
▸ 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
▸ getName(): string
Return name of the data
string
▸ getNumberOfRows(): number
Return number of rows
number
number fo rows
ArrayLogAbstractData.getNumberOfRows
▸ getRow(index): AbstractDataRow
Return a row by index
| Name | Type | Description |
|---|---|---|
index | number | index of the row |
a row
▸ getTimeStamp(): number
Return the value to indicate if data source was changed
number
ArrayLogAbstractData.getTimeStamp
▸ 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
▸ isForwardOnly(): boolean
Return information if depths have ascending order
Deprecated
since 5.0 Use getDataOrder instead
boolean
true if depths have ascending order
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): ArrayLogDataSource
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?): ArrayLogDataSource
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: ArrayLogDataSource, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ArrayLogDataSource
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: ArrayLogDataSource, args: EventMap[E]) => void | to be called |
this
▸ requestData(range, scale, callback?): void
Request data for specified range and scale
| Name | Type | Description |
|---|---|---|
range | Range | data range |
scale | number | data scale |
Optional callback | () => void | callback |
void
▸ setData(options?): void
Sets data
| Name | Type | Description |
|---|---|---|
Optional options | Options | initialization parameters |
void
▸ setIndexUnit(unit?): ArrayLogDataSource
Sets index unit
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | index unit |
this
ArrayLogAbstractData.setIndexUnit
▸ setName(name): ArrayLogDataSource
Set name of the data
| Name | Type | Description |
|---|---|---|
name | string | The data name |
this
▸ setSilent(bool): ArrayLogDataSource
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
ArrayLogAbstractData.setSilent
▸ Protected update(args?): void
Notify if data is changed
| Name | Type | Description |
|---|---|---|
Optional args | LogDataEvent | optional parameters |
void
▸ Protected updateTimeStamp(): void
Update time stamp
void
ArrayLogAbstractData.updateTimeStamp
▸ Static getClassName(): string
string