ReadingBlockUtterance¶

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/accessibility/voicing/ReadingBlockUtterance.ts for the most up-to-date information.

Overview¶

An Utterance specifically for ReadingBlocks. When a ReadingBlock is activated, the Trail from the event is used to determine exactly which ReadingBlock instance to highlight in the HighlightOverlay.

@author Jesse Greenberg

Class ReadingBlockUtterance¶

import { ReadingBlockUtterance } from 'scenerystack/scenery';

Constructor¶

new ReadingBlockUtterance( focus : Focus | null, options? : ReadingBlockUtteranceOptions )¶

Instance Methods¶

Instance Properties¶

readingBlockFocus : Focus | null¶

Can be set and change to support reusing this ReadingBlockUtterance.

Type ReadingBlockUtteranceOptions¶

import type { ReadingBlockUtteranceOptions } from 'scenerystack/scenery';

UtteranceOptions

Source Code¶

See the source for ReadingBlockUtterance.ts in the scenery repository.