API / geotoolkit / contour / scale / ContourRangeScale / ContourRangeScale
scale.ContourRangeScale.ContourRangeScale
Extends RegularContourScale, adds the ability to show a single additional user specified level
↳
ContourRangeScale
Constructors
| [new ContourRangeScale(range, step, showSingleLevel, singleLevelValue)](/solutions/geotoolkit/apis/classes/geotoolkit.contour.scale.contourrangescale.contourrangescale.md#new contourrangescale(range, step, showsinglelevel, singlelevelvalue)) | [new ContourRangeScale(scale)](/solutions/geotoolkit/apis/classes/geotoolkit.contour.scale.contourrangescale.contourrangescale.md#new contourrangescale(scale)) |
|---|
Methods
Constructors
• new ContourRangeScale(range, step?, showSingleLevel?, singleLevelValue?)
| Name | Type | Description |
|---|---|---|
range | Range | The data range or another scale. |
Optional step | number | The data range step. |
Optional showSingleLevel | boolean | Whether the single level should be shown. |
Optional singleLevelValue | number | The value of the single level. |
RegularContourScale.constructor
• new ContourRangeScale(scale)
| Name | Type |
|---|---|
scale | ContourRangeScale |
RegularContourScale.constructor
Methods
▸ getArray(): number[]
Gets the scale array.
number[]
scaleArray The scale array
▸ getClassName(): string
string
RegularContourScale.getClassName
▸ getCount(): number
Gets the total number of intervals within the scale.
number
size Size of the scale (#intervals)
▸ 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
RegularContourScale.getProperties
▸ 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 out of range
| Name | Type | Description |
|---|---|---|
Optional index | number | Optional Parameter. The contour index for which to find the z-value range. |
range The full range of this scale.
▸ getSeparateSingleLevel(): boolean
Gets the flag indicating whether to separate the single level.
boolean
separateSingleLevel The flag indicating single level separation.
▸ getSeparateSingleLevelFactor(): number
Gets the factor which is used to calculate if single level will be separate
number
▸ getShowSingleLevel(): boolean
Gets the flag for the single label visibility
boolean
showSingleLevel The flag indicating single level visibility.
▸ getSingleLevelIndex(): number
Gets the single level index.
number
singleLevelIndex The index position of the single index.
▸ getSingleLevelValue(): number
Gets the single level value.
number
singleLevelValue The value of the single index.
▸ getStep(): number
Gets the step value.
number
step The step value.
▸ setProperties(properties): ContourRangeScale
Sets the scale properties
| Name | Type | Description |
|---|---|---|
properties | AnyRecord | scale properties |
this
RegularContourScale.setProperties
▸ setSeparateSingleLevelFactor(factor): ContourRangeScale
Sets the factor which is used to calculate if single level will be separate
| Name | Type | Description |
|---|---|---|
factor | number | factor |
▸ Static getClassName(): string
string