org.pepstock.charba.client.options

Class Line

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<Elements,D>

org.pepstock.charba.client.options.AbstractElement<IsDefaultLine>

org.pepstock.charba.client.options.Line

All Implemented Interfaces:

IsDefaultArc, IsDefaultLine

public final class Line
extends AbstractElement<IsDefaultLine>
implements IsDefaultLine

Line elements are used to represent the line in a line chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
CapStyle	getBorderCapStyle() Returns how the end points of every line are drawn.
List<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 end points and control points are exactly at the same position, are skipped). There are three possible values for this property: round, bevel and miter.
IsFill	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 end points 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(int index) Sets how to fill the area under the line, by absolute dataset index.
void	setFill(IsFill fill) Sets how to fill the area under the line.
void	setFill(String index) Sets how to fill the area under the line, by relative dataset index.
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.options.AbstractElement

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

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

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

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultArc

getBackgroundColorAsString, getBorderColorAsString, getBorderWidth

Method Detail

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).

Specified by:

getTension in interface IsDefaultLine

Returns:

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

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.

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.

Specified by:

getBorderCapStyle in interface IsDefaultLine

Returns:

how the end points of every line are drawn.

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 List<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".

Specified by:

getBorderDashOffset in interface IsDefaultLine

Returns:

the line dash pattern offset or "phase".

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 end points 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.

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 end points 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.

Specified by:

getBorderJoinStyle in interface IsDefaultLine

Returns:

there are three possible values for this property: round, bevel and miter.

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.

Specified by:

isCapBezierPoints in interface IsDefaultLine

Returns:

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

setFill

public void setFill(boolean fill)

Sets how to fill the area under the line.

Parameters:

fill - true to fill, otherwise false.

setFill

public void setFill(int index)

Sets how to fill the area under the line, by absolute dataset index.

Parameters:

index - absolute dataset index of the chart.

setFill

public void setFill(String index)

Sets how to fill the area under the line, by relative dataset index.

Parameters:

index - relative dataset index of the chart.

setFill

public void setFill(IsFill fill)

Sets how to fill the area under the line.

Parameters:

fill - how to fill the area under the line.

getFill

public IsFill getFill()

Returns how to fill the area under the line.

Specified by:

getFill in interface IsDefaultLine

Returns:

how to fill the area under the line.

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).

Specified by:

isStepped in interface IsDefaultLine

Returns:

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