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
-
OverlayColorLegendContinuousDomain.constructor(resultId) Arguments: - resultId (
number) – None
Return type: OverlayColorLegendContinuousDomain
- resultId (
Accessors
-
OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar() Specify if the tick mark lines should be drawn on top of the color legend or just on the side of it.
Return type: boolean
-
OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar(drawOnTop) Arguments: - drawOnTop (
boolean) – None
Return type: void
- drawOnTop (
-
OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing() Sets that all tick marks should be evenly distributed in the color legend, despite the uneven size of each level.
The default value is true, which will render a color legend where all the levels have the same size or all the continuous custom tick marks with even spacing.
Return type: boolean
-
OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing(force) Arguments: - force (
boolean) – None
Return type: void
- force (
-
OverlayColorLegendContinuousDomain.lineColor() The color of the border and tick marks
Return type: Color3Like
-
OverlayColorLegendContinuousDomain.lineColor(color) Arguments: - color (
Color3Like) – None
Return type: void
- color (
-
OverlayColorLegendContinuousDomain.showTickMarkLabels() Specifies if the tick mark labels (usually the number values) should be shown together with the tick mark lines.
Return type: boolean
-
OverlayColorLegendContinuousDomain.showTickMarkLabels(show) Arguments: - show (
boolean) – None
Return type: void
- show (
-
OverlayColorLegendContinuousDomain.textColor() The color of the legend text
Return type: Color3Like
-
OverlayColorLegendContinuousDomain.textColor(color) Arguments: - color (
Color3Like) – None
Return type: void
- color (
Methods
clearCustomLabels
-
OverlayColorLegendContinuousDomain.clearCustomLabels() Clear the custom labels
Return type: void
setCustomLabels
-
OverlayColorLegendContinuousDomain.setCustomLabels(labels, relativePositions) Arguments: - labels (
[string]) – None - relativePositions (
[number]) – None
Set custom labels that will be drawn at the given relative position on the color legend
Return type: void - labels (
setTickValues
-
OverlayColorLegendContinuousDomain.setTickValues(values, scalarMapper) Arguments: - values (
ArrayLike) – None - scalarMapper (
ScalarMapperContinuousDomain) – None
Specify custom tick marks to use
setupFromScalarMapper will setup default tick marks. Use this method to override this and use custom tick mark values.
Return type: void - values (
setupFromScalarMapper
-
OverlayColorLegendContinuousDomain.setupFromScalarMapper(scalarMapper) Arguments: - scalarMapper (
ScalarMapperContinuousDomain) – None
Configure the color legend from the given scalar mapper
Return type: void - scalarMapper (