Chrome DevTools Protocol

Methods

Accessibility.disable

Disables the accessibility domain.

Accessibility.enable

Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.

Accessibility.getFullAXTree Experimental

Fetches the entire accessibility tree

Return Object
nodes
array[ AXNode ]

Accessibility.getPartialAXTree Experimental

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

parameters
nodeId
DOM.NodeId

Identifier of the node to get the partial accessibility tree for.

backendNodeId
DOM.BackendNodeId

Identifier of the backend node to get the partial accessibility tree for.

objectId
Runtime.RemoteObjectId

JavaScript object id of the node wrapper to get the partial accessibility tree for.

fetchRelatives
boolean

Whether to fetch this nodes ancestors, siblings and children. Defaults to true.

Return Object
nodes
array[ AXNode ]

The Accessibility.AXNode for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.

Types

Accessibility.AXNode

A node in the accessibility tree.

Type: object

properties
nodeId
AXNodeId

Unique identifier for this node.

ignored
boolean

Whether this node is ignored for accessibility

ignoredReasons
array[ AXProperty ]

Collection of reasons why this node is hidden.

role
AXValue

This Node's role, whether explicit or implicit.

name
AXValue

The accessible name for this Node.

description
AXValue

The accessible description for this Node.

value
AXValue

The value for this Node.

properties
array[ AXProperty ]

All other properties

childIds
array[ AXNodeId ]

IDs for each of this node's child nodes.

backendDOMNodeId
DOM.BackendNodeId

The backend ID for the associated DOM node, if any.

Accessibility.AXNodeId

Unique accessibility node identifier.

Type: string

Accessibility.AXProperty

Type: object

properties
name
AXPropertyName

The name of this property.

value
AXValue

The value of this property.

Accessibility.AXPropertyName

Values of AXProperty name:

  • from 'busy' to 'roledescription': states which apply to every AX node
  • from 'live' to 'root': attributes which apply to nodes in live regions
  • from 'autocomplete' to 'valuetext': attributes which apply to widgets
  • from 'checked' to 'selected': states which apply to widgets
  • from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
Allowed Values: busy, disabled, editable, focusable, focused, hidden, hiddenRoot, invalid, keyshortcuts, settable, roledescription, live, atomic, relevant, root, autocomplete, hasPopup, level, multiselectable, orientation, multiline, readonly, required, valuemin, valuemax, valuetext, checked, expanded, modal, pressed, selected, activedescendant, controls, describedby, details, errormessage, flowto, labelledby, owns

Type: string

Accessibility.AXRelatedNode

Type: object

properties
backendDOMNodeId
DOM.BackendNodeId

The BackendNodeId of the related DOM node.

idref
string

The IDRef value provided, if any.

text
string

The text alternative of this node in the current context.

Accessibility.AXValue

A single computed AX property.

Type: object

properties
type
AXValueType

The type of this value.

value
any

The computed value of this property.

relatedNodes
array[ AXRelatedNode ]

One or more related nodes, if applicable.

sources
array[ AXValueSource ]

The sources which contributed to the computation of this property.

Accessibility.AXValueNativeSourceType

Enum of possible native property sources (as a subtype of a particular AXValueSourceType).

Allowed Values: figcaption, label, labelfor, labelwrapped, legend, tablecaption, title, other

Type: string

Accessibility.AXValueSource

A single source for a computed AX property.

Type: object

properties
type
AXValueSourceType

What type of source this is.

value
AXValue

The value of this property source.

attribute
string

The name of the relevant attribute, if any.

attributeValue
AXValue

The value of the relevant attribute, if any.

superseded
boolean

Whether this source is superseded by a higher priority source.

nativeSource
AXValueNativeSourceType

The native markup source for this value, e.g. a

nativeSourceValue
AXValue

The value, such as a node or node list, of the native source.

invalid
boolean

Whether the value for this property is invalid.

invalidReason
string

Reason for the value being invalid, if it is.

Accessibility.AXValueSourceType

Enum of possible property sources.

Allowed Values: attribute, implicit, style, contents, placeholder, relatedElement

Type: string

Accessibility.AXValueType

Enum of possible property types.

Allowed Values: boolean, tristate, booleanOrUndefined, idref, idrefList, integer, node, nodeList, number, string, computedString, token, tokenList, domRelation, role, internalRole, valueUndefined

Type: string