Class ElementsLine
java.lang.Object
org.primefaces.model.charts.optionconfig.elements.ElementsLine
- All Implemented Interfaces:
Serializable
Line elements are used to represent the line in a line chart.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionencode()
Write the line options of ElementsGets the backgroundColorGets the borderCapStyleGets the borderColorGets the borderDashGets the borderDashOffsetGets the borderJoinStyleGets the borderWidthgetFill()
Gets the fillGets the tensionboolean
Gets the capBezierPointsboolean
Gets the steppedvoid
setBackgroundColor
(String backgroundColor) Sets the backgroundColorvoid
setBorderCapStyle
(String borderCapStyle) Sets the borderCapStylevoid
setBorderColor
(String borderColor) Sets the borderColorvoid
setBorderDash
(List<Number> borderDash) Sets the borderDashvoid
setBorderDashOffset
(Number borderDashOffset) Sets the borderDashOffsetvoid
setBorderJoinStyle
(String borderJoinStyle) Sets the borderJoinStylevoid
setBorderWidth
(Number borderWidth) Sets the borderWidthvoid
setCapBezierPoints
(boolean capBezierPoints) Sets the capBezierPointsvoid
Sets the fillvoid
setStepped
(boolean stepped) Sets the steppedvoid
setTension
(Number tension) Sets the tension
-
Constructor Details
-
ElementsLine
public ElementsLine()
-
-
Method Details
-
getTension
Gets the tension- Returns:
- tension
-
setTension
Sets the tension- Parameters:
tension
- Bézier curve tension (0 for no Bézier curves).
-
getBackgroundColor
Gets the backgroundColor- Returns:
- backgroundColor
-
setBackgroundColor
Sets the backgroundColor- Parameters:
backgroundColor
- Line fill color.
-
getBorderWidth
Gets the borderWidth- Returns:
- borderWidth
-
setBorderWidth
Sets the borderWidth- Parameters:
borderWidth
- Line stroke width.
-
getBorderColor
Gets the borderColor- Returns:
- borderColor
-
setBorderColor
Sets the borderColor- Parameters:
borderColor
- Line stroke color.
-
getBorderCapStyle
Gets the borderCapStyle- Returns:
- borderCapStyle
-
setBorderCapStyle
Sets the borderCapStyle- Parameters:
borderCapStyle
- Line cap style.
-
getBorderDash
Gets the borderDash- Returns:
- borderDash
-
setBorderDash
Sets the borderDash- Parameters:
borderDash
- Line dash
-
getBorderDashOffset
Gets the borderDashOffset- Returns:
- borderDashOffset
-
setBorderDashOffset
Sets the borderDashOffset- Parameters:
borderDashOffset
- Line dash offset
-
getBorderJoinStyle
Gets the borderJoinStyle- Returns:
- borderJoinStyle
-
setBorderJoinStyle
Sets the borderJoinStyle- Parameters:
borderJoinStyle
- Line join style.
-
isCapBezierPoints
public boolean isCapBezierPoints()Gets the capBezierPoints- Returns:
- capBezierPoints
-
setCapBezierPoints
public void setCapBezierPoints(boolean capBezierPoints) Sets the capBezierPoints- Parameters:
capBezierPoints
- true to keep Bézier control inside the chart, false for no restriction.
-
getFill
Gets the fill- Returns:
- fill
-
setFill
Sets the fill- Parameters:
fill
- Fill location: 'zero', 'top', 'bottom', true (eq. 'zero') or false (no fill).
-
isStepped
public boolean isStepped()Gets the stepped- Returns:
- stepped
-
setStepped
public void setStepped(boolean stepped) Sets the stepped- Parameters:
stepped
- true to show the line as a stepped line (tension will be ignored).
-
encode
Write the line options of Elements- Returns:
- options as JSON object
- Throws:
IOException
- If an I/O error occurs
-