ReplayBarBinding

Documentation / @elitechart/core / ReplayBarBinding

Actions the replay bar delegates back to the chart. Wire each callback to the matching chart.*Replay* method.

Example

code

const binding: ReplayBarBinding = {
  onEnter: () => chart.enterReplay(),
  onExit: () => chart.exitReplay(),
  onStep: (n) => chart.stepReplay(n),
  onPlay: (ms) => chart.playReplay(ms),
  onPause: () => chart.pauseReplay(),
  onSelectRange: () => chart.selectReplayRange(),
  onClearRange: () => chart.clearReplayRange(),
};

Methods

onClearRange()?

code

optional onClearRange(): void;

Defined in: ui/replay-bar.ts:44

Optional — clear any previously-selected replay range.

Returns

void

onEnter()

code

onEnter(): void;

Defined in: ui/replay-bar.ts:29

Enter replay mode (cursor starts at default position).

Returns

void

onExit()

code

onExit(): void;

Defined in: ui/replay-bar.ts:31

Exit replay mode.

Returns

void

onPause()

code

onPause(): void;

Defined in: ui/replay-bar.ts:37

Pause auto-advance.

Returns

void

onPlay()

code

onPlay(speedMs): void;

Defined in: ui/replay-bar.ts:35

Start auto-advance at the given speed (ms per bar).

Parameters

speedMs

number

Returns

void

onSelectRange()?

code

optional onSelectRange(): void;

Defined in: ui/replay-bar.ts:42

Optional — arms drag-to-select replay-range mode on the chart. The next pointer drag on the plot area defines the replay window.

Returns

void

onStep()

code

onStep(n): void;

Defined in: ui/replay-bar.ts:33

Step the cursor forward (n > 0) or back (n < 0).

Parameters

n

number

Returns

void