Skip to content

PDOMTree

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/pdom/PDOMTree.ts for the most up-to-date information.

Overview

The main logic for maintaining the PDOM instance tree (see https://github.com/phetsims/scenery-phet/issues/365)

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

Class PDOMTree

import { PDOMTree } from 'scenerystack/scenery';

Static Methods

addChild( parent : Node, child : Node )

Called when a child node is added to a parent node (and the child is likely to have pdom content).

removeChild( parent : Node, child : Node )

Called when a child node is removed from a parent node (and the child is likely to have pdom content).

childrenOrderChange( node : Node )

Called when a node's children are reordered (no additions/removals).

pdomOrderChange( node : Node, oldOrder : ( Node | null )[] | null, newOrder : ( Node | null )[] | null )

Called when a node has a pdomOrder change.

pdomContentChange( node : Node )

Called when a node has a pdomContent change.

rebuildInstanceTree( rootInstance : PDOMInstance )

Sets up a root instance with a given root node.

auditPDOMDisplays( node : Node )

Ensures that the pdomDisplays on the node (and its subtree) are accurate.

Source Code

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