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:
@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:
-
-
Constructor Summary
Constructors Constructor and Description Pane()
Pane(Number startAngle, Number endAngle)
-
Method Summary
All Methods 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.
-
-
-
Method Detail
-
getBackground
public Background[] getBackground()
See Also:
-
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 addSee Also:
-
removeBackground
public void removeBackground(Background background)
Removes first occurrence of background in background array
Parameters:
background
- to removeSee Also:
-
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
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
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
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.
-
getCenter
public String[] getCenter()
-
-