Skip to content

API / geotoolkit / data / DataGapInterpolation / DataGapInterpolation

Class: DataGapInterpolation

data.DataGapInterpolation.DataGapInterpolation

The DataGapInterpolation interface adds NaN values for a depth in the data greater than to a specified gap size.

Hierarchy

Table of contents

Constructors
  • [new DataGapInterpolation(gap, gapType)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.data.datagapinterpolation.datagapinterpolation.md#new datagapinterpolation(gap, gaptype))
Methods
Css Properties
Name Type Description
enabledbooleanEnabled state
gaptypeDataGapTypeData gap type
gapvaluenumberData gap value

Contents

Constructors

new DataGapInterpolation(gap, gapType)

• new DataGapInterpolation(gap?, gapType?)

Parameters

Name Type Description
Optional gapnumberthe gap value to show discontinuity of the difference between sample is greater than specified value
Optional gapTypeDataGapTypethe type of gap value, default is DataGapType.Index

Overrides

DataInterpolation.constructor

Methods

clone

▸ clone(): DataInterpolation

All subclasses should override copyConstructor or provide custom implementation for this method

Returns

DataInterpolation

clone

Inherited from

DataInterpolation.clone


copyConstructor

▸ Protected copyConstructor(src, deepCopy?): DataGapInterpolation

Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>

Parameters

Name Type Description
srcDataGapInterpolationSource to copy from
Optional deepCopybooleandeep copy

Returns

DataGapInterpolation

this

Overrides

DataInterpolation.copyConstructor


dispose

▸ dispose(): void

Dispose.

Returns

void

Inherited from

DataInterpolation.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName


getGapType

▸ getGapType(): DataGapType

Returns the type of gap value

Returns

DataGapType

The type of gap value


getGapValue

▸ getGapValue(): number

Returns the value of gap

Returns

number

The gap value


getProperties

▸ getProperties(): Required<Options&gt;

Gets all the properties pertaining to this object

Returns

Required<Options&gt;

An object containing the properties to set

Overrides

DataInterpolation.getProperties


hasEventListener

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

DataInterpolation.hasEventListener


interpolate

▸ interpolate(start, count, input, output): boolean

Interpolate array of samples

Throws

when invoked to indicate the method should be overridden.

Parameters

Name Type Description
startnumberThe start index
countnumberThe count of samples to interpolate
inputDataValueArrayThe input data
outputDataValueArrayThe output data

Returns

boolean

true if interpolation is successful

Overrides

DataInterpolation.interpolate


isDisposed

▸ isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

DataInterpolation.isDisposed


isEnabled

▸ isEnabled(): boolean

returns enable state

Returns

boolean

state

Inherited from

DataInterpolation.isEnabled


isSilent

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

DataInterpolation.isSilent


notify

▸ notify<E&gt;(event, source, args?): DataGapInterpolation

Notify listeners of the DataInterpolation

Type parameters

NameType
Eextends string

Parameters

Name Type Description
eventEtype of event
sourceDataInterpolationsource who called the event
Optional argsEventMap[E]event arguments

Returns

DataGapInterpolation

this

Inherited from

DataInterpolation.notify


off

▸ 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.

Parameters

Name Type Description
Optional typestringtype of the event
Optional callbackEventListenerfunction to be called

Returns

DataGapInterpolation

this

Inherited from

DataInterpolation.off

▸ off<E&gt;(type, callback): DataGapInterpolation

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: DataGapInterpolation, args: EventMap[E]) => void

Returns

DataGapInterpolation

Inherited from

DataInterpolation.off


on

▸ on(type, callback, options?): DataGapInterpolation

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>

Parameters

Name Type Description
typestringtype of event or property
callbackEventListenerto be called
Optional optionsOptionsoptions of subscription

Returns

DataGapInterpolation

this

Inherited from

DataInterpolation.on

▸ on<E&gt;(type, callback, options?): DataGapInterpolation

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: DataGapInterpolation, args: EventMap[E]) => void
Optional optionsOptions

Returns

DataGapInterpolation

Inherited from

DataInterpolation.on


setEnabled

▸ setEnabled(enabled): DataGapInterpolation

set enable state

Parameters

Name Type Description
enabledbooleansets the enabled state

Returns

DataGapInterpolation

this

Inherited from

DataInterpolation.setEnabled


setGapType

▸ setGapType(gapType): DataGapInterpolation

Sets the type of gap value

Parameters

Name Type Description
gapTypeDataGapTypetype of gap value

Returns

DataGapInterpolation

this


setGapValue

▸ setGapValue(gap): DataGapInterpolation

Sets the gap value to show discontinuity of the difference between sample is greater than specified value

Parameters

Name Type Description
gapnumbergap value

Returns

DataGapInterpolation

this


setProperties

▸ setProperties(properties?): DataGapInterpolation

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

DataGapInterpolation

Overrides

DataInterpolation.setProperties


setSilent

▸ setSilent(bool): DataGapInterpolation

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

DataGapInterpolation

this

Inherited from

DataInterpolation.setSilent


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName