Interface ChartGrid

ReadonlyisDestroyed

Readonlyready

Readonlyroot

active

• active(): ChartGridCell

• Returns ChartGridCell

addLinkGroup

• addLinkGroup(
      cell: string,
      options?: { links?: LinkOptions; name?: string },
  ): null | string

• Start a group with this chart in it; the id, or null for an unknown chart or when sixteen groups exist.

  Parameters

  • cell: string
  • Optionaloptions: { links?: LinkOptions; name?: string }

  Returns null | string

applyWorkspace

• applyWorkspace(payload: WorkspacePayload): ChartGridApplyReport

• Replace every chart with a validated payload, or change nothing and say why.

  Parameters

  • payload: WorkspacePayload

  Returns ChartGridApplyReport

cells

• cells(): readonly ChartGridCell[]

• The cells in reading order: by row, then by column.

  Returns readonly ChartGridCell[]

compact

• compact(): boolean

• Whether the grid is narrow enough to show one chart at a time.

  Returns boolean

destroy

• destroy(): void

• Returns void

downloadScreenshot

• downloadScreenshot(filename?: string): boolean

• Save takeScreenshot() as a PNG. False when there is no image or the runtime cannot save it.

  Parameters

  • Optionalfilename: string

  Returns boolean

getWorkspace

• getWorkspace(): WorkspacePayload

• Returns WorkspacePayload

layout

• layout(): ChartGridLayout

• Returns ChartGridLayout

linkGroups

• linkGroups(): readonly ChartGridLinkGroup[]

• Every link group, in the order they were made, with the charts in each.

  Returns readonly ChartGridLinkGroup[]

linkOptions

• linkOptions(): Required<LinkOptions>

• The active chart's link channels (the whole desk's until groups are made); every channel off when it links with none.

  Returns Required<LinkOptions>

maximize

• maximize(id?: string): boolean

• Show one chart alone, the active one by default; the others stay alive. False for an unknown id or a single chart.

  Parameters

  • Optionalid: string

  Returns boolean

maximized

• maximized(): null | string

• The maximized chart's id, or null while the grid shows every chart.

  Returns null | string

on

• on<K extends ChartGridEventName>(
      event: K,
      cb: (payload: ChartGridEvents[K]) => void,
  ): () => void

• Type Parameters

  • K extends ChartGridEventName

  Parameters

  • event: K
  • cb: (payload: ChartGridEvents[K]) => void

  Returns () => void

renameLinkGroup

• renameLinkGroup(group: string, name: string): boolean

• Name a group, 1 to 120 characters after trimming.

  Parameters

  • group: string
  • name: string

  Returns boolean

restore

• restore(): void

• Show every chart again after maximize.

  Returns void

restored

• restored(): null | ChartGridApplyReport

• What restoring the persisted workspace did when the grid was built: null when nothing was stored, and until ready settles over an asynchronous store. A refused desk stays stored, untouched, until the user changes the grid.

  Returns null | ChartGridApplyReport

setActive

• setActive(id: string, options?: { focus?: boolean }): boolean

• Make a cell the one the keyboard and shared controls act on. False for an unknown id.

  Parameters

  • id: string
  • Optionaloptions: { focus?: boolean }

  Returns boolean

setGroupLinks

• setGroupLinks(group: string, patch: LinkOptions): boolean

• Switch channels of one group. False for an unknown group.

  Parameters

  • group: string
  • patch: LinkOptions

  Returns boolean

setLinkGroup

• setLinkGroup(cell: string, group: null | string): boolean

• Move a chart into a group, or out of every group with null. It adopts what the group links on.

  Parameters

  • cell: string
  • group: null | string

  Returns boolean

setLinks

• setLinks(patch: LinkOptions): void

• Switch channels of the active chart's group, or of every group when it is in none. Switching symbol, interval or chart type linking on adopts the active chart's choice.

  Parameters

  • patch: LinkOptions

  Returns void

setPreset

• setPreset(preset: ChartGridLayoutId): void

• Reflow into a layout. The charts that fit keep their state in reading order and new ones copy the active chart's instrument; in an uneven layout the active chart takes the large slot, and stays even when it sat past the charts that fit. Weights reset to the layout's. Throws for an id that is not in CHART_GRID_LAYOUTS.

  Parameters

  • preset: ChartGridLayoutId

  Returns void

setTheme

• setTheme(theme: ChartTheme | WidgetThemeName): void

• Parameters

  • theme: ChartTheme | WidgetThemeName

  Returns void

shareDrawings

• shareDrawings(cell: string): number

• Send a chart's drawings to the charts its group shares drawings with, on the same instrument. Drawings made before the switch went on stay private until shared. The number shared, 0 when there is nowhere to share them.

  Parameters

  • cell: string

  Returns number

swap

• swap(first: string, second: string): boolean

• Trade the places of two charts, spans included. False for an unknown or repeated id.

  Parameters

  • first: string
  • second: string

  Returns boolean

takeScreenshot

• takeScreenshot(): null | HTMLCanvasElement

• One image of every chart at its place on the grid, at the device pixel ratio. Null while the grid shows one chart at a time (compact or maximized), when the hidden charts would come out blank.

  Returns null | HTMLCanvasElement

theme

• theme(): WidgetThemeName

• Returns WidgetThemeName