HighchartsLangOptions class

An object containing language-related strings and settings. A typical setup uses Highcharts.setOptions to make the options apply to all charts in the same page.

API Docs: https://api.highcharts.com/highcharts/lang

Inheritance

Constructors

HighchartsLangOptions.new({HighchartsLangAccessibilityOptions? accessibility, String? chartTitle, String? contextButtonTitle, String? decimalPoint, String? downloadCSV, String? downloadJPEG, String? downloadMIDI, String? downloadPDF, String? downloadPNG, String? downloadSVG, String? downloadXLS, dynamic drillUpText, String? exitFullscreen, HighchartsLangExportDataOptions? exportData, String? exportInProgress, String? hideData, String? invalidDate, String? loading, List<String>? locale, String? mainBreadcrumb, List<String>? months, HighchartsLangNavigationOptions? navigation, String? noData, double? numericSymbolMagnitude, List<String>? numericSymbols, String? pieSliceName, String? playAsSound, String? printChart, HighchartsLangRangeSelectorOptions? rangeSelector, String? rangeSelectorFrom, String? rangeSelectorTo, String? rangeSelectorZoom, String? resetZoom, String? resetZoomTitle, String? seriesName, List<String>? shortMonths, List<String>? shortWeekdays, HighchartsLangStockToolsOptions? stockTools, String? thousandsSep, String? viewData, String? viewFullscreen, String? weekFrom, List<String>? weekdays, String? yAxisTitle, String? zoomIn, String? zoomOut})
An object containing language-related strings and settings. A typical setup uses Highcharts.setOptions to make the options apply to all charts in the same page.

Properties

accessibility ↔ HighchartsLangAccessibilityOptions?
Configure the accessibility strings in the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.
getter/setter pair
chartTitle ↔ String?
The default chart title.
getter/setter pair
contextButtonTitle ↔ String?
Exporting module menu. The tooltip title for the context menu holding print and export menu items.
getter/setter pair
decimalPoint ↔ String?
The default decimal point used in the Highcharts.numberFormat method unless otherwise specified in the function arguments. Defaults to the locale decimal point as determined by lang.locale.
getter/setter pair
downloadCSV ↔ String?
The text for the menu item.
getter/setter pair
downloadJPEG ↔ String?
Exporting module only. The text for the JPEG download menu item.
getter/setter pair
downloadMIDI ↔ String?
The text for the MIDI download menu item in the export menu.
getter/setter pair
downloadPDF ↔ String?
Exporting module only. The text for the PDF download menu item.
getter/setter pair
downloadPNG ↔ String?
Exporting module only. The text for the PNG download menu item.
getter/setter pair
downloadSVG ↔ String?
Exporting module only. The text for the SVG download menu item.
getter/setter pair
downloadXLS ↔ String?
The text for the menu item.
getter/setter pair
drillUpText ↔ dynamic
Drill up button is deprecated since Highcharts v9.3.2. Use drilldown.breadcrumbs instead.
getter/setter pair
exitFullscreen ↔ String?
Exporting module only. The text for the menu item to exit the chart from full screen.
getter/setter pair
exportData ↔ HighchartsLangExportDataOptions?
The text for exported table.
getter/setter pair
exportInProgress ↔ String?
Text to show when export is in progress.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hideData ↔ String?
The text for the menu item.
getter/setter pair
invalidDate ↔ String?
What to show in a date field for invalid dates. Defaults to an empty string.
getter/setter pair
loading ↔ String?
The loading text that appears when the chart is set into the loading state following a call to chart.showLoading.
getter/setter pair
locale ↔ List<String>?
The browser locale to use for date and number formatting. The actual locale used for each chart is determined in three steps:
getter/setter pair
Highcharts Options Widget.
getter/setter pair
months ↔ List<String>?
An array containing the months names. Corresponds to the %B format in Highcharts.dateFormat(). Defaults to 'undefined', meaning the default month names are used according to the lang.locale setting.
getter/setter pair
Configure the Popup strings in the chart. Requires the annotations.js or annotations-advanced.src.js module to be loaded.
getter/setter pair
noData ↔ String?
The text to display when the chart contains no data.
getter/setter pair
numericSymbolMagnitude ↔ double?
The magnitude of numericSymbols replacements. Use 10000 for Japanese, Korean and various Chinese locales, which use symbols for 10^4, 10^8 and 10^12.
getter/setter pair
numericSymbols ↔ List<String>?
Metric prefixes used to shorten high numbers in axis labels. Replacing any of the positions with null causes the full number to be written. Setting numericSymbols to undefined disables shortening altogether.
getter/setter pair
pieSliceName ↔ String?
The default name for a pie slice (point).
getter/setter pair
playAsSound ↔ String?
The text for the Play as sound menu item in the export menu.
getter/setter pair
printChart ↔ String?
Exporting module only. The text for the menu item to print the chart.
getter/setter pair
rangeSelector ↔ HighchartsLangRangeSelectorOptions?
The default text for the rangeselector buttons.
getter/setter pair
rangeSelectorFrom ↔ String?
The text for the label for the "from" input box in the range selector. Since v9.0, this string is empty as the label is not rendered by default.
getter/setter pair
rangeSelectorTo ↔ String?
The text for the label for the "to" input box in the range selector.
getter/setter pair
rangeSelectorZoom ↔ String?
The text for the label for the range selector buttons.
getter/setter pair
resetZoom ↔ String?
The text for the label appearing when a chart is zoomed.
getter/setter pair
resetZoomTitle ↔ String?
Highcharts Options Widget.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seriesName ↔ String?
Format string for the default series name.
getter/setter pair
shortMonths ↔ List<String>?
An array containing the months names in abbreviated form. Corresponds to the %b format in Highcharts.dateFormat(). Defaults to 'undefined', meaning the default short month names are used according to the lang.locale setting.
getter/setter pair
shortWeekdays ↔ List<String>?
Short week days, starting Sunday. Defaults to 'undefined', meaning the default short weekday names are used according to the lang.locale setting.
getter/setter pair
stockTools ↔ HighchartsLangStockToolsOptions?
Configure the stockTools GUI titles(hints) in the chart. Requires the stock-tools.js module to be loaded.
getter/setter pair
thousandsSep ↔ String?
The default thousands separator used in the Highcharts.numberFormat method unless otherwise specified in the function arguments. Defaults to the locale thousands separator as determined by lang.locale.
getter/setter pair
viewData ↔ String?
The text for the menu item.
getter/setter pair
viewFullscreen ↔ String?
Exporting module only. The text for the menu item to view the chart in full screen.
getter/setter pair
weekdays ↔ List<String>?
An array containing the weekday names. Defaults to 'undefined', meaning the default weekday names are used according to the lang.locale setting.
getter/setter pair
weekFrom ↔ String?
Highcharts Options Widget.
getter/setter pair
yAxisTitle ↔ String?
The default title of the Y axis
getter/setter pair
zoomIn ↔ String?
The title appearing on hovering the zoom in button. The text itself defaults to "+" and can be changed in the button options.
getter/setter pair
zoomOut ↔ String?
The title appearing on hovering the zoom out button. The text itself defaults to "-" and can be changed in the button options.
getter/setter pair

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