com.highsoft.highcharts.common.hichartsclasses

Class HIAnnounceNewData

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIAnnounceNewData

public class HIAnnounceNewData
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIAnnounceNewData()

Method Summary

Modifier and Type	Method and Description
HIFunction	getAnnouncementFormatter()
java.lang.Boolean	getEnabled()
java.lang.Boolean	getInterruptUser()
java.lang.Number	getMinAnnounceInterval()
java.lang.String	getNewDataAnnounce()
java.lang.String	getNewPointAnnounceMultiple()
java.lang.String	getNewPointAnnounceSingle()
java.lang.String	getNewSeriesAnnounceMultiple()
java.lang.String	getNewSeriesAnnounceSingle()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
void	setAnnouncementFormatter(HIFunction announcementFormatter) Optional formatter callback for the announcement.
void	setEnabled(java.lang.Boolean enabled) Enable announcing new data to screen reader users
void	setInterruptUser(java.lang.Boolean interruptUser) Choose whether or not the announcements should interrupt the screen reader.
void	setMinAnnounceInterval(java.lang.Number minAnnounceInterval) Minimum interval between announcements in milliseconds.
void	setNewDataAnnounce(java.lang.String newDataAnnounce)
void	setNewPointAnnounceMultiple(java.lang.String newPointAnnounceMultiple)
void	setNewPointAnnounceSingle(java.lang.String newPointAnnounceSingle)
void	setNewSeriesAnnounceMultiple(java.lang.String newSeriesAnnounceMultiple)
void	setNewSeriesAnnounceSingle(java.lang.String newSeriesAnnounceSingle)

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIAnnounceNewData

public HIAnnounceNewData()

Method Detail

getAnnouncementFormatter

public HIFunction getAnnouncementFormatter()

getEnabled

public java.lang.Boolean getEnabled()

getInterruptUser

public java.lang.Boolean getInterruptUser()

getMinAnnounceInterval

public java.lang.Number getMinAnnounceInterval()

getNewDataAnnounce

public java.lang.String getNewDataAnnounce()

getNewPointAnnounceMultiple

public java.lang.String getNewPointAnnounceMultiple()

getNewPointAnnounceSingle

public java.lang.String getNewPointAnnounceSingle()

getNewSeriesAnnounceMultiple

public java.lang.String getNewSeriesAnnounceMultiple()

getNewSeriesAnnounceSingle

public java.lang.String getNewSeriesAnnounceSingle()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

setAnnouncementFormatter

public void setAnnouncementFormatter(HIFunction announcementFormatter)

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. The function should return a string with the text to announce to the user. Return empty string to not announce anything. Return `false` to use the defaults announcement format.

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Enable announcing new data to screen reader users

setInterruptUser

public void setInterruptUser(java.lang.Boolean interruptUser)

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.

setMinAnnounceInterval

public void setMinAnnounceInterval(java.lang.Number minAnnounceInterval)

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.

defaults:

 5000

setNewDataAnnounce

public void setNewDataAnnounce(java.lang.String newDataAnnounce)

setNewPointAnnounceMultiple

public void setNewPointAnnounceMultiple(java.lang.String newPointAnnounceMultiple)

setNewPointAnnounceSingle

public void setNewPointAnnounceSingle(java.lang.String newPointAnnounceSingle)

setNewSeriesAnnounceMultiple

public void setNewSeriesAnnounceMultiple(java.lang.String newSeriesAnnounceMultiple)

setNewSeriesAnnounceSingle

public void setNewSeriesAnnounceSingle(java.lang.String newSeriesAnnounceSingle)