org.moxieapps.gwt.highcharts.client

Class ContextButton

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.Button<ContextButton>

org.moxieapps.gwt.highcharts.client.ContextButton

public class ContextButton
extends Button<ContextButton>

A configurable class that will allow you to control the export button options of the chart. This configuration object holds general options for the menu items. An instance of this class can be constructed and then set on the pane via the Pane.setBackground(PaneBackground...) method.

Sample usage:

    chart.setExporting(
       new Exporting()
          .setContextButton(
              newContextButton(
                  .setAlign("center")
                  .setX(0)
              )
     );
 

Since:

1.6.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextButton.Symbol An enumeration of supported marker symbol types, which can be passed to methods like setSymbol(ContextButton.Symbol) method.

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.Button

Button.Align, Button.VerticalAlign

Constructor Summary

Constructors

Constructor and Description
ContextButton()

Method Summary

Methods

Modifier and Type	Method and Description
ContextButton	setSymbol(ContextButton.Symbol symbol) Convenience method for setting the "symbol" option for the export button.
ContextButton	setX(Number x) Convenience method for setting the "symbolX" option for the export button.

Methods inherited from class org.moxieapps.gwt.highcharts.client.Button

setAlign, setEnabled, setHeight, setSymbolFill, setSymbolSize, setSymbolStroke, setSymbolStrokeWidth, setSymbolX, setSymbolY, setText, setVerticalAlign, setWidth, setY

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

ContextButton

public ContextButton()

Method Detail

setSymbol

public ContextButton setSymbol(ContextButton.Symbol symbol)

Convenience method for setting the "symbol" option for the export button. Equivalent to:

     contextButton.setOption("symbol", "menu");
 

The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default exportIcon function is part of the exporting module. Defaults to menu.

Parameters:

symbol - The shape to be used for the context button.

Returns:

A reference to this ContextButton instance for convenient method chaining.

setX

public ContextButton setX(Number x)

Convenience method for setting the "symbolX" option for the export button. Equivalent to:

     contextButton.setOption("symbolX", 12.5)
 

The x position of the center of the symbol inside the button. Defaults to 12.5.

Parameters:

x - The distance n pixels from the left edge of the export button

Returns:

A reference to this ContextButton instance for convenient method chaining.