Package com.vaadin.componentfactory.maps.model

Class ResetZoomButton

java.lang.Object

com.vaadin.componentfactory.maps.model.AbstractConfigurationObject

com.vaadin.componentfactory.maps.model.ResetZoomButton

All Implemented Interfaces:

Serializable

@Generated(value="This class was generated",
           comments="Incorrect and missing API should be reported")
public class ResetZoomButton
extends AbstractConfigurationObject

The button that appears after a selection zoom, allowing the user to reset zoom. In Highmaps, the reset zoom button is rarely used, as the controls for mapNavigation are used instead.

For live demos, see the resetZoomButton options for basic Highcharts.

Version:

$Id: $Id

Author:

Vaadin

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResetZoomButton()	Constructor for ResetZoomButton.

Method Summary

Modifier and Type	Method	Description
Position	getPosition()	Getter for the field position.
ResetZoomButtonRelativeTo	getRelativeTo()	Getter for the field relativeTo.
ButtonTheme	getTheme()	Getter for the field theme.
void	setPosition(Position position)	The position of the button.
void	setRelativeTo(ResetZoomButtonRelativeTo relativeTo)	What frame the button should be placed related to.
void	setTheme(ButtonTheme theme)	A collection of attributes for the button.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResetZoomButton

public ResetZoomButton()

Constructor for ResetZoomButton.

Method Details

getPosition

public Position getPosition()

Getter for the field position.

Returns:

a Position object.

See Also:

• setPosition(Position)

setPosition

public void setPosition(Position position)

The position of the button. This is an object that can hold the properties align, verticalAlign, x and y.

Parameters:

position - a Position object.

getRelativeTo

public ResetZoomButtonRelativeTo getRelativeTo()

Getter for the field relativeTo.

Returns:

a ResetZoomButtonRelativeTo object.

See Also:

• setRelativeTo(ResetZoomButtonRelativeTo)

setRelativeTo

public void setRelativeTo(ResetZoomButtonRelativeTo relativeTo)

What frame the button should be placed related to. Can be either "plot" or "chart".

Defaults to: plot

Parameters:

relativeTo - a ResetZoomButtonRelativeTo object.

getTheme

public ButtonTheme getTheme()

Getter for the field theme.

Returns:

a ButtonTheme object.

See Also:

• setTheme(ButtonTheme)

setTheme

public void setTheme(ButtonTheme theme)

A collection of attributes for the button. The object takes SVG attributes like fill, stroke, stroke-width or r, the border radius. The theme also supports style, a collection of CSS properties for the text. Equivalent attributes for the hover state are given in theme.states.hover.

Parameters:

theme - a ButtonTheme object.