HighchartsAccessibilityAnnounceNewDataOptions class

Options for announcing new data to screen reader users. Useful for dynamic data applications and drilldown.

Keep in mind that frequent announcements will not be useful to users, as they won't have time to explore the new data. For these applications, consider making snapshots of the data accessible, and do the announcements in batches.

API Docs: https://api.highcharts.com/highcharts/accessibility.announceNewData

Inheritance

Constructors

HighchartsAccessibilityAnnounceNewDataOptions.new({dynamic announcementFormatter, bool? enabled, bool? interruptUser, double? minAnnounceInterval})
Options for announcing new data to screen reader users. Useful for dynamic data applications and drilldown.

Properties

announcementFormatter ↔ dynamic
Optional formatter callback for the announcement. Receives up to three arguments. The first argument is always an array of all series that received updates. If an announcement is already queued, the series that received updates for that announcement are also included in this array. The second argument is provided if chart.addSeries was called, and there is a new series. In that case, this argument is a reference to the new series. The third argument, similarly, is provided if series.addPoint was called, and there is a new point. In that case, this argument is a reference to the new point.
getter/setter pair
enabled ↔ bool?
Enable announcing new data to screen reader users
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
interruptUser ↔ bool?
Choose whether or not the announcements should interrupt the screen reader. If not enabled, the user will be notified once idle. It is recommended not to enable this setting unless there is a specific reason to do so.
getter/setter pair
minAnnounceInterval ↔ double?
Minimum interval between announcements in milliseconds. If new data arrives before this amount of time has passed, it is queued for announcement. If another new data event happens while an announcement is queued, the queued announcement is dropped, and the latest announcement is queued instead. Set to 0 to allow all announcements, but be warned that frequent announcements are disturbing to users.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

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