API / geotoolkit / data / DataGapInterpolation / DataGapInterpolation
data.DataGapInterpolation.DataGapInterpolation
The DataGapInterpolation interface adds NaN values for a depth in the data greater than to a specified gap size.
↳
DataGapInterpolation
Constructors
Methods
Constructors
• new DataGapInterpolation(gap)
| Name | Type |
|---|---|
gap | number |
DataInterpolation.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
DataInterpolation.getClassName
▸ getGapValue(): number
Returns the value of gap
number
The gap value
▸ getProperties(): Record<string, any>
Gets all the properties pertaining to this object
Record<string, any>
object containing properties
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
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?): DataGapInterpolation
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?): DataGapInterpolation
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): DataGapInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataGapInterpolation, args: EventMap[E]) => void |
▸ on(type, callback, options?): DataGapInterpolation
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?): DataGapInterpolation
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DataGapInterpolation, args: EventMap[E]) => void |
Optional options | Options |
▸ setGapValue(gap): DataGapInterpolation
Sets the gap value to show discontinuity of the difference between sample is greater than specified value
| Name | Type | Description |
|---|---|---|
gap | number | gap |
this
▸ setProperties(properties): DataGapInterpolation
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
properties | Record<string, any> | An object containing the properties to set |
this
DataInterpolation.setProperties
▸ setSilent(bool): DataGapInterpolation
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string