Line (Charba - J2CL and GWT charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.AbstractElement<IsDefaultLine>
  - - org.pepstock.charba.client.options.Line

All Implemented Interfaces:

IsDefaultLine, IsDefaultOptionsElement, HasFill
```
public final class Line
extends AbstractElement<IsDefaultLine>
implements IsDefaultLine, HasFill
```
Line elements are used to represent the line in a line chart.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`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.
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`CubicInterpolationMode`	`getCubicInterpolationMode()` Returns algorithm used to interpolate a smooth curve from the discrete data points.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`IsFill`	`getFill()` Returns how to fill the area under the line.
`Filler`	`getFiller()` Returns a filler instance to use into default methods of this interface.
`protected P`	`getParent()` Returns the parent element.
`double`	`getTension()` Returns the Bézier curve tension (0 for no Bézier curves).
`boolean`	`isCapBezierPoints()` Returns `true` to keep Bézier 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.
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`void`	`setCapBezierPoints(boolean capBezierPoints)` Sets `true` to keep Bézier control inside the chart, `false` for no restriction.
`void`	`setCubicInterpolationMode(CubicInterpolationMode mode)` Sets algorithm used to interpolate a smooth curve from the discrete data points. The following interpolation modes are supported:
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`void`	`setFill(boolean fill)` Sets how to fill the area under the line.
`void`	`setFill(IsFill 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 Bézier curve tension (0 for no Bézier 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.commons.NativeObjectContainer
checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, 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.IsDefaultOptionsElement
getBackgroundColorAsString, getBorderColorAsString, getBorderWidth

Methods inherited from interface org.pepstock.charba.client.enums.HasFill
setFill, setFill

- Method Detail
  - getFiller
```
public Filler getFiller()
```
    Description copied from interface: HasFill
    
    Returns a filler instance to use into default methods of this interface.
    
    Specified by:
    
    getFiller in interface HasFill
    
    Returns:
    
    a filler instance
  - setTension
```
public void setTension(double tension)
```
    Returns the Bézier curve tension (0 for no Bézier curves).
    
    Parameters:
    
    tension - the Bézier curve tension (0 for no Bézier curves).
  - getTension
```
public double getTension()
```
    Returns the Bézier curve tension (0 for no Bézier curves).
    
    Specified by:
    
    getTension in interface IsDefaultLine
    
    Returns:
    
    the Bézier curve tension (0 for no Bézier 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 Bézier control inside the chart, false for no restriction.
    
    Parameters:
    
    capBezierPoints - true to keep Bézier control inside the chart, false for no restriction.
  - isCapBezierPoints
```
public boolean isCapBezierPoints()
```
    Returns true to keep Bézier control inside the chart, false for no restriction.
    
    Specified by:
    
    isCapBezierPoints in interface IsDefaultLine
    
    Returns:
    
    true to keep Bézier control inside the chart, false for no restriction.
  - setCubicInterpolationMode
```
public void setCubicInterpolationMode(CubicInterpolationMode mode)
```
    Sets algorithm used to interpolate a smooth curve from the discrete data points.
    The following interpolation modes are supported:
```
 'default'
 'monotone'
 
```
    The 'default' algorithm uses a custom weighted cubic interpolation, which produces pleasant curves for all types of datasets.
    The 'monotone' algorithm is more suited to y = f(x) datasets : it preserves monotonicity (or piecewise monotonicity) of the dataset being interpolated, and ensures local extremums (if any) stay at input data points.
    Parameters:
    
    mode - algorithm used to interpolate a smooth curve from the discrete data points
  - getCubicInterpolationMode
```
public CubicInterpolationMode getCubicInterpolationMode()
```
    Returns algorithm used to interpolate a smooth curve from the discrete data points.
    
    Specified by:
    
    getCubicInterpolationMode in interface IsDefaultLine
    
    Returns:
    
    algorithm used to interpolate a smooth curve from the discrete data points. Default is 'default'.
  - setFill
```
public void setFill(boolean fill)
```
    Sets how to fill the area under the line.
    
    Specified by:
    
    setFill in interface HasFill
    
    Parameters:
    
    fill - true to fill, otherwise false.
  - setFill
```
public void setFill(IsFill fill)
```
    Sets how to fill the area under the line.
    
    Specified by:
    
    setFill in interface HasFill
    
    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
    
    Specified by:
    
    getFill in interface HasFill
    
    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).
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class Line

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.enums.HasFill

Method Detail

getFiller

setTension

getTension

setBorderCapStyle

getBorderCapStyle

setBorderDash

getBorderDash

setBorderDashOffset

getBorderDashOffset

setBorderJoinStyle

getBorderJoinStyle

setCapBezierPoints

isCapBezierPoints

setCubicInterpolationMode

getCubicInterpolationMode

setFill

setFill

getFill

setStepped

isStepped

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent