Last updated

API / geotoolkit / data / DataGapFillInterpolation / DataGapFillInterpolation

Class: DataGapFillInterpolation

data.DataGapFillInterpolation.DataGapFillInterpolation

The DataGapFillInterpolation interface removes NaN values that form a gap in the data less than or equal to a specified size.

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new DataGapFillInterpolation(cutoff)

new DataGapFillInterpolation(cutoff)

Parameters

Name Type
cutoffnumber

Overrides

DataInterpolation.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

DataInterpolation.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName


getGapFillCutoff

getGapFillCutoff(): number

Returns the value of the cutoff used for removing NaN valued samples

Returns

number

The cutoff value


getGapFillCutoffMode

getGapFillCutoffMode(): CutoffMode

Return keep samples flag

Returns

CutoffMode


getProperties

getProperties(): Record<string, any>

Gets all the properties pertaining to this object

Returns

Record<string, any>

object containing properties

Inherited from

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


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

DataInterpolation.isSilent


notify

notify<E>(event, source, args?): DataGapFillInterpolation

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

DataGapFillInterpolation

this

Inherited from

DataInterpolation.notify


off

off(type?, callback?): DataGapFillInterpolation

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

DataGapFillInterpolation

this

Inherited from

DataInterpolation.off

off<E>(type, callback): DataGapFillInterpolation

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataGapFillInterpolation

Inherited from

DataInterpolation.off


on

on(type, callback, options?): DataGapFillInterpolation

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.

Parameters

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

Returns

DataGapFillInterpolation

this

Inherited from

DataInterpolation.on

on<E>(type, callback, options?): DataGapFillInterpolation

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataGapFillInterpolation

Inherited from

DataInterpolation.on


setGapFillCutoff

setGapFillCutoff(cutoff): DataGapFillInterpolation

Sets the cutoff used for removing NaN valued samples.

Parameters

Name Type Description
cutoffnumbergap fill cutoff

Returns

DataGapFillInterpolation

this


setGapFillCutoffMode

setGapFillCutoffMode(cutoffMode): DataGapFillInterpolation

Set keep NaN samples flag

Parameters

Name Type Description
cutoffModeCutoffModecutooff mode

Returns

DataGapFillInterpolation


setProperties

setProperties(properties): DataGapFillInterpolation

Sets all the properties pertaining to this object

Parameters

Name Type Description
propertiesRecord<string, any>An object containing the properties to set

Returns

DataGapFillInterpolation

this

Inherited from

DataInterpolation.setProperties


setSilent

setSilent(bool): DataGapFillInterpolation

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

DataGapFillInterpolation

this

Inherited from

DataInterpolation.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName