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

cee.OverlayColorLegendContinuousDomain.constructor()
OverlayColorLegendContinuousDomain(resultId: number): OverlayColorLegendContinuousDomain

Parameters

resultId: number

Returns: OverlayColorLegendContinuousDomain

Accessors

cee.OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar()
get drawTickMarksOnTopOfLegendBar(): boolean

Specify if the tick mark lines should be drawn on top of the color legend or just on the side of it.

Returns: boolean

set drawTickMarksOnTopOfLegendBar(drawOnTop: boolean): void

Parameters

drawOnTop: boolean

Returns: void

cee.OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing()
get forceUniformTickMarkSpacing(): boolean

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.

Returns: boolean

set forceUniformTickMarkSpacing(force: boolean): void

Parameters

force: boolean

Returns: void

cee.OverlayColorLegendContinuousDomain.lineColor()
get lineColor(): Color3Like

The color of the border and tick marks

Returns: Color3Like

set lineColor(color: Color3Like): void

Parameters

color: Color3Like

Returns: void

cee.OverlayColorLegendContinuousDomain.showTickMarkLabels()
get showTickMarkLabels(): boolean

Specifies if the tick mark labels (usually the number values) should be shown together with the tick mark lines.

Returns: boolean

set showTickMarkLabels(show: boolean): void

Parameters

show: boolean

Returns: void

cee.OverlayColorLegendContinuousDomain.textColor()
get textColor(): Color3Like

The color of the legend text

Returns: Color3Like

set textColor(color: Color3Like): void

Parameters

color: Color3Like

Returns: void

cee.OverlayColorLegendContinuousDomain.title()
get title(): string

The title of the color legend.

The legend supports multi-line titles. Separate each line with a ‘n’ character

Returns: string

set title(title: string): void

Parameters

title: string

Returns: void

Methods

cee.OverlayColorLegendContinuousDomain.clearCustomLabels()
clearCustomLabels(): void

Clear the custom labels

Returns: void

cee.OverlayColorLegendContinuousDomain.setCustomLabels()
setCustomLabels(labels: string[], relativePositions: number[]): void

Set custom labels that will be drawn at the given relative position on the color legend

Parameters

labels: string[]

relativePositions: number[]

Returns: void

cee.OverlayColorLegendContinuousDomain.setTickValues()
setTickValues(values: ArrayLike, scalarMapper: ScalarMapperContinuousDomain): void

Specify custom tick marks to use

setupFromScalarMapper will setup default tick marks. Use this method to override this and use custom tick mark values.

Parameters

values: ArrayLike

scalarMapper: ScalarMapperContinuousDomain

Returns: void

cee.OverlayColorLegendContinuousDomain.setupFromScalarMapper()
setupFromScalarMapper(scalarMapper: ScalarMapperContinuousDomain): void

Configure the color legend from the given scalar mapper

Parameters

Returns: void