Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OverlayColorLegendContinuousDomain

Color legend for all continuous domain scalar mappers.

The OverlayColorLegendContinuousDomain is capable of visualizing all scalar mappers that derives from the ScalarMapperContinuousDomain.

Hierarchy

  • OverlayColorLegendContinuousDomain

Index

Constructors

constructor

Accessors

drawTickMarksOnTopOfLegendBar

drawTickMarksOnTopOfLegendBar: boolean

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

fontSizePixels

fontSizePixels: number

The font size in pixels

forceUniformTickMarkSpacing

forceUniformTickMarkSpacing: boolean

legendBarWidth

legendBarWidth: number

The legend bar width in pixels

lineColor

lineColor: Color3Like

The color of the border and tick marks

showTickMarkLabels

showTickMarkLabels: boolean

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

textColor

textColor: Color3Like

The color of the legend text

title

title: string

The title of the color legend.

The legend supports multi-line titles. Separate each line with a '\n' character

Methods

clearCustomLabels

  • clearCustomLabels(): void
  • Clear the custom labels

    Returns void

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

setTickValues

  • 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

    Returns void

setupFromScalarMapper

Generated using TypeDoc