Last updated

API / geotoolkit / data / DataLimitsInterpolation / DataLimitsInterpolation

Class: DataLimitsInterpolation

data.DataLimitsInterpolation.DataLimitsInterpolation

This interpolation cuts values lower and upper track limits

Hierarchy

Table of contents

Constructors
[new DataLimitsInterpolation(low, high, interpolationedge)](/solutions/geotoolkit/apis/classes/geotoolkit.data.datalimitsinterpolation.datalimitsinterpolation.md#new datalimitsinterpolation(low, high, interpolationedge))[new DataLimitsInterpolation(options)](/solutions/geotoolkit/apis/classes/geotoolkit.data.datalimitsinterpolation.datalimitsinterpolation.md#new datalimitsinterpolation(options))
Methods
Css Properties
Name Type Description
highnumberHigh limit
interpolationedgeInterpolationEdgeType of edge value interpolation
lownumberLow limit

Contents

Constructors

new DataLimitsInterpolation(low, high, interpolationedge)

new DataLimitsInterpolation(low?, high?, interpolationedge?)

Parameters

Name Type
Optional lownumber
Optional highnumber
Optional interpolationedgestring

Overrides

DataInterpolation.constructor


new DataLimitsInterpolation(options)

new DataLimitsInterpolation(options?)

Parameters

Name Type
Optional optionsOptions

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 as follows: values smaller than track low limit are adjusted to the low limit whereas values greater than track high limit are adjusted to the high limit

Parameters

Name Type Description
startnumberstart index
countnumbercount of samples to interpolate
inputDataValueArrayinput data
outputDataValueArrayoutput data

Returns

boolean

true always

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?): DataLimitsInterpolation

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

DataLimitsInterpolation

this

Inherited from

DataInterpolation.notify


off

off(type?, callback?): DataLimitsInterpolation

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

DataLimitsInterpolation

this

Inherited from

DataInterpolation.off

off<E>(type, callback): DataLimitsInterpolation

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataLimitsInterpolation

Inherited from

DataInterpolation.off


on

on(type, callback, options?): DataLimitsInterpolation

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

DataLimitsInterpolation

this

Inherited from

DataInterpolation.on

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

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataLimitsInterpolation

Inherited from

DataInterpolation.on


setProperties

setProperties(properties?): DataLimitsInterpolation

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

DataLimitsInterpolation

this

Overrides

DataInterpolation.setProperties


setSilent

setSilent(bool): DataLimitsInterpolation

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

DataLimitsInterpolation

this

Inherited from

DataInterpolation.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

DataInterpolation.getClassName