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

    ViewModel for managing text display, announcements, and notifications.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    store: EnhancedStore
    disposables: Disposable[]

    Accessors

    Methods

    • Updates the displayed text with formatted content. Each dispatch increments a revision counter in the Redux state, so the View always receives a new state — even when the text is identical. This allows the View to force a screen-reader re-announcement by re-mounting the alert element with a new React key, without relying on invisible Unicode characters.

      Parameters

      • text: string | PlotState

        The text or plot state to display

      Returns void

    • Sets whether text should be announced by screen readers.

      Parameters

      • enabled: boolean

        Whether to enable text announcements

      Returns void

    • Warns the user if text mode is off by announcing a message and playing a warning tone.

      Returns boolean

      True if text mode is off and the warning was issued, false otherwise