IAccessibilitySettings

Type interface

Accessibility setting that can be applied to any visual element.

Click here for more info

Inheritance

IAccessibilitySettings does not extend any other symbol.

IAccessibilitySettings is not extended by any other symbol.

Properties

ariaChecked
#

Type undefined | false | true

aria-checked setting.

This setting is ignored unless role is one of the following:

  • "checkbox"
  • "option"
  • "radio"
  • "menuitemcheckbox"
  • "menuitemradio"
  • "treeitem"

ariaControls
#

Type undefined | string

aria-controls setting.

ariaHidden
#

Type undefined | false | true

aria-hidden setting.

ariaLabel
#

Type undefined | string

Label for the element to use for screen readers.

Click here for more info

ariaLive
#

Type AriaLive

aria-live setting.

ariaOrientation
#

Type undefined | string

aria-orientation setting.

ariaValueMax
#

Type undefined | string

aria-valuemax setting.

ariaValueMin
#

Type undefined | string

aria-valuemin setting.

ariaValueNow
#

Type undefined | string

aria-valuenow setting.

ariaValueText
#

Type undefined | string

aria-valuetext setting.

focusable
#

Type undefined | false | true

Can element be focused, i.e. selected using TAB key.

Click here for more info

focusableGroup
#

Type string | number

An identifier by which to group common elements into focusable groups.

If set, only the first element in he group will be focusable via TAB key.

When it is selected, the rest of the elements in the same group can be selected using arrow keys.

It allows users to TAB-through chart elements quickly without the need to TAB into each and every element.

It's up to implementer of the charts to provide meaningful ariaLabel to the element, which advertises this capability and provides adequate instructions.

Click here for more info
@since 5.0.6

hoverOnFocus
#

Type undefined | false | true

Simulate hover on an element when it gains focus, including changing hover appearance and displaying a tooltip if application.

Click here for more info

role
#

Type Role

Element's role.

Click here for more info

tabindexOrder
#

Type undefined | number

An internal order by which focusable elements will be selected within the chart.

Click here for more info