Class Context

constructor

• new Context(figure: Figure): Context

  Parameters

  • figure: Figure

  Returns Context

Readonlyid

ReadonlyinstructionContext

ReadonlyselectorList

active

• get active(): Plot

  Returns Plot

state

• get state(): PlotState

  Returns PlotState

isMultiPanel

• get isMultiPanel(): boolean

  Returns whether this figure has multiple subplots (facets/multi-panel).

  Returns boolean

figureTitle

• get figureTitle(): string

  Returns the figure-level title (the top-level plot title).

  Returns string

figureSubtitle

• get figureSubtitle(): string

  Returns the figure-level subtitle.

  Returns string

figureCaption

• get figureCaption(): string

  Returns the figure-level caption.

  Returns string

scope

• get scope(): Scope

  Returns Scope

dispose

• dispose(): void

  Returns void

setRotorEnabled

• setRotorEnabled(enable: boolean): void

  Enable or disable rotor navigation for the current context.

  Parameters

  • enable: boolean

    true to enable rotor mode, false to disable

  Returns void

isRotorEnabled

• isRotorEnabled(): boolean

  Return whether rotor navigation is currently enabled.

  Returns boolean

  boolean

toggleScope

• toggleScope(scope: Scope): void

  Parameters

  • scope: Scope

  Returns void

isMovable

• isMovable(direction: MovableDirection): boolean

  Parameters

  • direction: MovableDirection

  Returns boolean

moveOnce

• moveOnce(direction: MovableDirection): void

  Parameters

  • direction: MovableDirection

  Returns void

moveToExtreme

• moveToExtreme(direction: MovableDirection): void

  Parameters

  • direction: MovableDirection

  Returns void

moveToIndex

• moveToIndex(row: number, col: number): void

  Parameters

  • row: number
  • col: number

  Returns void

moveToPoint

• moveToPoint(x: number, y: number): void

  Moves the active plot element to the specified (x, y) point.

  Parameters

  • x: number

    The x-coordinate to move to.

  • y: number

    The y-coordinate to move to.

  Returns void

  Remarks

  This method assumes that this.active is a valid object with a moveToPoint method. If this.active is null or does not implement moveToPoint, this method will do nothing.

  Limitations:

  • If this.active is null or undefined, the method will not perform any action.
  • If this.active does not implement moveToPoint, the method will not perform any action.

stepTrace

• stepTrace(direction: MovableDirection): void

  Parameters

  • direction: MovableDirection

  Returns void

enterSubplot

• enterSubplot(): void

  Returns void

exitSubplot

• exitSubplot(): void

  Returns void

enterGridCell

• enterGridCell(): boolean

  Enters grid cell mode to navigate points within the current cell. Only works when the active trace supports grid navigation and is in grid mode.

  Returns boolean

  true if successfully entered cell mode, false if no points in cell

exitGridCell

• exitGridCell(): void

  Exits grid cell mode and returns to grid navigation.

  Returns void

moveCellPointLeft

• moveCellPointLeft(): void

  Moves to the previous point within the current grid cell.

  Returns void

moveCellPointRight

• moveCellPointRight(): void

  Moves to the next point within the current grid cell.

  Returns void

getInstruction

• getInstruction(includeClickPrompt: boolean): string

  Parameters

  • includeClickPrompt: boolean

  Returns string