org.pepstock.charba.client.defaults.global

Class Line

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.global.Arc

org.pepstock.charba.client.defaults.global.Line

public final class Line
extends Arc

Line elements are used to represent the line in a line chart.
While chart types provide settings to configure the styling of each dataset, you sometimes want to style all datasets the same way.
Options can be configured for four different types of elements: arc, lines, points, and rectangles.
When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
CapStyle	getBorderCapStyle() Returns how the end points of every line are drawn.
java.util.List<java.lang.Integer>	getBorderDash() Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
int	getBorderDashOffset() Returns the line dash pattern offset or "phase".
JoinStyle	getBorderJoinStyle() Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified endpoints and control points are exactly at the same position, are skipped). There are three possible values for this property: round, bevel and miter.
protected java.lang.String	getDefaultBackgroundColor() Returns the default background color.
protected java.lang.String	getDefaultBorderColor() Returns the default border color.
protected int	getDefaultBorderWidth() Returns the default border width.
Fill	getFill() Returns how to fill the area under the line.
double	getTension() Returns the Bezier curve tension (0 for no Bezier curves).
boolean	isCapBezierPoints() Returns true to keep Bezier control inside the chart, false for no restriction.
boolean	isStepped() Returns true to show the line as a stepped line (tension will be ignored).
void	setBorderCapStyle(CapStyle borderCapStyle) Sets how the end points of every line are drawn.
void	setBorderDash(int... borderDash) Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
void	setBorderDashOffset(int borderDashOffset) Sets the line dash pattern offset or "phase".
void	setBorderJoinStyle(JoinStyle borderJoinStyle) Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified endpoints and control points are exactly at the same position, are skipped). There are three possible values for this property: round, bevel and miter.
void	setCapBezierPoints(boolean capBezierPoints) Sets true to keep Bezier control inside the chart, false for no restriction.
void	setFill(boolean fill) Sets how to fill the area under the line.
void	setFill(Fill fill) Sets how to fill the area under the line.
void	setStepped(boolean stepped) Sets true to show the line as a stepped line (tension will be ignored).
void	setTension(double tension) Returns the Bezier curve tension (0 for no Bezier curves).

Methods inherited from class org.pepstock.charba.client.defaults.global.Arc

getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getBorderWidth, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderWidth

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultBackgroundColor

protected java.lang.String getDefaultBackgroundColor()

Description copied from class: Arc

Returns the default background color.

Overrides:

getDefaultBackgroundColor in class Arc

Returns:

the default background color.

getDefaultBorderWidth

protected int getDefaultBorderWidth()

Description copied from class: Arc

Returns the default border width.

Overrides:

getDefaultBorderWidth in class Arc

Returns:

the default border width.

getDefaultBorderColor

protected java.lang.String getDefaultBorderColor()

Description copied from class: Arc

Returns the default border color.

Overrides:

getDefaultBorderColor in class Arc

Returns:

the default border color.

setTension

public void setTension(double tension)

Returns the Bezier curve tension (0 for no Bezier curves).

Parameters:

tension - the Bezier curve tension (0 for no Bezier curves).

getTension

public double getTension()

Returns the Bezier curve tension (0 for no Bezier curves).

Returns:

the Bezier curve tension (0 for no Bezier curves). Default is 0.4F.

setBorderCapStyle

public void setBorderCapStyle(CapStyle borderCapStyle)

Sets how the end points of every line are drawn. There are three possible values for this property and those are: butt, round and square.

Parameters:

borderCapStyle - how the end points of every line are drawn.

See Also:

CapStyle

getBorderCapStyle

public CapStyle getBorderCapStyle()

Returns how the end points of every line are drawn. There are three possible values for this property and those are: butt, round and square. By default this property is set to butt.

Returns:

how the end points of every line are drawn. Default is CapStyle.butt.

See Also:

CapStyle

setBorderDash

public void setBorderDash(int... borderDash)

Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Parameters:

borderDash - the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

getBorderDash

public java.util.List<java.lang.Integer> getBorderDash()

Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Returns:

the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

setBorderDashOffset

public void setBorderDashOffset(int borderDashOffset)

Sets the line dash pattern offset or "phase".

Parameters:

borderDashOffset - the line dash pattern offset or "phase".

getBorderDashOffset

public int getBorderDashOffset()

Returns the line dash pattern offset or "phase".

Returns:

the line dash pattern offset or "phase". Default is 0.

setBorderJoinStyle

public void setBorderJoinStyle(JoinStyle borderJoinStyle)

Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified endpoints and control points are exactly at the same position, are skipped).
There are three possible values for this property: round, bevel and miter. By default this property is set to miter.

Parameters:

borderJoinStyle - There are three possible values for this property: round, bevel and miter. By default this property is set to miter.

See Also:

JoinStyle

getBorderJoinStyle

public JoinStyle getBorderJoinStyle()

Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified endpoints and control points are exactly at the same position, are skipped).
There are three possible values for this property: round, bevel and miter. By default this property is set to miter.

Returns:

There are three possible values for this property: round, bevel and miter. By default this property is set to miter. Default is JoinStyle.miter.

See Also:

JoinStyle

setCapBezierPoints

public void setCapBezierPoints(boolean capBezierPoints)

Sets true to keep Bezier control inside the chart, false for no restriction.

Parameters:

capBezierPoints - true to keep Bezier control inside the chart, false for no restriction.

isCapBezierPoints

public boolean isCapBezierPoints()

Returns true to keep Bezier control inside the chart, false for no restriction.

Returns:

true to keep Bezier control inside the chart, false for no restriction. Default is true.

setFill

public void setFill(boolean fill)

Sets how to fill the area under the line.

Parameters:

fill - how to fill the area under the line.

setFill

public void setFill(Fill fill)

Sets how to fill the area under the line.

Parameters:

fill - how to fill the area under the line.

See Also:

Fill

getFill

public Fill getFill()

Returns how to fill the area under the line.

Returns:

how to fill the area under the line. Default is Fill.origin.

See Also:

Fill

setStepped

public void setStepped(boolean stepped)

Sets true to show the line as a stepped line (tension will be ignored).

Parameters:

stepped - true to show the line as a stepped line (tension will be ignored).

isStepped

public boolean isStepped()

Returns true to show the line as a stepped line (tension will be ignored).

Returns:

true to show the line as a stepped line (tension will be ignored). Default is false.