|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.moxieapps.gwt.highcharts.client.Configurable<Lang>
org.moxieapps.gwt.highcharts.client.Lang
public class Lang
A configurable class that can be used to globally configure the messages displayed by Highcharts. These options should be configured prior to the initialization of any chart instance.
Example usage:
Highcharts.setOptions(
new Highcharts.Options().setLang(
new Lang()
.setMonths(new String[] { 'Janvier', 'Février', 'Mars', 'Avril', 'Mai', 'Juin',
'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 'Décembre' })
.setWeekdays(new String[] {'Dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi'})
));
Constructor Summary | |
---|---|
Lang()
|
Method Summary | |
---|---|
Lang |
setDecimalPoint(String decimalPoint)
Convenience method for setting the 'decimalPoint' lang option. |
Lang |
setDownloadJPEG(String downloadJPEG)
Convenience method for setting the 'downloadJPEG' lang option. |
Lang |
setDownloadPDF(String downloadPDF)
Convenience method for setting the 'downloadPDF' lang option. |
Lang |
setDownloadPNG(String downloadPNG)
Convenience method for setting the 'downloadPNG' lang option. |
Lang |
setDownloadSVG(String downloadSVG)
Convenience method for setting the 'downloadSVG' lang option. |
Lang |
setExportButtonTitle(String exportButtonTitle)
Convenience method for setting the 'exportButtonTitle' lang option. |
Lang |
setLoading(String loading)
Convenience method for setting the 'loading' lang option. |
Lang |
setMonths(String[] months)
Convenience method for setting the 'months' lang option. |
Lang |
setNoData(String noData)
Convenience method for setting the 'noData' option of the chart. |
Lang |
setPrintButtonTitle(String printButtonTitle)
Convenience method for setting the 'printButtonTitle' lang option. |
Lang |
setRangeSelectorFrom(String rangeSelectorFrom)
Convenience method for setting the 'rangeSelectorFrom' lang option. |
Lang |
setRangeSelectorTo(String rangeSelectorTo)
Convenience method for setting the 'rangeSelectorTo' lang option. |
Lang |
setRangeSelectorZoom(String rangeSelectorZoom)
Convenience method for setting the 'rangeSelectorZoom' lang option. |
Lang |
setResetZoom(String resetZoom)
Convenience method for setting the 'resetZoom' lang option. |
Lang |
setResetZoomTitle(String resetZoomTitle)
Convenience method for setting the 'resetZoomTitle' lang option. |
Lang |
setShortMonths(String[] shortMonths)
Convenience method for setting the 'shortMonths' lang option. |
Lang |
setThousandsSep(String thousandsSep)
Convenience method for setting the 'thousandsSep' lang option. |
Lang |
setWeekdays(String[] weekdays)
Convenience method for setting the 'weekdays' lang option. |
Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable |
---|
getOptions, setOption |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Lang()
Method Detail |
---|
public Lang setDecimalPoint(String decimalPoint)
lang.setOption("decimalPoint", ",");
The default decimal point used in the Highcharts.numberFormat method unless otherwise
specified in the function arguments. Defaults to ".".
decimalPoint
- value to used as the decimal point by default when formatting numbers
Lang
instance for convenient method chaining.public Lang setDownloadPNG(String downloadPNG)
lang.setOption("downloadPNG", "PNG");
Exporting module only. The text for the PNG download menu item. Defaults to "Download PNG image".
downloadPNG
- text for the PNG download menu item
Lang
instance for convenient method chaining.public Lang setDownloadJPEG(String downloadJPEG)
lang.setOption("downloadJPEG", "JPEG");
Exporting module only. The text for the JPEG download menu item. Defaults to "Download JPEG image".
downloadJPEG
- text for the JPEG download menu item
Lang
instance for convenient method chaining.public Lang setDownloadPDF(String downloadPDF)
lang.setOption("downloadPDF", "PDF");
Exporting module only. The text for the PDF download menu item. Defaults to "Download PDF document".
downloadPDF
- text for the PDF download menu item
Lang
instance for convenient method chaining.public Lang setDownloadSVG(String downloadSVG)
lang.setOption("downloadSVG", "SVG");
Exporting module only. The text for the SVG download menu item. Defaults to "Download SVG vector image".
downloadSVG
- text for the SVG download menu item
Lang
instance for convenient method chaining.public Lang setExportButtonTitle(String exportButtonTitle)
lang.setOption("exportButtonTitle", "Export");
Exporting module only. The tooltip text for the export button. Defaults to "Export to raster or vector image".
exportButtonTitle
- tooltip text for the export button
Lang
instance for convenient method chaining.public Lang setLoading(String loading)
lang.setOption("loading", "Loading");
The loading text that appears when the chart is set into the loading state following a
call to chart.showLoading. Defaults to "Loading...".
loading
- loading text message
Lang
instance for convenient method chaining.public Lang setMonths(String[] months)
lang.setOption("months", months);
An array containing the months names. Defaults to ['January', 'February', 'March',
'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'].
months
- array containing the months names
Lang
instance for convenient method chaining.
IllegalArgumentException
- if months param is null or not exactly 12 items.public Lang setNoData(String noData)
lsng.setOption("noData", "no data to display");
The text to display when the chart has no data. Defaults to "No data to display"
noData
- A String representing the message to be shown when a chart has no data
Lang
instance for convenient method chaining.public Lang setShortMonths(String[] shortMonths)
lang.setOption("shortMonths", shortMonths);
An array containing the months names in abbreviated form. Corresponds to the %b
format in Highcharts.dateFormat(). Defaults to ['Jan', 'Feb', 'Mar', 'Apr', 'May',
'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'].
shortMonths
- array containing the months names in abbreviated form
Lang
instance for convenient method chaining.
IllegalArgumentException
- if shortMonths param is null or not exactly 12 items.public Lang setPrintButtonTitle(String printButtonTitle)
lang.setOption("printButtonTitle", "Print");
Exporting module only. The tooltip text for the print button. Defaults to "Print the chart".
printButtonTitle
- tooltip text for the print button
Lang
instance for convenient method chaining.public Lang setRangeSelectorFrom(String rangeSelectorFrom)
lang.setOption("rangeSelectorFrom", "Start");
StockChart only. The text for the label for the "from" input box in the range selector.
Defaults to "From".
rangeSelectorFrom
- text for the label for the "from" input box
Lang
instance for convenient method chaining.public Lang setRangeSelectorTo(String rangeSelectorTo)
lang.setOption("rangeSelectorTo", "End");
StockChart only. The text for the label for the "to" input box in the range selector.
Defaults to "To".
rangeSelectorTo
- text for the label for the "to" input box
Lang
instance for convenient method chaining.public Lang setRangeSelectorZoom(String rangeSelectorZoom)
lang.setOption("rangeSelectorZoom", "zoom");
StockChart only. The text for the label for the range selector buttons. Defaults to "Zoom".
rangeSelectorZoom
- text for the label for the range selector buttons
Lang
instance for convenient method chaining.public Lang setResetZoom(String resetZoom)
lang.setOption("resetZoom", "Reset");
The text for the label appearing when a chart is zoomed. Defaults to "Reset zoom".
resetZoom
- text for the label appearing when a chart is zoomed
Lang
instance for convenient method chaining.public Lang setResetZoomTitle(String resetZoomTitle)
lang.setOption("resetZoomTitle", "Reset");
The tooltip title for the label appearing when a chart is zoomed. Defaults to "Reset zoom level 1:1."
resetZoomTitle
- tooltip title for the label appearing when a chart is zoomed
Lang
instance for convenient method chaining.public Lang setThousandsSep(String thousandsSep)
lang.setOption("thousandsSep", ".");
The default thousands separator used in the Highcharts.numberFormat method unless
otherwise specified in the function arguments. Defaults to ",".
thousandsSep
- value to used as the thousands separator by default when formatting numbers
Lang
instance for convenient method chaining.public Lang setWeekdays(String[] weekdays)
lang.setOption("weekdays", weekdays);
An array containing the weekday names. Defaults to ['Sunday', 'Monday', 'Tuesday',
'Wednesday', 'Thursday', 'Friday', 'Saturday'].
weekdays
- array containing the weekday names
Lang
instance for convenient method chaining.
IllegalArgumentException
- if weekdays param is null or not exactly 7 items.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |