Last updated

API / geotoolkit / data / DataStepInterpolation / DataStepInterpolation

Class: DataStepInterpolation

data.DataStepInterpolation.DataStepInterpolation

Provides step-like interpolation for well log data. It provides zigzag-type interpolation with alternate horizontal and vertical lines.

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
interpolationtypeInterpolationTypeType of step interpolation

Contents

Constructors

new DataStepInterpolation(interpolationType)

new DataStepInterpolation(interpolationType?)

Parameters

Name Type
Optional interpolationTypeInterpolationType | Options

Overrides

DataInterpolation.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

DataInterpolation.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName


getProperties

getProperties(): Required<Options>

Gets all the properties pertaining to this object

Returns

Required<Options>

properties object

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

Parameters

Name Type Description
startnumberstart index
countnumbercount of samples to interpolate
inputDataValueArrayinput data
outputDataValueArrayoutput (interpolated) 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?): DataStepInterpolation

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

DataStepInterpolation

this

Inherited from

DataInterpolation.notify


off

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.

Parameters

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

Returns

DataStepInterpolation

this

Inherited from

DataInterpolation.off

off<E>(type, callback): DataStepInterpolation

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataStepInterpolation

Inherited from

DataInterpolation.off


on

on(type, callback, options?): DataStepInterpolation

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

DataStepInterpolation

this

Inherited from

DataInterpolation.on

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

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataStepInterpolation

Inherited from

DataInterpolation.on


setProperties

setProperties(properties?): DataStepInterpolation

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

DataStepInterpolation

Overrides

DataInterpolation.setProperties


setSilent

setSilent(bool): DataStepInterpolation

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

DataStepInterpolation

this

Inherited from

DataInterpolation.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName