OverlayColorbarSettings

Index

Constructors

• constructor

Properties

• borderColor
• borderWidth
• color
• hasBorderCustomColor
• hasCustomColor
• hasLabelCustomColor
• hasLabelCustomText
• hasNumberCustomColor
• hasNumberCustomPrecision
• hasTickCustomColor
• isBorderVisible
• isGradientVisible
• isInteractive
• isLabelVisible
• isNumberVisible
• isTickVisible
• isVisible
• labelColor
• labelFont
• labelFontSize
• labelRotation
• numberColor
• numberFont
• numberFontSize
• numberPrecision
• numberRotation
• offset
• position
• tickColor
• tickDensity
• tickLen
• tickWidth
• width

Accessors

• labelWidth
• numberWidth
• rightBorderPos
• stageWidth
• textGap
• totalWidth

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

• OverlayColorbarSettings(): OverlayColorbarSettings

• Returns OverlayColorbarSettings

Properties

borderColor

borderColor: string = AST_DEFAULT_COLOR

borderWidth

borderWidth: number = 1

color

color: string = AST_DEFAULT_COLOR

hasBorderCustomColor

hasBorderCustomColor: boolean = false

hasCustomColor

hasCustomColor: boolean = false

hasLabelCustomColor

hasLabelCustomColor: boolean = false

hasLabelCustomText

hasLabelCustomText: boolean = false

hasNumberCustomColor

hasNumberCustomColor: boolean = false

hasNumberCustomPrecision

hasNumberCustomPrecision: boolean = false

hasTickCustomColor

hasTickCustomColor: boolean = false

isBorderVisible

isBorderVisible: boolean = true

isGradientVisible

isGradientVisible: boolean = true

isInteractive

isInteractive: boolean = PreferenceStore.Instance.isColorbarInteractive

isLabelVisible

isLabelVisible: boolean = PreferenceStore.Instance.isColorbarLabelVisible

isNumberVisible

isNumberVisible: boolean = true

isTickVisible

isTickVisible: boolean = true

isVisible

isVisible: boolean = PreferenceStore.Instance.isColorbarVisible

labelColor

labelColor: string = AST_DEFAULT_COLOR

labelFont

labelFont: number = 0

labelFontSize

labelFontSize: number = 15

labelRotation

labelRotation: number = -90

numberColor

numberColor: string = AST_DEFAULT_COLOR

numberFont

numberFont: number = 0

numberFontSize

numberFontSize: number = 12

numberPrecision

numberPrecision: number = 3

numberRotation

numberRotation: number = -90

offset

offset: number = 5

position

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

tickColor

tickColor: string = AST_DEFAULT_COLOR

tickDensity

tickDensity: number = PreferenceStore.Instance.colorbarTicksDensity

tickLen

tickLen: number = 6

tickWidth

tickWidth: number = 1

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(hasBorderCustomColor: boolean): void

• Parameters

  • hasBorderCustomColor: boolean

  Returns void

setBorderVisible

• setBorderVisible(isBorderVisible: boolean): void

• Parameters

  • isBorderVisible: 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(hasCustomColor: boolean): void

• Parameters

  • hasCustomColor: boolean

  Returns void

setGradientVisible

• setGradientVisible(isGradientVisible: boolean): void

• Parameters

  • isGradientVisible: boolean

  Returns void

setInteractive

• setInteractive(isInteractive: boolean): void

• Parameters

  • isInteractive: boolean

  Returns void

setLabelColor

• setLabelColor(color: string): void

• Parameters

  • color: string

  Returns void

setLabelCustomColor

• setLabelCustomColor(hasLabelCustomColor: boolean): void

• Parameters

  • hasLabelCustomColor: boolean

  Returns void

setLabelCustomText

• setLabelCustomText(hasLabelCustomText: boolean): void

• Parameters

  • hasLabelCustomText: 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(isLabelVisible: boolean): void

• Parameters

  • isLabelVisible: boolean

  Returns void

setNumberColor

• setNumberColor(color: string): void

• Parameters

  • color: string

  Returns void

setNumberCustomColor

• setNumberCustomColor(hasNumberCustomColor: boolean): void

• Parameters

  • hasNumberCustomColor: boolean

  Returns void

setNumberCustomPrecision

• setNumberCustomPrecision(hasNumberCustomPrecision: boolean): void

• Parameters

  • hasNumberCustomPrecision: 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(isNumberVisible: boolean): void

• Parameters

  • isNumberVisible: 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(hasTickCustomColor: boolean): void

• Parameters

  • hasTickCustomColor: 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(isTickVisible: boolean): void

• Parameters

  • isTickVisible: boolean

  Returns void

setTickWidth

• setTickWidth(width: number): void

• Parameters

  • width: number

  Returns void

setVisible

• setVisible(isVisible: boolean): void

• Parameters

  • isVisible: boolean

  Returns void

setWidth

• setWidth(width: number): void

• Parameters

  • width: number

  Returns void