AccessibilityMessages
Defined in: diagram/Diagram.ts:151
Message formatters for the diagram’s accessibility features: the canvas
aria-label and the off-screen aria-live region announcements (see the
Interaction guide’s Accessibility section). All defaults are in English;
override any subset via DiagramOptions.accessibilityMessages or
diagram.accessibilityMessages = {...} to localize.
Still growing before 1.0.0 — expect additive changes, not removals.
Methods
Sección titulada «Methods»ariaLabel()
Sección titulada «ariaLabel()»ariaLabel(
counts):string
Defined in: diagram/Diagram.ts:155
The canvas aria-label, given the current content/selection counts.
Parameters
Sección titulada «Parameters»number
number
number
selected
Sección titulada «selected»number
Returns
Sección titulada «Returns»string
describePart()
Sección titulada «describePart()»describePart(
part):string
Defined in: diagram/Diagram.ts:153
Short description of a part, e.g. Node "Alpha" — used by the other messages below.
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»string
focusMoved()
Sección titulada «focusMoved()»focusMoved(
description):string
Defined in: diagram/Diagram.ts:163
Announcement when the keyboard focus cursor moves (description from describePart).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
multipleSelected()
Sección titulada «multipleSelected()»multipleSelected(
count):string
Defined in: diagram/Diagram.ts:161
Announcement when more than one part is selected.
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»string
partAdded()
Sección titulada «partAdded()»partAdded(
description):string
Defined in: diagram/Diagram.ts:165
Announcement when a single part is added (e.g. via ClickCreatingTool).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
partsDeleted()
Sección titulada «partsDeleted()»partsDeleted(
count):string
Defined in: diagram/Diagram.ts:167
Announcement when one or more parts are deleted (e.g. via CommandHandler.deleteSelection).
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»string
redoPerformed()
Sección titulada «redoPerformed()»redoPerformed(
description):string
Defined in: diagram/Diagram.ts:171
Announcement after a redo (description from the redone command’s describe()).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
selectionCleared()
Sección titulada «selectionCleared()»selectionCleared():
string
Defined in: diagram/Diagram.ts:157
Announcement when the selection becomes empty.
Returns
Sección titulada «Returns»string
singleSelected()
Sección titulada «singleSelected()»singleSelected(
description):string
Defined in: diagram/Diagram.ts:159
Announcement when exactly one part is selected (description from describePart).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
treeCollapsed()
Sección titulada «treeCollapsed()»treeCollapsed(
description):string
Defined in: diagram/Diagram.ts:173
Announcement when a node’s tree is collapsed (description from describePart).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
treeExpanded()
Sección titulada «treeExpanded()»treeExpanded(
description):string
Defined in: diagram/Diagram.ts:175
Announcement when a node’s tree is expanded (description from describePart).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string
undoPerformed()
Sección titulada «undoPerformed()»undoPerformed(
description):string
Defined in: diagram/Diagram.ts:169
Announcement after an undo (description from the undone command’s describe()).
Parameters
Sección titulada «Parameters»description
Sección titulada «description»string
Returns
Sección titulada «Returns»string