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

    Class TextService

    Service for managing text output and formatting of plot state information.

    Implements

    Index

    Constructors

    Properties

    onChange: Event<TextChangedEvent>
    onNavigation: Event<TextNavigationEvent>

    Methods

    • Get the current state that was last processed by the TextService This provides access to state information without violating dependency flow

      Returns PlotState | null

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

      Returns string | null

    • Check if the current state represents a layer switch Returns true if the subplot index has changed

      Returns boolean

    • Check if the first navigation has occurred Returns true if the user has navigated at least once

      Returns boolean

    • Enable announcements after first navigation This method can be called externally to enable announcements

      Returns void

    • 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

    • Toggles between text modes (OFF, TERSE, VERBOSE) in sequence.

      Returns boolean

      True if text mode is now active (not OFF), false otherwise

    • Checks if the text service is in verbose mode.

      Returns boolean

      True if text mode is set to verbose, false otherwise

    • Checks if the text service is in terse mode.

      Returns boolean

      True if text mode is set to terse, false otherwise

    • Checks if the text service is turned off.

      Returns boolean

      True if text mode is set to off, false otherwise