API / geotoolkit / data / DataInterpolation / DataInterpolation
data.DataInterpolation.DataInterpolation
The DataInterpolation interface defines a set of methods that allow you to synthetically generate points
between two depth values that define how the curve for the data will be drawn.
Interpolation objects are used to modify the default linear interpolation between two depth values defined in a
particular well log data source (LogData) before being sent to the rendering system.
Interpolation objects modify the flow of data values by adding generated points in between two depth values that are drawn.
Interpolation objects do not modify the source data. They only generate new values between two existing depth values.
Interpolation objects were designed to be extensible to meet the requirements of well log visualization.
↳
DataInterpolation
Constructors
Methods
Constructors
• new DataInterpolation()
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getProperties(): Record<string, any>
Gets all the properties pertaining to this object
Record<string, any>
object containing properties
▸ 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
EventDispatcher.hasEventListener
▸ Abstract interpolate(start, count, input, output): boolean
Interpolate array of samples
Throws
when invoked to indicate the method should be overridden.
| Name | Type | Description |
|---|---|---|
start | number | The start index |
count | number | The count of samples to interpolate |
input | DataValueArray | The input data |
output | DataValueArray | The output data |
boolean
true if interpolation is successful
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(event, source, args?): DataInterpolation
Notify listeners of the DataInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
event | E | type of event |
source | DataInterpolation | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off(type?, callback?): DataInterpolation
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 | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): DataInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataInterpolation, args: EventMap[E]) => void |
▸ on(type, callback, options?): DataInterpolation
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 | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): DataInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataInterpolation, args: EventMap[E]) => void |
Optional options | Options |
▸ setProperties(properties): DataInterpolation
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
properties | Record<string, any> | An object containing the properties to set |
this
▸ setSilent(bool): DataInterpolation
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string