OverlayColorbarSettings

Index

Constructors

• constructor

Properties

• borderColor
• borderCustomColor
• borderVisible
• borderWidth
• color
• customColor
• gradientVisible
• interactive
• labelColor
• labelCustomColor
• labelCustomText
• labelFont
• labelFontSize
• labelRotation
• labelVisible
• numberColor
• numberCustomColor
• numberCustomPrecision
• numberFont
• numberFontSize
• numberPrecision
• numberRotation
• numberVisible
• offset
• position
• tickColor
• tickCustomColor
• tickDensity
• tickLen
• tickVisible
• tickWidth
• visible
• width

Accessors

• height
• labelWidth
• numberWidth
• rightBorderPos
• stageWidth
• textGap
• tickNum
• totalWidth
• yOffset

Methods

• setBorderColor
• setBorderCustomColor
• setBorderVisible
• setBorderWidth
• setColor
• setCustomColor
• setGradientVisible
• setInteractive
• setLabelColor
• setLabelCustomColor
• setLabelCustomText
• setLabelFont
• setLabelFontSize
• setLabelRotation
• setLabelVisible
• setNumberColor
• setNumberCustomColor
• setNumberCustomPrecision
• setNumberFont
• setNumberFontSize
• setNumberPrecision
• setNumberRotation
• setNumberVisible
• setOffset
• setPosition
• setTickColor
• setTickCustomColor
• setTickDensity
• setTickLen
• setTickVisible
• setTickWidth
• setVisible
• setWidth

Constructors

constructor

• new OverlayColorbarSettings(): OverlayColorbarSettings

• Returns OverlayColorbarSettings

Properties

borderColor

borderColor: string

borderCustomColor

borderCustomColor: boolean

borderVisible

borderVisible: boolean

borderWidth

borderWidth: number

color

color: string

customColor

customColor: boolean

gradientVisible

gradientVisible: boolean

interactive

interactive: boolean

labelColor

labelColor: string

labelCustomColor

labelCustomColor: boolean

labelCustomText

labelCustomText: boolean

labelFont

labelFont: number

labelFontSize

labelFontSize: number

labelRotation

labelRotation: number

labelVisible

labelVisible: boolean

numberColor

numberColor: string

numberCustomColor

numberCustomColor: boolean

numberCustomPrecision

numberCustomPrecision: boolean

numberFont

numberFont: number

numberFontSize

numberFontSize: number

numberPrecision

numberPrecision: number

numberRotation

numberRotation: number

numberVisible

numberVisible: boolean

offset

offset: number

position

position: string

tickColor

tickColor: string

tickCustomColor

tickCustomColor: boolean

tickDensity

tickDensity: number

tickLen

tickLen: number

tickVisible

tickVisible: boolean

tickWidth

tickWidth: number

visible

visible: boolean

width

width: number

Accessors

height

• get height(): (frame?: FrameStore) => number

• Returns (frame?: FrameStore) => number

  • • (frame?: FrameStore): number

    • Parameters

      • optionalframe: FrameStore

      Returns number

labelWidth

• get labelWidth(): number

• Returns number

numberWidth

• get numberWidth(): number

• Returns number

rightBorderPos

• get rightBorderPos(): number

• Returns number

stageWidth

• get stageWidth(): number

• Returns number

textGap

• get textGap(): number

• Returns number

tickNum

• get tickNum(): (frame?: FrameStore) => number

• Returns (frame?: FrameStore) => number

  • • (frame?: FrameStore): number

    • Parameters

      • optionalframe: FrameStore

      Returns number

totalWidth

• get totalWidth(): number

• Returns number

yOffset

• get yOffset(): number

• Returns number

Methods

setBorderColor

• setBorderColor(color: string): void

• Parameters

  • color: string

  Returns void

setBorderCustomColor

• setBorderCustomColor(customColor: boolean): void

• Parameters

  • customColor: boolean

  Returns void

setBorderVisible

• setBorderVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setBorderWidth

• setBorderWidth(width: number): void

• Parameters

  • width: number

  Returns void

setColor

• setColor(color: string): void

• Parameters

  • color: string

  Returns void

setCustomColor

• setCustomColor(customColor: boolean): void

• Parameters

  • customColor: boolean

  Returns void

setGradientVisible

• setGradientVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setInteractive

• setInteractive(interactive: boolean): void

• Parameters

  • interactive: boolean

  Returns void

setLabelColor

• setLabelColor(color: string): void

• Parameters

  • color: string

  Returns void

setLabelCustomColor

• setLabelCustomColor(customColor: boolean): void

• Parameters

  • customColor: boolean

  Returns void

setLabelCustomText

• setLabelCustomText(customText: boolean): void

• Parameters

  • customText: boolean

  Returns void

setLabelFont

• setLabelFont(font: number): void

• Parameters

  • font: number

  Returns void

setLabelFontSize

• setLabelFontSize(fontSize: number): void

• Parameters

  • fontSize: number

  Returns void

setLabelRotation

• setLabelRotation(rotation: number): void

• Parameters

  • rotation: number

  Returns void

setLabelVisible

• setLabelVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setNumberColor

• setNumberColor(color: string): void

• Parameters

  • color: string

  Returns void

setNumberCustomColor

• setNumberCustomColor(customColor: boolean): void

• Parameters

  • customColor: boolean

  Returns void

setNumberCustomPrecision

• setNumberCustomPrecision(customPrecision: boolean): void

• Parameters

  • customPrecision: boolean

  Returns void

setNumberFont

• setNumberFont(font: number): void

• Parameters

  • font: number

  Returns void

setNumberFontSize

• setNumberFontSize(fontSize: number): void

• Parameters

  • fontSize: number

  Returns void

setNumberPrecision

• setNumberPrecision(precision: number): void

• Parameters

  • precision: number

  Returns void

setNumberRotation

• setNumberRotation(rotation: number): void

• Parameters

  • rotation: number

  Returns void

setNumberVisible

• setNumberVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setOffset

• setOffset(offset: number): void

• Parameters

  • offset: number

  Returns void

setPosition

• setPosition(position: string): void

• Parameters

  • position: string

  Returns void

setTickColor

• setTickColor(color: string): void

• Parameters

  • color: string

  Returns void

setTickCustomColor

• setTickCustomColor(customColor: boolean): void

• Parameters

  • customColor: boolean

  Returns void

setTickDensity

• setTickDensity(density: number): void

• Parameters

  • density: number

  Returns void

setTickLen

• setTickLen(len: number): void

• Parameters

  • len: number

  Returns void

setTickVisible

• setTickVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setTickWidth

• setTickWidth(width: number): void

• Parameters

  • width: number

  Returns void

setVisible

• setVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setWidth

• setWidth(width: number): void

• Parameters

  • width: number

  Returns void