org.moxieapps.gwt.highcharts.client

Class Navigation

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.Navigation

public class Navigation
extends Configurable<Navigation>

A configurable class that will allow you to control the options for buttons and menus appearing in the exporting module. An instance of this class can be constructed and then set on the chart via the BaseChart.setNavigation(Navigation) method.

Note that the "exporting" module must be included in the page in order for the exporting navigation options to apply. E.g.:

<script type="text/javascript" src="js/modules/exporting.js"></script>

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

Constructors

Constructor and Description
Navigation()

Method Summary

Methods

Modifier and Type	Method and Description
Navigation	setButtonOptions(Button button) Convenience method for setting the "buttonOptions" for the export button.
Navigation	setMenuItemHoverStyle(Style menuItemHoverStyle) Convenience method for setting the 'menuItemHoverStyle' options of the navigation area.
Navigation	setMenuItemStyle(Style menuItemStyle) Convenience method for setting the 'menuItemStyle' options of the navigation area.
Navigation	setMenuStyle(Style menuStyle) Convenience method for setting the 'menuStyle' options of the navigation area.

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

Navigation

public Navigation()

Method Detail

setMenuStyle

public Navigation setMenuStyle(Style menuStyle)

Convenience method for setting the 'menuStyle' options of the navigation area. Equivalent to:

     navigation.setOption("/menuStyle/left", "100px");
     navigation.setOption("/menuStyle/top", "10px");
     etc.
 

CSS styles for the popup menu appearing by default when the export icon is clicked. This menu is rendered in HTML. Default options for the "menuStyle" are as follows:

• border: '1px solid #A0A0A0'
• background: '#FFFFFF

Parameters:

menuStyle - CSS styles for the popup menus of the exporting module

Returns:

A reference to this Navigation instance for convenient method chaining.

setMenuItemStyle

public Navigation setMenuItemStyle(Style menuItemStyle)

Convenience method for setting the 'menuItemStyle' options of the navigation area. Equivalent to:

     navigation.setOption("/menuItemStyle/left", "100px");
     navigation.setOption("/menuItemStyle/top", "10px");
     etc.
 

CSS styles for the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML. Default options for the "menuItemStyle" are as follows:

• padding: '0 5px'
• background: NONE
• color: '#303030'

Parameters:

menuItemStyle - CSS styles for the individual items in the popup menus of the exporting module.

Returns:

A reference to this Navigation instance for convenient method chaining.

setMenuItemHoverStyle

public Navigation setMenuItemHoverStyle(Style menuItemHoverStyle)

Convenience method for setting the 'menuItemHoverStyle' options of the navigation area. Equivalent to:

     navigation.setOption("/menuItemHoverStyle/left", "100px");
     navigation.setOption("/menuItemHoverStyle/top", "10px");
     etc.
 

CSS styles for the hover state of the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML. Default options for the "menuItemHoverStyle" are as follows:

• background: '#4572A5'
• color: '#FFFFFF'

Parameters:

menuItemHoverStyle - CSS styles for the hover style of the individual items in the popup menus of the exporting module.

Returns:

A reference to this Navigation instance for convenient method chaining.

setButtonOptions

public Navigation setButtonOptions(Button button)

Convenience method for setting the "buttonOptions" for the export button. Sample usage:

     chart.setNavigation(
         new Navigation()
             .setButtonOptions(
                 new Button()
                     .setAlign(Button.Align.RIGHT)
                     .setSymbolFill("#E0E0E0")
             )
     );
 

Parameters:

button - The export button with options set using methods in Button.

Returns:

A reference to this Navigation instance for convenient method chaining.

Since:

1.6.0