API / geotoolkit / data / DataStepInterpolation / DataStepInterpolation
data.DataStepInterpolation.DataStepInterpolation
Provides step-like interpolation for well log data. It provides zigzag-type interpolation with alternate horizontal and vertical lines.
↳
DataStepInterpolation
Constructors
- [new DataStepInterpolation(interpolationType, interpolationMode)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.data.datastepinterpolation.datastepinterpolation.md#new datastepinterpolation(interpolationtype, interpolationmode))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
enabled | boolean | Enabled state |
interpolationmode | InterpolationMode | Interpolation mode |
interpolationtype | InterpolationType | Type of step interpolation |
Constructors
• new DataStepInterpolation(interpolationType?, interpolationMode?)
| Name | Type |
|---|---|
Optional interpolationType | InterpolationType | Options |
Optional interpolationMode | InterpolationMode |
DataInterpolation.constructor
Methods
▸ clone(): DataInterpolation
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ Protected copyConstructor(src, deepCopy?): DataStepInterpolation
Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>
| Name | Type | Description |
|---|---|---|
src | DataStepInterpolation | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
DataInterpolation.copyConstructor
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
DataInterpolation.getClassName
▸ getInterpolationMode(): InterpolationMode
returns interpolation mode
interpolation mode
▸ getInterpolationType(): InterpolationType
returns interpolation type
interpolation type
▸ getProperties(): Required<Options>
Gets all the properties pertaining to this object
Required<Options>
properties object
DataInterpolation.getProperties
▸ 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
DataInterpolation.hasEventListener
▸ interpolate(start, count, input, output): boolean
Interpolate array of samples
| Name | Type | Description |
|---|---|---|
start | number | start index |
count | number | count of samples to interpolate |
input | DataValueArray | input data |
output | DataValueArray | output (interpolated) data |
boolean
true if interpolation is successful
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEnabled(): boolean
returns enable state
boolean
state
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(event, source, args?): DataStepInterpolation
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?): DataStepInterpolation
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): DataStepInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataStepInterpolation, args: EventMap[E]) => void |
▸ on(type, callback, options?): DataStepInterpolation
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| 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?): DataStepInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataStepInterpolation, args: EventMap[E]) => void |
Optional options | Options |
▸ setEnabled(enabled): DataStepInterpolation
set enable state
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets the enabled state |
this
▸ setInterpolationMode(interpolationMode): DataStepInterpolation
Set interpolation mode
| Name | Type | Description |
|---|---|---|
interpolationMode | InterpolationMode | interpolation mode |
this
▸ setInterpolationType(interpolationType): DataStepInterpolation
Set interpolation type
| Name | Type | Description |
|---|---|---|
interpolationType | InterpolationType | interpolation type |
this
▸ setProperties(properties?): DataStepInterpolation
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
DataInterpolation.setProperties
▸ setSilent(bool): DataStepInterpolation
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string