API / geotoolkit / data / DataSample / DataSample
data.DataSample.DataSample
Represent a processed data sample
DataSample
Constructors
| [new DataSample(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.data.datasample.datasample.md#new datasample(options)) | [new DataSample(position, value, level, valid, srcIndex)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.data.datasample.datasample.md#new datasample(position, value, level, valid, srcindex)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
index | number | Source index |
level | number | Level |
position | number | Position |
valid | boolean | Valid or not |
value | number | Value |
Constructors
• new DataSample(options?)
| Name | Type |
|---|---|
Optional options | Options |
• new DataSample(position?, value?, level?, valid?, srcIndex?)
| Name | Type |
|---|---|
Optional position | number |
Optional value | number |
Optional level | number |
Optional valid | boolean |
Optional srcIndex | number |
Methods
▸ clone(): DataSample
Create clone
clone
▸ getClassName(): string
string
▸ getLevel(): number
Return level of the wrap
number
▸ getOriginalIndex(): number
Get original index in the data set
number
▸ getOriginalValue(): number
Returns original value of the sample
number
▸ getPosition(): number
Return position
number
▸ getProperties(): Required<Options>
Gets all the properties pertaining to this object
Required<Options>
An object containing the properties to set
▸ getValid(): boolean
Return sample status
boolean
▸ getValue(): number
Returns value of the sample
number
▸ isNull(): boolean
Check if sample is null
boolean
▸ setLevel(level): DataSample
Sets wrap level
| Name | Type | Description |
|---|---|---|
level | number | level |
this
▸ setOriginalIndex(srcIndex): DataSample
Sets original index
| Name | Type | Description |
|---|---|---|
srcIndex | number | src index |
this
▸ setPosition(position): DataSample
Sets position
| Name | Type | Description |
|---|---|---|
position | number | position |
this
▸ setProperties(properties?): DataSample
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setValid(valid): DataSample
Sets status of the sample
| Name | Type | Description |
|---|---|---|
valid | boolean | valid |
this
▸ setValue(value): DataSample
Sets value of the sample
| Name | Type | Description |
|---|---|---|
value | number | value |
this
▸ Static getClassName(): string
string