com.vaadin.flow.component.charts.model

Class Options3d

java.lang.Object

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

com.vaadin.flow.component.charts.model.Options3d

All Implemented Interfaces:

Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Options3d
extends AbstractConfigurationObject

Options to render charts in 3 dimensions. This feature requires highcharts-3d.js, found in the download package or online at code.highcharts.com/ highcharts-3d.js.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AXIS_LABEL_POSITION_AUTO

Constructor Summary

Constructors

Constructor and Description
Options3d()
Options3d(Boolean enabled)

Method Summary

Modifier and Type	Method and Description
Number	getAlpha()
String	getAxisLabelPosition()
Number	getBeta()
Number	getDepth()
Boolean	getEnabled()
Boolean	getFitToPlot()
Frame	getFrame()
Number	getViewDistance()
void	setAlpha(Number alpha) One of the two rotation angles for the chart.
void	setAxisLabelPosition(String axisLabelPosition) Set it to "auto" to automatically move the labels to the best edge.
void	setBeta(Number beta) One of the two rotation angles for the chart.
void	setDepth(Number depth) The total depth of the chart.
void	setEnabled(Boolean enabled) Wether to render the chart using the 3D functionality.
void	setFitToPlot(Boolean fitToPlot) Whether the 3d box should automatically adjust to the chart plot area.
void	setFrame(Frame frame) Provides the option to draw a frame around the charts by defining a bottom, front and back panel.
void	setViewDistance(Number viewDistance) Defines the distance the viewer is standing in front of the chart, this setting is important to calculate the perspective effect in column and scatter charts.

Methods inherited from class java.lang.Object

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

Field Detail

AXIS_LABEL_POSITION_AUTO

public static final String AXIS_LABEL_POSITION_AUTO

See Also:

Constant Field Values

Constructor Detail

Options3d

public Options3d()

Options3d

public Options3d(Boolean enabled)

Method Detail

getAlpha

public Number getAlpha()

See Also:

setAlpha(Number)

setAlpha

public void setAlpha(Number alpha)

One of the two rotation angles for the chart.

Defaults to: 0

getAxisLabelPosition

public String getAxisLabelPosition()

See Also:

setAxisLabelPosition(String)

setAxisLabelPosition

public void setAxisLabelPosition(String axisLabelPosition)

Set it to "auto" to automatically move the labels to the best edge.

Defaults to: null

getBeta

public Number getBeta()

See Also:

setBeta(Number)

setBeta

public void setBeta(Number beta)

One of the two rotation angles for the chart.

Defaults to: 0

getDepth

public Number getDepth()

See Also:

setDepth(Number)

setDepth

public void setDepth(Number depth)

The total depth of the chart.

Defaults to: 100

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Wether to render the chart using the 3D functionality.

Defaults to: false

getFitToPlot

public Boolean getFitToPlot()

See Also:

setFitToPlot(Boolean)

setFitToPlot

public void setFitToPlot(Boolean fitToPlot)

Whether the 3d box should automatically adjust to the chart plot area.

Defaults to: true

getFrame

public Frame getFrame()

See Also:

setFrame(Frame)

setFrame

public void setFrame(Frame frame)

Provides the option to draw a frame around the charts by defining a bottom, front and back panel.

getViewDistance

public Number getViewDistance()

See Also:

setViewDistance(Number)

setViewDistance

public void setViewDistance(Number viewDistance)

Defines the distance the viewer is standing in front of the chart, this setting is important to calculate the perspective effect in column and scatter charts. It is not used for 3D pie charts.

Defaults to: 100