JS API Reference

Welcome to the Highmaps JS Options Reference

These pages outline the chart configuration options, and the methods and properties of Highcharts objects.

Feel free to search this API through the search bar or the navigation tree in the sidebar.

accessibility.description

A text description of the chart.

Note: Prefer using linkedDescription or caption instead.

If the Accessibility module is loaded, this option is included by default as a long description of the chart in the hidden screen reader information region.

Note: Since Highcharts now supports captions and linked descriptions, it is preferred to define the description using those methods, as a visible caption/description benefits all users. If the accessibility.description option is defined, the linked description is ignored, and the caption is hidden from screen reader users.