com.vaadin.flow.component.charts.model

Class Drilldown

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Drilldown

All Implemented Interfaces:

Serializable

public class Drilldown
extends AbstractConfigurationObject

Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items like columns or pie slices.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Drilldown()

Method Summary

Modifier and Type	Method and Description
Style	getActiveAxisLabelStyle()
Style	getActiveDataLabelStyle()
Boolean	getAllowPointDrilldown()
Boolean	getAnimation()
Configuration	getConfiguration()
DrillUpButton	getDrillUpButton()
void	setActiveAxisLabelStyle(Style activeAxisLabelStyle) Additional styles to apply to the X axis label for a point that has drilldown data.
void	setActiveDataLabelStyle(Style activeDataLabelStyle) Additional styles to apply to the data label of a point that has drilldown data.
void	setAllowPointDrilldown(Boolean allowPointDrilldown) When this option is false, clicking a single point will drill down all points in the same category, equivalent to clicking the X axis label.
void	setAnimation(Boolean animation) Set the animation for all drilldown animations.
void	setConfiguration(Configuration configuration) Sets the configuration linked to the drilldown series.
void	setDrillUpButton(DrillUpButton drillUpButton) Options for the drill up button that appears when drilling down on a series.

Methods inherited from class java.lang.Object

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

Constructor Detail

Drilldown

public Drilldown()

Method Detail

setConfiguration

public void setConfiguration(Configuration configuration)

Sets the configuration linked to the drilldown series.

Parameters:

configuration -

getConfiguration

public Configuration getConfiguration()

Returns:

the Configuration that this series is linked to.

See Also:

setConfiguration(Configuration)

getActiveAxisLabelStyle

public Style getActiveAxisLabelStyle()

Returns:

See Also:

setActiveAxisLabelStyle(Style)

setActiveAxisLabelStyle

public void setActiveAxisLabelStyle(Style activeAxisLabelStyle)

Additional styles to apply to the X axis label for a point that has drilldown data.

Parameters:

activeAxisLabelStyle -

getActiveDataLabelStyle

public Style getActiveDataLabelStyle()

Returns:

See Also:

setActiveDataLabelStyle(Style)

setActiveDataLabelStyle

public void setActiveDataLabelStyle(Style activeDataLabelStyle)

Additional styles to apply to the data label of a point that has drilldown data.

Parameters:

activeDataLabelStyle -

getAnimation

public Boolean getAnimation()

Returns:

true if animation is enabled false otherwse.

setAnimation

public void setAnimation(Boolean animation)

Set the animation for all drilldown animations. Animation of a drilldown occurs when drilling between a column point and a column series, or a pie slice and a full pie series. Drilldown can still be used between series and points of different types, but animation will not occur.

Parameters:

animation -

getDrillUpButton

public DrillUpButton getDrillUpButton()

Returns:

See Also:

setDrillUpButton(DrillUpButton)

setDrillUpButton

public void setDrillUpButton(DrillUpButton drillUpButton)

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).

Parameters:

drillUpButton -

getAllowPointDrilldown

public Boolean getAllowPointDrilldown()

See Also:

setAllowPointDrilldown(Boolean)

setAllowPointDrilldown

public void setAllowPointDrilldown(Boolean allowPointDrilldown)

When this option is false, clicking a single point will drill down all points in the same category, equivalent to clicking the X axis label.

Defaults to: true