API / geotoolkit / contour / scale / ContourScale / ContourScale
scale.ContourScale.ContourScale
An abstract base class for the contour scale. The contour scale provides the information about sections of an altitude axis.
ContourScale
Constructors
Methods
▸ getClassName(): string
string
▸ Abstract getCount(): number
Gets the total number of intervals within the scale.
number
count The number of the scale intervals
▸ Abstract 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
▸ Abstract 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.
| Name | Type | Description |
|---|---|---|
index | number | Optional Parameter. The contour index for which to find the z-value range. |
range The full range of this scale.
▸ setProperties(properties): ContourScale
Sets the scale properties
| Name | Type | Description |
|---|---|---|
properties | AnyRecord | scale properties |
this
▸ Static getClassName(): string
string