OverlaySettings

Index

Properties

• axes
• beam
• border
• colorbar
• defaultGap
• global
• grid
• labels
• numbers
• ticks
• title
• visible

Accessors

• colorbarHoverInfoHeight
• cumulativeLabelGap
• isImgCoordinates
• isWcsCoordinates
• labelWidth
• labelsHidden
• numberWidth
• paddingBottom
• paddingLeft
• paddingRight
• paddingTop
• showNumbers
• titleGap
• Instance

Methods

• setDefaultsFromFrame
• setFormatsFromSystem
• setVisible
• toggleLabels

Properties

axes

axes: OverlayAxisSettings

beam

beam: OverlayBeamSettings

border

border: OverlayBorderSettings

colorbar

colorbar: OverlayColorbarSettings

defaultGap

defaultGap: number = 5

global

global: OverlayGlobalSettings

grid

grid: OverlayGridSettings

labels

labels: OverlayLabelSettings

numbers

numbers: OverlayNumberSettings

ticks

ticks: OverlayTickSettings

title

title: OverlayTitleSettings

visible

visible: boolean = true

Visibility of the overlay.

Accessors

colorbarHoverInfoHeight

• get colorbarHoverInfoHeight(): number

• Returns number

cumulativeLabelGap

• get cumulativeLabelGap(): number

• Returns number

isImgCoordinates

• get isImgCoordinates(): boolean

• Returns boolean

isWcsCoordinates

• get isWcsCoordinates(): boolean

• Returns boolean

labelWidth

• get labelWidth(): number

• Returns number

labelsHidden

• get labelsHidden(): boolean

• Returns boolean

numberWidth

• get numberWidth(): number

• Returns number

paddingBottom

• get paddingBottom(): number

• The usual bottom padding in single/multi-panel mode.

  ---

  Returns number

paddingLeft

• get paddingLeft(): number

• The usual left padding in single/multi-panel mode.

  ---

  Returns number

paddingRight

• get paddingRight(): number

• The usual right padding in single/multi-panel mode.

  ---

  Returns number

paddingTop

• get paddingTop(): number

• The usual top padding in single/multi-panel mode.

  ---

  Returns number

showNumbers

• get showNumbers(): boolean

• Returns boolean

titleGap

• get titleGap(): number

• Returns number

staticInstance

• get Instance(): OverlaySettings

• Returns OverlaySettings

Methods

setDefaultsFromFrame

• setDefaultsFromFrame(frame: FrameStore): void

• Parameters

  • frame: FrameStore

  Returns void

setFormatsFromSystem

• setFormatsFromSystem(): void

• Returns void

setVisible

• setVisible(visible: boolean): void

• Hide or show the overlay.

  ---

  Parameters

  • visible: boolean

    Visibility of the overlay.

  Returns void

toggleLabels

• toggleLabels(): void

• Returns void