Class TextService

constructor

• new TextService(
      notification: NotificationService,
      formatter?: FormatterService,
  ): TextService

  Constructs a TextService instance with notification support.

  Parameters

  • notification: NotificationService

    The notification service for user alerts

  • Optionalformatter: FormatterService

    Optional formatter service for custom value formatting

  Returns TextService

ReadonlyonChange

ReadonlyonNavigation

currentMode

• get currentMode(): TextMode

  The current text mode, for carrying it over to the controller built when the reader comes back to the chart.

  Returns TextMode

  The current text mode

dispose

• dispose(): void

  Disposes of event emitters and releases resources.

  Returns void

getCoordinateText

• getCoordinateText(): string | null

  Get coordinate information from the current state Returns null if no valid state is available

  Returns string | null

getVerboseText

• getVerboseText(): string | null

  The focused point described in full, whatever the text mode is.

  Terse and OFF modes shorten or silence what the reader hears, but the AI needs the whole description of the point, so this always formats the verbose way. Reads the last navigation state and leaves the mode alone.

  Returns string | null

  The verbose description, or null when nothing is focused

format

• format(state: string | PlotState): string

  Formats plot state into human-readable text based on current mode.

  Parameters

  • state: string | PlotState

    The state to format (string or PlotState object)

  Returns string

  Formatted text representation of the state

subplotEntryText

• subplotEntryText(
      index: number,
      size: number,
      plotType: string,
      title: string,
  ): string | null

  Builds the spoken cue for ENTERING a subplot from the multi-panel figure lobby, respecting the current text mode:

  • OFF: null (only the enter tone signals the transition);
  • TERSE: the panel's title alone (or bare "Subplot N" when untitled);
  • VERBOSE: the full transition, e.g. "Entered subplot 2 of 4, Sales in North, bar plot.".

  Lives here (not in the command layer) so all lobby wording and its terse/verbose rules share one home with formatFigureText.

  Parameters

  • index: number

    1-based visual position of the entered subplot.

  • size: number

    Total number of subplots in the figure.

  • plotType: string

    The entered trace's plot type ('' to omit).

  • title: string

    The entered subplot's authored title ('' when none).

  Returns string | null

  The message to announce, or null when text mode is OFF.

emptySubplotText

• emptySubplotText(index: number, size: number, title: string): string | null

  Builds the wording for a subplot that has nothing to describe — one the producer authored with an empty layers array, which is legitimate for an unoccupied cell in a non-rectangular grid or a panel whose geom MAIDR does not support yet. Respects the current text mode:

  • OFF: null;
  • TERSE: "