Class ReviewService

Manages review mode functionality, generating formatted review text for the active plot element. Works at trace level (data descriptions) and at the multi-panel figure lobby (subplot navigation text).

Implements

Index

Constructors

Properties

Methods

dispose update toggle

Constructors

constructor

new ReviewService(
    notification: NotificationService,
    display: DisplayService,
    text: TextService,
): ReviewService
Creates a new ReviewService instance.
Parameters
- notification: NotificationService
  Service for displaying notifications
- display: DisplayService
  Service for managing display focus
- text: TextService
  Service for formatting text output
Returns ReviewService
- Defined in service/review.ts:38

Properties

`Readonly`onChange

onChange: Event<ReviewChangedEvent>

Methods

dispose

dispose(): void
Disposes of the review service and cleans up event emitters.

Returns void
Implementation of Disposable.dispose
- Defined in service/review.ts:52

update

update(state: PlotState): void
Updates the review content based on the current plot state.
Parameters
- state: PlotState
  The current plot state to generate review from
Returns void
Implementation of Observer.update
- Defined in service/review.ts:60

toggle

toggle(state: PlotState): void
Toggles review mode on or off and updates the display focus.
Parameters
- state: PlotState
  The current plot state to review
Returns void
- Defined in service/review.ts:75

src