OverlayStore

Index

Properties

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

Accessors

• base
• colorbarHoverInfoHeight
• cumulativeLabelGap
• defaultGap
• labelWidth
• labelsHidden
• numberWidth
• padding
• paddingBottom
• paddingLeft
• paddingRight
• paddingTop
• previewRenderHeight
• previewRenderWidth
• renderHeight
• renderWidth
• showNumbers
• titleGap
• viewHeight
• viewWidth
• Instance

Methods

• minSize
• setDefaultsFromFrame
• setFormatsFromSystem
• setViewDimension
• setVisible
• styleString
• toggleLabels

Properties

axes

axes: OverlayAxisSettings

beam

beam: OverlayBeamSettings

border

border: OverlayBorderSettings

colorbar

colorbar: OverlayColorbarSettings

fullViewHeight

fullViewHeight: number

fullViewWidth

fullViewWidth: number

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

base

• get base(): number

• Returns number

colorbarHoverInfoHeight

• get colorbarHoverInfoHeight(): number

• Returns number

cumulativeLabelGap

• get cumulativeLabelGap(): number

• Returns number

defaultGap

• get defaultGap(): number

• Returns number

labelWidth

• get labelWidth(): number

• Returns number

labelsHidden

• get labelsHidden(): boolean

• Returns boolean

numberWidth

• get numberWidth(): number

• Returns number

padding

• get padding(): Padding

• Returns Padding

paddingBottom

• get paddingBottom(): number

• Returns number

paddingLeft

• get paddingLeft(): number

• Returns number

paddingRight

• get paddingRight(): number

• Returns number

paddingTop

• get paddingTop(): number

• Returns number

previewRenderHeight

• get previewRenderHeight(): (viewHeight: number) => number

• Returns (viewHeight: number) => number

  • • (viewHeight: number): number

    • Parameters

      • viewHeight: number

      Returns number

previewRenderWidth

• get previewRenderWidth(): (viewWidth: number) => number

• Returns (viewWidth: number) => number

  • • (viewWidth: number): number

    • Parameters

      • viewWidth: number

      Returns number

renderHeight

• get renderHeight(): number

• Returns number

renderWidth

• get renderWidth(): number

• Returns number

showNumbers

• get showNumbers(): boolean

• Returns boolean

titleGap

• get titleGap(): number

• Returns number

viewHeight

• get viewHeight(): number

• Returns number

viewWidth

• get viewWidth(): number

• Returns number

staticInstance

• get Instance(): OverlayStore

• Returns OverlayStore

Methods

minSize

• minSize(frame?: FrameStore): number

• Parameters

  • optionalframe: FrameStore

  Returns number

setDefaultsFromFrame

• setDefaultsFromFrame(frame: FrameStore): void

• Parameters

  • frame: FrameStore

  Returns void

setFormatsFromSystem

• setFormatsFromSystem(): void

• Returns void

setViewDimension

• setViewDimension(width: number, height: number): void

• Parameters

  • width: number

  • height: number

  Returns void

setVisible

• setVisible(visible: boolean): void

• Hide or show the overlay.

  ---

  Parameters

  • visible: boolean

    Visibility of the overlay.

  Returns void

publicstyleString

• styleString(frame?: FrameStore): string

• Parameters

  • optionalframe: FrameStore

  Returns string

toggleLabels

• toggleLabels(): void

• Returns void