Skip to main content
Version: Next

OverlayColorbarSettings

Index

Constructors

constructor

Properties

borderColor

borderColor: string = AST_DEFAULT_COLOR

borderCustomColor

borderCustomColor: boolean = false

borderVisible

borderVisible: boolean = true

borderWidth

borderWidth: number = 1

color

color: string = AST_DEFAULT_COLOR

customColor

customColor: boolean = false

gradientVisible

gradientVisible: boolean = true

interactive

interactive: boolean = PreferenceStore.Instance.colorbarInteractive

labelColor

labelColor: string = AST_DEFAULT_COLOR

labelCustomColor

labelCustomColor: boolean = false

labelCustomText

labelCustomText: boolean = false

labelFont

labelFont: number = 0

labelFontSize

labelFontSize: number = 15

labelRotation

labelRotation: number = -90

labelVisible

labelVisible: boolean = PreferenceStore.Instance.colorbarLabelVisible

numberColor

numberColor: string = AST_DEFAULT_COLOR

numberCustomColor

numberCustomColor: boolean = false

numberCustomPrecision

numberCustomPrecision: boolean = false

numberFont

numberFont: number = 0

numberFontSize

numberFontSize: number = 12

numberPrecision

numberPrecision: number = 3

numberRotation

numberRotation: number = -90

numberVisible

numberVisible: boolean = true

offset

offset: number = 5

position

position: right | top | bottom = PreferenceStore.Instance.colorbarPosition

tickColor

tickColor: string = AST_DEFAULT_COLOR

tickCustomColor

tickCustomColor: boolean = false

tickDensity

tickDensity: number = PreferenceStore.Instance.colorbarTicksDensity

tickLen

tickLen: number = 6

tickVisible

tickVisible: boolean = true

tickWidth

tickWidth: number = 1

visible

visible: boolean = PreferenceStore.Instance.colorbarVisible

width

width: number = PreferenceStore.Instance.colorbarWidth

Accessors

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

totalWidth

  • get totalWidth(): 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: right | top | bottom): void
  • Parameters

    • position: right | top | bottom

    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