OverlayColorLegendContinuousDomain
- class cee.OverlayColorLegendContinuousDomain()
Color legend for all continuous domain scalar mappers.
The OverlayColorLegendContinuousDomain is capable of visualizing all scalar mappers that derives from the ScalarMapperContinuousDomain.
Constructors
Accessors
Constructors
constructor
- cee.OverlayColorLegendContinuousDomain.constructor(resultId)
- Arguments
resultId (
number
) –
- Return type
cee.OverlayColorLegendContinuousDomain
Accessors
- cee.OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar
Specify if the tick mark lines should be drawn on top of the color legend or just on the side of it.
- cee.OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing
- cee.OverlayColorLegendContinuousDomain.lineColor
The color of the border and tick marks
- cee.OverlayColorLegendContinuousDomain.showTickMarkLabels
Specifies if the tick mark labels (usually the number values) should be shown together with the tick mark lines.
- cee.OverlayColorLegendContinuousDomain.textColor
The color of the legend text
- cee.OverlayColorLegendContinuousDomain.title
The title of the color legend.
The legend supports multi-line titles. Separate each line with a ‘\n’ character
Methods
clearCustomLabels
- cee.OverlayColorLegendContinuousDomain.clearCustomLabels()
Clear the custom labels
- Return type
void
setCustomLabels
- cee.OverlayColorLegendContinuousDomain.setCustomLabels(labels, relativePositions)
Set custom labels that will be drawn at the given relative position on the color legend
- Arguments
labels (
[string]
) –relativePositions (
[number]
) –
- Return type
void
setTickValues
- cee.OverlayColorLegendContinuousDomain.setTickValues(values, scalarMapper)
Specify custom tick marks to use
- Arguments
values (
ArrayLike[number]
) –scalarMapper (
cee.ScalarMapperContinuousDomain
) –
- Return type
void
setupFromScalarMapper will setup default tick marks. Use this method to override this and use custom tick mark values.
setupFromScalarMapper
- cee.OverlayColorLegendContinuousDomain.setupFromScalarMapper(scalarMapper)
Configure the color legend from the given scalar mapper
- Arguments
scalarMapper (
cee.ScalarMapperContinuousDomain
) –
- Return type
void