Class AbstractPlot<State>`Abstract`

Interface for plot traces that support keyboard navigation and movement.

Type Parameters

State

Hierarchy (View Summary)

AbstractPlot

Implements

Constructors

`Protected`constructor

new AbstractPlot<State>(): AbstractPlot<State>
Type Parameters
- State
Returns AbstractPlot<State>
- Defined in src/model/abstract.ts:33

Properties

`Protected` `Readonly`observers

observers: Observer<State>[]

Accessors

`Protected` `Abstract`dimension

get dimension(): Dimension
Returns Dimension
- Defined in src/model/abstract.ts:36

isInitialEntry

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

isOutOfBounds

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

row

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

col

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

`Abstract`state

get state(): State
Returns State
Implementation of Observable.state
- Defined in src/model/abstract.ts:154

`Protected` `Abstract`outOfBoundsState

get outOfBoundsState(): State
Returns State
- Defined in src/model/abstract.ts:156

`Protected` `Abstract`movable

get movable(): Movable
Returns Movable
- Defined in src/model/abstract.ts:158

Methods

dispose

dispose(): void
Returns void
Implementation of Disposable.dispose
- Defined in src/model/abstract.ts:38

`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
- Defined in src/model/abstract.ts:78

addObserver

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

removeObserver

removeObserver(observer: Observer<State>): void
Removes an observer from receiving state updates.
Parameters
- observer: Observer<State>
  The observer to remove
Returns void
Implementation of Observable.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
- Defined in src/model/abstract.ts:107

notifyOutOfBounds

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

Returns void
- Defined in src/model/abstract.ts:115

moveOnce

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

moveToExtreme

moveToExtreme(direction: MovableDirection): boolean
Parameters
- direction: MovableDirection
Returns boolean
Implementation of Movable.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
- 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
- Defined in src/model/abstract.ts:150

notifyObserversWithState

notifyObserversWithState(state: State): void
Parameters
- state: State
Returns void
- 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
- 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
- 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
- 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
- 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
- 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
- Defined in src/model/abstract.ts:227

moveToPoint

moveToPoint(_x: number, _y: number): void
Moves the element to the specified (x, y) point.

This base implementation is intentionally left empty. Subclasses should override this method to provide specific logic for moving to a point, such as updating highlight values or managing selection boxes.
Parameters
- _x: number
  The x-coordinate to move to.
- _y: number
  The y-coordinate to move to.
Returns void
- Defined in src/model/abstract.ts:241