Last updated

API / geotoolkit / data / DataValueArray / DataValueArray

Class: DataValueArray

data.DataValueArray.DataValueArray

Defines two arrays depths and values of samples

Table of contents

Constructors
[new DataValueArray(options)](/solutions/geotoolkit/apis/classes/geotoolkit.data.datavaluearray.datavaluearray.md#new datavaluearray(options))[new DataValueArray(samples)](/solutions/geotoolkit/apis/classes/geotoolkit.data.datavaluearray.datavaluearray.md#new datavaluearray(samples))
Methods
Css Properties
Name Type Description
maxwraplevelnumberMax wrap level
minwraplevelnumberMin wrap level

Contents

Constructors

new DataValueArray(options)

new DataValueArray(options?)

Parameters

Name Type
Optional optionsOptions

new DataValueArray(samples)

new DataValueArray(samples?)

Parameters

Name Type
Optional samplesDataSample[]
Methods

clone

clone(): DataValueArray

Create a deep copy

Returns

DataValueArray

clone


getClassName

getClassName(): string

Returns

string


getMaxWrapLevel

getMaxWrapLevel(): number

Return maximum wrap level. By default, it is 0

Returns

number


getMinWrapLevel

getMinWrapLevel(): number

Return minimum wrap level. By default, it is 0

Returns

number


getProperties

getProperties(): Required<Options>

Gets all the properties pertaining to this object

Returns

Required<Options>

properties object


getSamples

getSamples(): DataSample[]

Gets samples array

Returns

DataSample[]


setMaxWrapLevel

setMaxWrapLevel(maxWrapLevel): DataValueArray

Sets a maximal wrap level

Parameters

Name Type Description
maxWrapLevelnumberthe maximal wrap level

Returns

DataValueArray


setMinWrapLevel

setMinWrapLevel(minWrapLevel): DataValueArray

Sets a minimal wrap level

Parameters

Name Type Description
minWrapLevelnumberthe minimal wrap level

Returns

DataValueArray


setProperties

setProperties(properties?): DataValueArray

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

DataValueArray


setSamples

setSamples(samples): DataValueArray

Sets samples array

Parameters

Name Type Description
samplesDataSample[]the samples array

Returns

DataValueArray


getClassName

Static getClassName(): string

Returns

string