Package com.vaadin.componentfactory.maps.model

Class DrillUpButton

java.lang.Object

com.vaadin.componentfactory.maps.model.AbstractConfigurationObject

com.vaadin.componentfactory.maps.model.DrillUpButton

All Implemented Interfaces:

Serializable

public class DrillUpButton
extends AbstractConfigurationObject

Options for the drill up button that appears when drilling down on a series. The text for the button is defined in Lang.setDrillUpText(String).

Since Highcharts 10 this navigation is rendered by the breadcrumbs module, so these options are forwarded to it. By default a single button back to the previous level is rendered, which is how this button has always looked; see setShowFullPath(Boolean) to render the whole drilldown path instead.

Version:

$Id: $Id

Author:

Vaadin

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DrillUpButton()

Method Summary

Modifier and Type	Method	Description
ButtonPosition	getPosition()	Getter for the field position.
DrillUpButtonRelativeTo	getRelativeTo()	Getter for the field relativeTo.
Boolean	getShowFullPath()	Getter for the field showFullPath.
ButtonTheme	getTheme()	Getter for the field theme.
void	setPosition(ButtonPosition position)	Positioning options for the button within the setRelativeTo(DrillUpButtonRelativeTo) box.
void	setRelativeTo(DrillUpButtonRelativeTo relativeTo)	What box to align the button to.
void	setShowFullPath(Boolean showFullPath)	When true, the whole drilldown path is rendered as a list of buttons instead of a single button back to the previous level.
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

DrillUpButton

public DrillUpButton()

Method Details

getPosition

public ButtonPosition getPosition()

Getter for the field position.

Returns:

position

See Also:

• setPosition(ButtonPosition)

setPosition

public void setPosition(ButtonPosition position)

Positioning options for the button within the setRelativeTo(DrillUpButtonRelativeTo) box.

Parameters:

position - a ButtonPosition object.

getRelativeTo

public DrillUpButtonRelativeTo getRelativeTo()

Getter for the field relativeTo.

Returns:

relativeTo

See Also:

• setRelativeTo(DrillUpButtonRelativeTo)

setRelativeTo

public void setRelativeTo(DrillUpButtonRelativeTo relativeTo)

What box to align the button to. Can be either DrillUpButtonRelativeTo.PLOTBOX or DrillUpButtonRelativeTo.SPACINGBOX. Defaults to DrillUpButtonRelativeTo.PLOTBOX

Parameters:

relativeTo - a DrillUpButtonRelativeTo object.

getTheme

public ButtonTheme getTheme()

Getter for the field theme.

Returns:

theme

See Also:

• setTheme(ButtonTheme)

setTheme

public void setTheme(ButtonTheme theme)

A collection of attributes for the button.

Parameters:

theme - a ButtonTheme object.

getShowFullPath

public Boolean getShowFullPath()

Getter for the field showFullPath.

Returns:

showFullPath

See Also:

• setShowFullPath(Boolean)

setShowFullPath

public void setShowFullPath(Boolean showFullPath)

When true, the whole drilldown path is rendered as a list of buttons instead of a single button back to the previous level. Requires Highcharts 10 or later, where this navigation is rendered by the breadcrumbs module. Defaults to false.

Parameters:

showFullPath - a Boolean object.