LangOptions.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. /* *
  2. *
  3. * (c) 2009-2021 Øystein Moseng
  4. *
  5. * Default lang/i18n options for accessibility.
  6. *
  7. * License: www.highcharts.com/license
  8. *
  9. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  10. *
  11. * */
  12. 'use strict';
  13. var langOptions = {
  14. /**
  15. * Configure the accessibility strings in the chart. Requires the
  16. * [accessibility module](https://code.highcharts.com/modules/accessibility.js)
  17. * to be loaded. For a description of the module and information on its
  18. * features, see
  19. * [Highcharts Accessibility](https://www.highcharts.com/docs/chart-concepts/accessibility).
  20. *
  21. * For more dynamic control over the accessibility functionality, see
  22. * [accessibility.pointDescriptionFormatter](#accessibility.pointDescriptionFormatter),
  23. * [accessibility.seriesDescriptionFormatter](#accessibility.seriesDescriptionFormatter),
  24. * and
  25. * [accessibility.screenReaderSectionFormatter](#accessibility.screenReaderSectionFormatter).
  26. *
  27. * @since 6.0.6
  28. * @optionparent lang.accessibility
  29. */
  30. accessibility: {
  31. defaultChartTitle: 'Chart',
  32. chartContainerLabel: '{title}. Highcharts interactive chart.',
  33. svgContainerLabel: 'Interactive chart',
  34. drillUpButton: '{buttonText}',
  35. credits: 'Chart credits: {creditsStr}',
  36. /**
  37. * Thousands separator to use when formatting numbers for screen
  38. * readers. Note that many screen readers will not handle space as a
  39. * thousands separator, and will consider "11 700" as two numbers.
  40. *
  41. * Set to `null` to use the separator defined in
  42. * [lang.thousandsSep](lang.thousandsSep).
  43. *
  44. * @since 7.1.0
  45. */
  46. thousandsSep: ',',
  47. /**
  48. * Title element text for the chart SVG element. Leave this
  49. * empty to disable adding the title element. Browsers will display
  50. * this content when hovering over elements in the chart. Assistive
  51. * technology may use this element to label the chart.
  52. *
  53. * @since 6.0.8
  54. */
  55. svgContainerTitle: '',
  56. /**
  57. * Set a label on the container wrapping the SVG.
  58. *
  59. * @see [chartContainerLabel](#lang.accessibility.chartContainerLabel)
  60. *
  61. * @since 8.0.0
  62. */
  63. graphicContainerLabel: '',
  64. /**
  65. * Language options for the screen reader information sections added
  66. * before and after the charts.
  67. *
  68. * @since 8.0.0
  69. */
  70. screenReaderSection: {
  71. beforeRegionLabel: 'Chart screen reader information.',
  72. afterRegionLabel: '',
  73. /**
  74. * Language options for annotation descriptions.
  75. *
  76. * @since 8.0.1
  77. */
  78. annotations: {
  79. heading: 'Chart annotations summary',
  80. descriptionSinglePoint: '{annotationText}. Related to {annotationPoint}',
  81. descriptionMultiplePoints: '{annotationText}. Related to {annotationPoint}' +
  82. '{ Also related to, #each(additionalAnnotationPoints)}',
  83. descriptionNoPoints: '{annotationText}'
  84. },
  85. /**
  86. * Label for the end of the chart. Announced by screen readers.
  87. *
  88. * @since 8.0.0
  89. */
  90. endOfChartMarker: 'End of interactive chart.'
  91. },
  92. /**
  93. * Language options for sonification.
  94. *
  95. * @since 8.0.1
  96. */
  97. sonification: {
  98. playAsSoundButtonText: 'Play as sound, {chartTitle}',
  99. playAsSoundClickAnnouncement: 'Play'
  100. },
  101. /**
  102. * Language options for accessibility of the legend.
  103. *
  104. * @since 8.0.0
  105. */
  106. legend: {
  107. legendLabelNoTitle: 'Toggle series visibility',
  108. legendLabel: 'Chart legend: {legendTitle}',
  109. legendItem: 'Show {itemName}'
  110. },
  111. /**
  112. * Chart and map zoom accessibility language options.
  113. *
  114. * @since 8.0.0
  115. */
  116. zoom: {
  117. mapZoomIn: 'Zoom chart',
  118. mapZoomOut: 'Zoom out chart',
  119. resetZoomButton: 'Reset zoom'
  120. },
  121. /**
  122. * Range selector language options for accessibility.
  123. *
  124. * @since 8.0.0
  125. */
  126. rangeSelector: {
  127. dropdownLabel: '{rangeTitle}',
  128. minInputLabel: 'Select start date.',
  129. maxInputLabel: 'Select end date.',
  130. clickButtonAnnouncement: 'Viewing {axisRangeDescription}'
  131. },
  132. /**
  133. * Accessibility language options for the data table.
  134. *
  135. * @since 8.0.0
  136. */
  137. table: {
  138. viewAsDataTableButtonText: 'View as data table, {chartTitle}',
  139. tableSummary: 'Table representation of chart.'
  140. },
  141. /**
  142. * Default announcement for new data in charts. If addPoint or
  143. * addSeries is used, and only one series/point is added, the
  144. * `newPointAnnounce` and `newSeriesAnnounce` strings are used.
  145. * The `...Single` versions will be used if there is only one chart
  146. * on the page, and the `...Multiple` versions will be used if there
  147. * are multiple charts on the page. For all other new data events,
  148. * the `newDataAnnounce` string will be used.
  149. *
  150. * @since 7.1.0
  151. */
  152. announceNewData: {
  153. newDataAnnounce: 'Updated data for chart {chartTitle}',
  154. newSeriesAnnounceSingle: 'New data series: {seriesDesc}',
  155. newPointAnnounceSingle: 'New data point: {pointDesc}',
  156. newSeriesAnnounceMultiple: 'New data series in chart {chartTitle}: {seriesDesc}',
  157. newPointAnnounceMultiple: 'New data point in chart {chartTitle}: {pointDesc}'
  158. },
  159. /**
  160. * Descriptions of lesser known series types. The relevant
  161. * description is added to the screen reader information region
  162. * when these series types are used.
  163. *
  164. * @since 6.0.6
  165. */
  166. seriesTypeDescriptions: {
  167. boxplot: 'Box plot charts are typically used to display ' +
  168. 'groups of statistical data. Each data point in the ' +
  169. 'chart can have up to 5 values: minimum, lower quartile, ' +
  170. 'median, upper quartile, and maximum.',
  171. arearange: 'Arearange charts are line charts displaying a ' +
  172. 'range between a lower and higher value for each point.',
  173. areasplinerange: 'These charts are line charts displaying a ' +
  174. 'range between a lower and higher value for each point.',
  175. bubble: 'Bubble charts are scatter charts where each data ' +
  176. 'point also has a size value.',
  177. columnrange: 'Columnrange charts are column charts ' +
  178. 'displaying a range between a lower and higher value for ' +
  179. 'each point.',
  180. errorbar: 'Errorbar series are used to display the ' +
  181. 'variability of the data.',
  182. funnel: 'Funnel charts are used to display reduction of data ' +
  183. 'in stages.',
  184. pyramid: 'Pyramid charts consist of a single pyramid with ' +
  185. 'item heights corresponding to each point value.',
  186. waterfall: 'A waterfall chart is a column chart where each ' +
  187. 'column contributes towards a total end value.'
  188. },
  189. /**
  190. * Chart type description strings. This is added to the chart
  191. * information region.
  192. *
  193. * If there is only a single series type used in the chart, we use
  194. * the format string for the series type, or default if missing.
  195. * There is one format string for cases where there is only a single
  196. * series in the chart, and one for multiple series of the same
  197. * type.
  198. *
  199. * @since 6.0.6
  200. */
  201. chartTypes: {
  202. /* eslint-disable max-len */
  203. emptyChart: 'Empty chart',
  204. mapTypeDescription: 'Map of {mapTitle} with {numSeries} data series.',
  205. unknownMap: 'Map of unspecified region with {numSeries} data series.',
  206. combinationChart: 'Combination chart with {numSeries} data series.',
  207. defaultSingle: 'Chart with {numPoints} data {#plural(numPoints, points, point)}.',
  208. defaultMultiple: 'Chart with {numSeries} data series.',
  209. splineSingle: 'Line chart with {numPoints} data {#plural(numPoints, points, point)}.',
  210. splineMultiple: 'Line chart with {numSeries} lines.',
  211. lineSingle: 'Line chart with {numPoints} data {#plural(numPoints, points, point)}.',
  212. lineMultiple: 'Line chart with {numSeries} lines.',
  213. columnSingle: 'Bar chart with {numPoints} {#plural(numPoints, bars, bar)}.',
  214. columnMultiple: 'Bar chart with {numSeries} data series.',
  215. barSingle: 'Bar chart with {numPoints} {#plural(numPoints, bars, bar)}.',
  216. barMultiple: 'Bar chart with {numSeries} data series.',
  217. pieSingle: 'Pie chart with {numPoints} {#plural(numPoints, slices, slice)}.',
  218. pieMultiple: 'Pie chart with {numSeries} pies.',
  219. scatterSingle: 'Scatter chart with {numPoints} {#plural(numPoints, points, point)}.',
  220. scatterMultiple: 'Scatter chart with {numSeries} data series.',
  221. boxplotSingle: 'Boxplot with {numPoints} {#plural(numPoints, boxes, box)}.',
  222. boxplotMultiple: 'Boxplot with {numSeries} data series.',
  223. bubbleSingle: 'Bubble chart with {numPoints} {#plural(numPoints, bubbles, bubble)}.',
  224. bubbleMultiple: 'Bubble chart with {numSeries} data series.'
  225. },
  226. /**
  227. * Axis description format strings.
  228. *
  229. * @since 6.0.6
  230. */
  231. axis: {
  232. /* eslint-disable max-len */
  233. xAxisDescriptionSingular: 'The chart has 1 X axis displaying {names[0]}. {ranges[0]}',
  234. xAxisDescriptionPlural: 'The chart has {numAxes} X axes displaying {#each(names, -1) }and {names[-1]}.',
  235. yAxisDescriptionSingular: 'The chart has 1 Y axis displaying {names[0]}. {ranges[0]}',
  236. yAxisDescriptionPlural: 'The chart has {numAxes} Y axes displaying {#each(names, -1) }and {names[-1]}.',
  237. timeRangeDays: 'Range: {range} days.',
  238. timeRangeHours: 'Range: {range} hours.',
  239. timeRangeMinutes: 'Range: {range} minutes.',
  240. timeRangeSeconds: 'Range: {range} seconds.',
  241. rangeFromTo: 'Range: {rangeFrom} to {rangeTo}.',
  242. rangeCategories: 'Range: {numCategories} categories.'
  243. },
  244. /**
  245. * Exporting menu format strings for accessibility module.
  246. *
  247. * @since 6.0.6
  248. */
  249. exporting: {
  250. chartMenuLabel: 'Chart menu',
  251. menuButtonLabel: 'View chart menu',
  252. exportRegionLabel: 'Chart menu'
  253. },
  254. /**
  255. * Lang configuration for different series types. For more dynamic
  256. * control over the series element descriptions, see
  257. * [accessibility.seriesDescriptionFormatter](#accessibility.seriesDescriptionFormatter).
  258. *
  259. * @since 6.0.6
  260. */
  261. series: {
  262. /**
  263. * Lang configuration for the series main summary. Each series
  264. * type has two modes:
  265. *
  266. * 1. This series type is the only series type used in the
  267. * chart
  268. *
  269. * 2. This is a combination chart with multiple series types
  270. *
  271. * If a definition does not exist for the specific series type
  272. * and mode, the 'default' lang definitions are used.
  273. *
  274. * @since 6.0.6
  275. */
  276. summary: {
  277. /* eslint-disable max-len */
  278. 'default': '{name}, series {ix} of {numSeries} with {numPoints} data {#plural(numPoints, points, point)}.',
  279. defaultCombination: '{name}, series {ix} of {numSeries} with {numPoints} data {#plural(numPoints, points, point)}.',
  280. line: '{name}, line {ix} of {numSeries} with {numPoints} data {#plural(numPoints, points, point)}.',
  281. lineCombination: '{name}, series {ix} of {numSeries}. Line with {numPoints} data {#plural(numPoints, points, point)}.',
  282. spline: '{name}, line {ix} of {numSeries} with {numPoints} data {#plural(numPoints, points, point)}.',
  283. splineCombination: '{name}, series {ix} of {numSeries}. Line with {numPoints} data {#plural(numPoints, points, point)}.',
  284. column: '{name}, bar series {ix} of {numSeries} with {numPoints} {#plural(numPoints, bars, bar)}.',
  285. columnCombination: '{name}, series {ix} of {numSeries}. Bar series with {numPoints} {#plural(numPoints, bars, bar)}.',
  286. bar: '{name}, bar series {ix} of {numSeries} with {numPoints} {#plural(numPoints, bars, bar)}.',
  287. barCombination: '{name}, series {ix} of {numSeries}. Bar series with {numPoints} {#plural(numPoints, bars, bar)}.',
  288. pie: '{name}, pie {ix} of {numSeries} with {numPoints} {#plural(numPoints, slices, slice)}.',
  289. pieCombination: '{name}, series {ix} of {numSeries}. Pie with {numPoints} {#plural(numPoints, slices, slice)}.',
  290. scatter: '{name}, scatter plot {ix} of {numSeries} with {numPoints} {#plural(numPoints, points, point)}.',
  291. scatterCombination: '{name}, series {ix} of {numSeries}, scatter plot with {numPoints} {#plural(numPoints, points, point)}.',
  292. boxplot: '{name}, boxplot {ix} of {numSeries} with {numPoints} {#plural(numPoints, boxes, box)}.',
  293. boxplotCombination: '{name}, series {ix} of {numSeries}. Boxplot with {numPoints} {#plural(numPoints, boxes, box)}.',
  294. bubble: '{name}, bubble series {ix} of {numSeries} with {numPoints} {#plural(numPoints, bubbles, bubble)}.',
  295. bubbleCombination: '{name}, series {ix} of {numSeries}. Bubble series with {numPoints} {#plural(numPoints, bubbles, bubble)}.',
  296. map: '{name}, map {ix} of {numSeries} with {numPoints} {#plural(numPoints, areas, area)}.',
  297. mapCombination: '{name}, series {ix} of {numSeries}. Map with {numPoints} {#plural(numPoints, areas, area)}.',
  298. mapline: '{name}, line {ix} of {numSeries} with {numPoints} data {#plural(numPoints, points, point)}.',
  299. maplineCombination: '{name}, series {ix} of {numSeries}. Line with {numPoints} data {#plural(numPoints, points, point)}.',
  300. mapbubble: '{name}, bubble series {ix} of {numSeries} with {numPoints} {#plural(numPoints, bubbles, bubble)}.',
  301. mapbubbleCombination: '{name}, series {ix} of {numSeries}. Bubble series with {numPoints} {#plural(numPoints, bubbles, bubble)}.'
  302. },
  303. /**
  304. * User supplied description text. This is added in the point
  305. * comment description by default if present.
  306. *
  307. * @since 6.0.6
  308. */
  309. description: '{description}',
  310. /**
  311. * xAxis description for series if there are multiple xAxes in
  312. * the chart.
  313. *
  314. * @since 6.0.6
  315. */
  316. xAxisDescription: 'X axis, {name}',
  317. /**
  318. * yAxis description for series if there are multiple yAxes in
  319. * the chart.
  320. *
  321. * @since 6.0.6
  322. */
  323. yAxisDescription: 'Y axis, {name}',
  324. /**
  325. * Description for the value of null points.
  326. *
  327. * @since 8.0.0
  328. */
  329. nullPointValue: 'No value',
  330. /**
  331. * Description for annotations on a point, as it is made available
  332. * to assistive technology.
  333. *
  334. * @since 8.0.1
  335. */
  336. pointAnnotationsDescription: '{Annotation: #each(annotations). }'
  337. }
  338. }
  339. };
  340. export default langOptions;