MAIDR Documentation - v3.73.0
    Preparing search index...

    Command-layer collaborator that bundles the three services a subplot transition needs for audible and spoken feedback: AudioService (navigation tone), TextService (which owns the mode-aware transition wording) and NotificationService (the spoken alert). It centralizes the repeated "play tone, build a mode-aware message, notify when non-null" sequence so the three subplot-transition commands stop each carrying — and growing — that trio.

    The terse/verbose message wording itself lives in TextService (TextService.subplotEntryText / TextService.subplotExitText), next to the lobby navigation text, so all lobby wording shares one home; this collaborator only orchestrates tone + notify.

    It is deliberately unaware of Context, braille state, and lobby gating: the commands own those decisions and call the matching method. The enter tone is exposed separately from the enter announcement because the braille-enabled entry path plays the tone but suppresses the spoken alert. It owns no resources, so it needs no dispose(); the wrapped services are owned and disposed by the Controller.

    Index

    Constructors

    Methods

    • Plays the "enter subplot" tone without announcing anything. Used on every real lobby entry, including the braille-enabled path that suppresses the spoken alert (to avoid clashing with the braille focus change) but still cues the tone.

      Returns void

    • Announces which subplot was entered, respecting the current text mode (OFF -> TextService returns null -> no notify, so only the tone is heard). Plays no tone: the caller plays it via playEnterTone so the tone fires on both the braille and non-braille paths.

      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 void

    • Full "returned to the figure lobby" cue: plays the exit tone, then (in TERSE/VERBOSE mode) announces the lobby position; in OFF mode only the tone plays. The caller must run the navigation transition (exitSubplot) BEFORE calling this, so state reflects the lobby returned to. This method never touches Context; the tone-before-notify ordering is preserved here while the exit-before-notify ordering is preserved by the caller.

      Parameters

      • state: PlotState

        The figure lobby state returned to.

      Returns void