org.moxieapps.gwt.highcharts.client

Class Global

java.lang.Object

org.moxieapps.gwt.highcharts.client.Configurable<Global>

org.moxieapps.gwt.highcharts.client.Global

public class Global
extends Configurable<Global>

A configurable class that can be used to globally configure options for Highcharts. These options should be configured prior to the initialization of any chart instance.

Example usage:

   Highcharts.setOptions(
     new Highcharts.Options().setGlobal(
         new Global()
           .setUseUTC(false)
   ));
 

Since:

1.4.0

Author:

myersj@gmail.com (Jeff Myers)

Constructor Summary

Constructors

Constructor and Description
Global()

Method Summary

Methods

Modifier and Type	Method and Description
Global	setCanvasToolsURL(String canvasToolsURL) Convenience method for setting the 'canvasToolsURL' global option.
Global	setUseUTC(boolean useUTC) Convenience method for setting the 'useUTC' global 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

Global

public Global()

Method Detail

setCanvasToolsURL

public Global setCanvasToolsURL(String canvasToolsURL)

Convenience method for setting the 'canvasToolsURL' global option. Equivalent to:

     global.setOption("canvasToolsURL", "http://localhost/js/canvas-tools.js");
 

The URL to the additional file to lazy load for Android 2.x devices. These devices don't support SVG, so we download a helper file that contains canvg, its dependency rbcolor, and our own CanVG Renderer class. To avoid hot linking to the highcharts web site, you can install canvas-tools.js on your own server and change this option accordingly. Defaults to "http://www.highcharts.com/js/canvas-tools.js".

Parameters:

canvasToolsURL - URL of the canvas tools library

Returns:

A reference to this Global instance for convenient method chaining.

setUseUTC

public Global setUseUTC(boolean useUTC)

Convenience method for setting the 'useUTC' global option. Equivalent to:

     global.setOption("useUTC", false);
 

Whether to use UTC time for axis scaling, tickmark placement and time display in Highcharts.dateFormat. Advantages of using UTC is that the time displays equally regardless of the user agent's time zone settings. Local time can be used when the data is loaded in real time or when correct Daylight Saving Time transitions are required. Defaults to true.

Parameters:

useUTC - Flag to indicate whether time displays using UTC or not

Returns:

A reference to this Global instance for convenient method chaining.