OverlayNumberSettings

Index

Constructors

• constructor

Properties

• color
• defaultFormatX
• defaultFormatY
• font
• fontSize
• formatX
• formatY
• hasCustomColor
• hasCustomFormat
• hasCustomPrecision
• isHidden
• isValidWcs
• isVisible
• precision

Accessors

• formatStringX
• formatStringY
• formatTypeX
• formatTypeY
• isShown
• styleString

Methods

• cursorFormatStringX
• cursorFormatStringY
• setColor
• setCustomColor
• setCustomFormat
• setCustomPrecision
• setDefaultFormatX
• setDefaultFormatY
• setFont
• setFontSize
• setFormatX
• setFormatY
• setHidden
• setPrecision
• setValidWcs
• setVisible

Constructors

constructor

• OverlayNumberSettings(): OverlayNumberSettings

• Returns OverlayNumberSettings

Properties

color

color: string = AST_DEFAULT_COLOR

defaultFormatX

defaultFormatX: NumberFormatType | undefined = NumberFormatType.Degrees

defaultFormatY

defaultFormatY: NumberFormatType | undefined = NumberFormatType.Degrees

font

font: number = 0

fontSize

fontSize: number = 12

formatX

formatX: NumberFormatType = NumberFormatType.Degrees

formatY

formatY: NumberFormatType = NumberFormatType.Degrees

hasCustomColor

hasCustomColor: boolean = false

hasCustomFormat

hasCustomFormat: boolean = false

hasCustomPrecision

hasCustomPrecision: boolean = false

isHidden

isHidden: boolean = false

isValidWcs

isValidWcs: boolean = false

isVisible

isVisible: boolean = true

precision

precision: number = 3

Accessors

formatStringX

• get formatStringX(): string | undefined

• Returns string | undefined

formatStringY

• get formatStringY(): string | undefined

• Returns string | undefined

formatTypeX

• get formatTypeX(): NumberFormatType | undefined

• Returns NumberFormatType | undefined

formatTypeY

• get formatTypeY(): NumberFormatType | undefined

• Returns NumberFormatType | undefined

isShown

• get isShown(): boolean

• Returns boolean

styleString

• get styleString(): string

• Returns string

Methods

cursorFormatStringX

• cursorFormatStringX(precision: number): string | undefined

• Parameters

  • precision: number

  Returns string | undefined

cursorFormatStringY

• cursorFormatStringY(precision: number): string | undefined

• Parameters

  • precision: number

  Returns string | undefined

setColor

• setColor(color: string): void

• Parameters

  • color: string

  Returns void

setCustomColor

• setCustomColor(hasCustomColor: boolean): void

• Parameters

  • hasCustomColor: boolean

  Returns void

setCustomFormat

• setCustomFormat(hasCustomFormat: boolean): void

• Parameters

  • hasCustomFormat: boolean

  Returns void

setCustomPrecision

• setCustomPrecision(hasCustomPrecision: boolean): void

• Parameters

  • hasCustomPrecision: boolean

  Returns void

setDefaultFormatX

• setDefaultFormatX(format: NumberFormatType | undefined): void

• Parameters

  • format: NumberFormatType | undefined

  Returns void

setDefaultFormatY

• setDefaultFormatY(format: NumberFormatType | undefined): void

• Parameters

  • format: NumberFormatType | undefined

  Returns void

setFont

• setFont(font: number): void

• Parameters

  • font: number

  Returns void

setFontSize

• setFontSize(fontSize: number): void

• Parameters

  • fontSize: number

  Returns void

setFormatX

• setFormatX(format: NumberFormatType): void

• Parameters

  • format: NumberFormatType

  Returns void

setFormatY

• setFormatY(format: NumberFormatType): void

• Parameters

  • format: NumberFormatType

  Returns void

setHidden

• setHidden(isHidden: boolean): void

• Parameters

  • isHidden: boolean

  Returns void

setPrecision

• setPrecision(precision: number): void

• Parameters

  • precision: number

  Returns void

setValidWcs

• setValidWcs(isValidWcs: boolean): void

• Parameters

  • isValidWcs: boolean

  Returns void

setVisible

• setVisible(isVisible?: boolean): void

• Parameters

  • isVisible: boolean = true

  Returns void