com.vaadin.flow.component.charts.model

Class Pane

java.lang.Object

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

com.vaadin.flow.component.charts.model.Pane

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 Pane
extends AbstractConfigurationObject

Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pane()
Pane(Number startAngle, Number endAngle)

Method Summary

Modifier and Type	Method and Description
void	addBackground(Background background) Adds background to the background array
Background[]	getBackground()
String[]	getCenter()
Number	getEndAngle()
String	getSize()
Number	getStartAngle()
void	removeBackground(Background background) Removes first occurrence of background in background array
void	setBackground(Background... background) An object, or array of objects, for backgrounds.
void	setCenter(String[] center) The center of a polar chart or angular gauge, given as an array of [x, y] positions.
void	setCenter(String x, String y)
void	setEndAngle(Number endAngle) The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.
void	setSize(String size) The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
void	setStartAngle(Number startAngle) The start angle of the polar X axis or gauge axis, given in degrees where 0 is north.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pane

public Pane()

Pane

public Pane(Number startAngle,
            Number endAngle)

Method Detail

getBackground

public Background[] getBackground()

See Also:

setBackground(Background...)

setBackground

public void setBackground(Background... background)

An object, or array of objects, for backgrounds.

addBackground

public void addBackground(Background background)

Adds background to the background array

Parameters:

background - to add

See Also:

setBackground(Background...)

removeBackground

public void removeBackground(Background background)

Removes first occurrence of background in background array

Parameters:

background - to remove

See Also:

setBackground(Background...)

setCenter

public void setCenter(String[] center)

The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.

Defaults to: ["50%", "50%"]

getEndAngle

public Number getEndAngle()

See Also:

setEndAngle(Number)

setEndAngle

public void setEndAngle(Number endAngle)

The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360.

getSize

public String getSize()

See Also:

setSize(String)

setSize

public void setSize(String size)

The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.

Defaults to: 85%

getStartAngle

public Number getStartAngle()

See Also:

setStartAngle(Number)

setStartAngle

public void setStartAngle(Number startAngle)

The start angle of the polar X axis or gauge axis, given in degrees where 0 is north. Defaults to 0.

setCenter

public void setCenter(String x,
                      String y)

getCenter

public String[] getCenter()