PDOMDisplaysInfo¶

Overview¶

Per-node information required to track what PDOM Displays our Node is visible under. A PDOM display is a Display that is marked true with the accessibility option, and thus creates and manages a ParallelDOM (see ParallelDOM and general scenery accessibility doc for more details). Acts like a multimap (duplicates allowed) to indicate how many times we appear in a pdom display.

@author Jonathan Olson <jonathan.olson@colorado.edu>

Class PDOMDisplaysInfo¶

import { PDOMDisplaysInfo } from 'scenerystack/scenery';

Instance Properties¶

pdomDisplays : Display[]¶

(readonly)

(duplicates allowed) - There is one copy of each pdom Display for each trail (from its root node to this node) that is fully visible (assuming this subtree has pdom content). Thus, the value of this is: - If this node is invisible OR the subtree has no pdomContent/pdomOrder: [] - Otherwise, it is the concatenation of our parents' pdomDisplays (AND any pdom displays rooted at this node). This value is synchronously updated, and supports pdomInstances by letting them know when certain nodes are visible on the display.

Source Code¶

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