Class Figure

Represents a figure containing one or more subplots

Hierarchy (View Summary)

AbstractPlot<FigureState>
- Figure

Implements

Constructors

constructor

new Figure(maidr: Maidr): Figure
Creates a new Figure instance from MAIDR data
Parameters
- maidr: Maidr
  The MAIDR data containing figure information and subplots
Returns Figure
Overrides AbstractPlot.constructor
- Defined in src/model/plot.ts:44

Properties

`Protected` `Readonly`observers

observers: Observer<FigureState>[]

`Readonly`id

id: string

`Protected` `Readonly`movable

movable: Movable

`Readonly`subplots

subplots: Subplot[][]

Accessors

isInitialEntry

get isInitialEntry(): boolean
Returns boolean
Implementation of Movable.isInitialEntry
Inherited from AbstractPlot.isInitialEntry
- Defined in src/model/abstract.ts:42
set isInitialEntry(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of Movable.isInitialEntry
Inherited from AbstractPlot.isInitialEntry
- Defined in src/model/abstract.ts:46

isOutOfBounds

get isOutOfBounds(): boolean
Returns boolean
Implementation of Movable.isOutOfBounds
Inherited from AbstractPlot.isOutOfBounds
- Defined in src/model/abstract.ts:50
set isOutOfBounds(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of Movable.isOutOfBounds
Inherited from AbstractPlot.isOutOfBounds
- Defined in src/model/abstract.ts:54

row

get row(): number
Returns number
Implementation of Movable.row
Inherited from AbstractPlot.row
- Defined in src/model/abstract.ts:58
set row(value: number): void
Parameters
- value: number
Returns void
Implementation of Movable.row
Inherited from AbstractPlot.row
- Defined in src/model/abstract.ts:66

col

get col(): number
Returns number
Implementation of Movable.col
Inherited from AbstractPlot.col
- Defined in src/model/abstract.ts:62
set col(value: number): void
Parameters
- value: number
Returns void
Implementation of Movable.col
Inherited from AbstractPlot.col
- Defined in src/model/abstract.ts:70

`Protected`dimension

get dimension(): Dimension
Returns Dimension
Overrides AbstractPlot.dimension
- Defined in src/model/plot.ts:23

`Protected`values

get values(): Subplot[][]
Gets the 2D array of subplots

Returns Subplot[][]
The subplots array
- Defined in src/model/plot.ts:75

activeSubplot

get activeSubplot(): Subplot
Gets the currently active subplot based on row and column position

Returns Subplot
The active subplot
- Defined in src/model/plot.ts:83

state

get state(): FigureState
Gets the current state of the figure including active subplot

Returns FigureState
The complete figure state
Implementation of Observable.state
Overrides AbstractPlot.state
- Defined in src/model/plot.ts:91

`Protected`highlight

get highlight(): HighlightState
Returns HighlightState
- Defined in src/model/plot.ts:120

`Protected`outOfBoundsState

get outOfBoundsState(): FigureState
Returns FigureState
Overrides AbstractPlot.outOfBoundsState
- Defined in src/model/plot.ts:193

Methods

`Protected`getSafeIndices

getSafeIndices(): { row: number; col: number }
Gets safe row and column indices to prevent accessing undefined values

Returns { row: number; col: number }
Object with safe row and column indices
Inherited from AbstractPlot.getSafeIndices
- Defined in src/model/abstract.ts:78

addObserver

addObserver(observer: Observer<FigureState>): void
Registers an observer to receive state updates.
Parameters
- observer: Observer<FigureState>
  The observer to add
Returns void
Implementation of Observable.addObserver
Inherited from AbstractPlot.addObserver
- Defined in src/model/abstract.ts:89

removeObserver

removeObserver(observer: Observer<FigureState>): void
Removes an observer from receiving state updates.
Parameters
- observer: Observer<FigureState>
  The observer to remove
Returns void
Implementation of Observable.removeObserver
Inherited from AbstractPlot.removeObserver
- Defined in src/model/abstract.ts:97

notifyStateUpdate

notifyStateUpdate(): void
Notifies all registered observers with the current state.

Returns void
Implementation of Observable.notifyStateUpdate
Inherited from AbstractPlot.notifyStateUpdate
- Defined in src/model/abstract.ts:107

notifyOutOfBounds

notifyOutOfBounds(): void
Notifies observers that an out-of-bounds condition occurred.

Returns void
Inherited from AbstractPlot.notifyOutOfBounds
- Defined in src/model/abstract.ts:115

moveOnce

moveOnce(direction: MovableDirection): boolean
Parameters
- direction: MovableDirection
Returns boolean
Implementation of Movable.moveOnce
Inherited from AbstractPlot.moveOnce
- Defined in src/model/abstract.ts:120

moveToExtreme

moveToExtreme(direction: MovableDirection): boolean
Parameters
- direction: MovableDirection
Returns boolean
Implementation of Movable.moveToExtreme
Inherited from AbstractPlot.moveToExtreme
- Defined in src/model/abstract.ts:130

moveToIndex

moveToIndex(row: number, col: number): boolean
Parameters
- row: number
- col: number
Returns boolean
Implementation of Movable.moveToIndex
Inherited from AbstractPlot.moveToIndex
- Defined in src/model/abstract.ts:140

isMovable

isMovable(target: MovableDirection | [number, number]): boolean
Parameters
- target: MovableDirection | [number, number]
Returns boolean
Implementation of Movable.isMovable
Inherited from AbstractPlot.isMovable
- Defined in src/model/abstract.ts:150

notifyObserversWithState

notifyObserversWithState(state: FigureState): void
Parameters
- state: FigureState
Returns void
Inherited from AbstractPlot.notifyObserversWithState
- Defined in src/model/abstract.ts:160

moveToNextCompareValue

moveToNextCompareValue(
_direction: "left" | "right" | "up" | "down",
_type: "lower" | "higher",
): boolean
Base implementation of navigation in HIGHER and LOWER modes of ROTOR, default is no-op Needs to be implemented in Line, Bar, Heatmap, Candlestick
Parameters
- _direction: "left" | "right" | "up" | "down"
- _type: "lower" | "higher"
Returns boolean
Inherited from AbstractPlot.moveToNextCompareValue
- Defined in src/model/abstract.ts:170

`Protected`compare

compare(a: number, b: number, type: "lower" | "higher"): boolean
Parameters
- a: number
  Utility function to compare point values for rotor functionality
- b: number
- type: "lower" | "higher"
Returns boolean
boolean value
Inherited from AbstractPlot.compare
- Defined in src/model/abstract.ts:182

moveUpRotor

moveUpRotor(_mode?: "lower" | "higher"): boolean
Moves up in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractPlot.moveUpRotor
- Defined in src/model/abstract.ts:200

moveDownRotor

moveDownRotor(_mode?: "lower" | "higher"): boolean
Moves down in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractPlot.moveDownRotor
- Defined in src/model/abstract.ts:209

moveLeftRotor

moveLeftRotor(_mode?: "lower" | "higher"): boolean
Moves left in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractPlot.moveLeftRotor
- Defined in src/model/abstract.ts:218

moveRightRotor

moveRightRotor(_mode?: "lower" | "higher"): boolean
Moves right in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractPlot.moveRightRotor
- Defined in src/model/abstract.ts:227

dispose

dispose(): void
Cleans up all subplots and releases resources

Returns void
Implementation of Disposable.dispose
Overrides AbstractPlot.dispose
- Defined in src/model/plot.ts:65

moveToPoint

moveToPoint(_x: number, _y: number): void
Moves to a specific point in the figure (implementation in subclasses)
Parameters
- _x: number
  The x coordinate
- _y: number
  The y coordinate
Returns void
Overrides AbstractPlot.moveToPoint
- Defined in src/model/plot.ts:188