API / geotoolkit / contour / scale / RegularContourScale / RegularContourScale
scale.RegularContourScale.RegularContourScale
Implements the ContourScale interface for a regular contour scale. I.e. all contour values are evenly spaced. Note: The step and count parameters must be positive or an exception will be thrown.
↳
RegularContourScale
Constructors
| [new RegularContourScale(range, numberOfLevels)](/solutions/geotoolkit/apis/classes/geotoolkit.contour.scale.regularcontourscale.regularcontourscale.md#new regularcontourscale(range, numberoflevels)) | [new RegularContourScale(zero, step, count)](/solutions/geotoolkit/apis/classes/geotoolkit.contour.scale.regularcontourscale.regularcontourscale.md#new regularcontourscale(zero, step, count)) |
|---|
Constructors
• new RegularContourScale(range, numberOfLevels)
| Name | Type |
|---|---|
range | Range |
numberOfLevels | number |
ContourScale.constructor
• new RegularContourScale(zero, step, count?)
| Name | Type | Description |
|---|---|---|
zero | number | The first (lowest) contour value |
step | number | The interval between successive contours |
Optional count | number | The total number of contour isolines (intervals = count+1) |
ContourScale.constructor
Methods
▸ getClassName(): string
string
▸ getCount(): number
The number of intervals in this scale (=#values + 1: intervals to +/- infinity are included
number
size The number of intervals in this scale
▸ getIndex(zValue): number
Finds the contour index representing the supplied z-value.
| Name | Type | Description |
|---|---|---|
zValue | number | z-value for which contour index has to be found |
number
index The contour index to which the z value belongs
▸ getProperties(): AnyRecord
Gets the scale properties
properties Scale properties
▸ getRange(index?): Range
Returns the full range of values in the contour scale if called with no argument or returns the range of values represented by the supplied contour index.
Throws
if index argument less than zero or greater than array length
| Name | Type | Description |
|---|---|---|
Optional index | number | The contour index for which to find the z-value range. |
range The full range of this scale.
▸ setProperties(properties): RegularContourScale
Sets the scale properties
| Name | Type | Description |
|---|---|---|
properties | AnyRecord | scale properties |
this
▸ Static getClassName(): string
string