LiveRegionController class

Controller for managing screen reader announcements in charts.

Provides methods to announce chart changes, navigation events, and data updates to assistive technologies.

Example:

final liveRegion = LiveRegionController();

// Announce navigation
liveRegion.announceNavigation(dataPoint);

// Announce data change
liveRegion.announceDataChange('5 new data points added');

Constructors

LiveRegionController({LiveRegionPoliteness defaultPoliteness = LiveRegionPoliteness.polite})

Properties

defaultPoliteness → LiveRegionPoliteness
Default politeness level for announcements.
final
enabled ↔ bool
Gets whether announcements are enabled.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

announce(String message, {LiveRegionPoliteness? politeness}) → void
Announces a custom message.
announceChartSummary(ChartSemantics semantics, {LiveRegionPoliteness? politeness}) → void
Announces a chart summary.
announceDataChange(String message, {LiveRegionPoliteness? politeness}) → void
Announces a data change to screen readers.
announceError(String errorMessage, {LiveRegionPoliteness? politeness}) → void
Announces an error or warning.
announceFilterChange(String filterDescription, {LiveRegionPoliteness? politeness}) → void
Announces filter change.
announceNavigation(DataPointInfo point, {String? customMessage, LiveRegionPoliteness? politeness}) → void
Announces navigation to a data point.
announceSelection(DataPointInfo? point, {bool isSelected = true, LiveRegionPoliteness? politeness}) → void
Announces selection change.
announceTrend(List<DataPointInfo> points, {LiveRegionPoliteness? politeness}) → void
Announces trend information for data points.
announceZoomChange(double zoomLevel, {LiveRegionPoliteness? politeness}) → void
Announces zoom level change.
clearQueue() → void
Clears all pending announcements.
dispose() → void
Disposes resources.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited