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

java.lang.Object
- org.pepstock.charba.client.configuration.Line

```
public class Line
extends Object
```
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
`IsColor`	`getBackgroundColor()` Returns the background color.
`String`	`getBackgroundColorAsString()` Returns the background color.
`CapStyle`	`getBorderCapStyle()` Returns how the end points of every line are drawn.
`IsColor`	`getBorderColor()` Returns the border color.
`String`	`getBorderColorAsString()` Returns the border color.
`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.
`double`	`getBorderDashOffset()` Returns the line dash pattern offset.
`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).
`int`	`getBorderWidth()` Returns the border width.
`IsChart`	`getChart()` Returns the chart instance
`protected ExtendedOptions`	`getConfiguration()` Returns the configuration element.
`CubicInterpolationMode`	`getCubicInterpolationMode()` Returns algorithm used to interpolate a smooth curve from the discrete data points.
`protected AbstractElement<IsDefaultLine>`	`getElement()` Returns the element instance to be managed.
`IsFill`	`getFill()` Returns how to fill the area under the line.
`IsColor`	`getHoverBackgroundColor()` Returns the background color when hovered.
`String`	`getHoverBackgroundColorAsString()` Returns the background color when hovered.
`IsColor`	`getHoverBorderColor()` Returns the border color when hovered.
`String`	`getHoverBorderColorAsString()` Returns the border color when hovered.
`int`	`getHoverBorderWidth()` Returns the border width when hovered.
`protected ConfigurationOptions`	`getOptions()` Returns the configuration options.
`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`	`setBackgroundColor(IsColor backgroundColor)` Sets the background color.
`void`	`setBackgroundColor(String backgroundColor)` Sets the background color.
`void`	`setBorderCapStyle(CapStyle borderCapStyle)` Sets how the end points of every line are drawn.
`void`	`setBorderColor(IsColor borderColor)` Sets the border color.
`void`	`setBorderColor(String borderColor)` Sets the border color.
`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(double borderDashOffset)` Sets the line dash pattern offset.
`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).
`void`	`setBorderWidth(int borderWidth)` Sets the border width.
`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:
`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 data set 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 data set index.
`void`	`setHoverBackgroundColor(IsColor backgroundColor)` Sets the background color when hovered.
`void`	`setHoverBackgroundColor(String backgroundColor)` Sets the background color when hovered.
`void`	`setHoverBorderColor(IsColor borderColor)` Sets the border color when hovered.
`void`	`setHoverBorderColor(String borderColor)` Sets the border color when hovered.
`void`	`setHoverBorderWidth(int borderWidth)` Sets the border width when hovered.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getElement
```
protected AbstractElement<IsDefaultLine> getElement()
```
    Returns the element instance to be managed.
    
    Returns:
    
    the element instance to be managed
  - 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).
    
    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.
    
    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.
    
    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(double borderDashOffset)
```
    Sets the line dash pattern offset.
    
    Parameters:
    
    borderDashOffset - the line dash pattern offset.
  - getBorderDashOffset
```
public double getBorderDashOffset()
```
    Returns the line dash pattern offset.
    
    Returns:
    
    the line dash pattern offset
  - 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).
    
    Parameters:
    
    borderJoinStyle - how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together
  - 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).
    
    Returns:
    
    how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together
  - 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.
    
    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 data sets.
    The 'monotone' algorithm is more suited to y = f(x) data sets : it preserves monotonicity (or piecewise monotonicity) of the data set 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.
    
    Returns:
    
    algorithm used to interpolate a smooth curve from the discrete data points.
  - 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 data set index.
    
    Parameters:
    
    index - absolute data set index of the chart.
  - setFill
```
public void setFill(String index)
```
    Sets how to fill the area under the line, by relative data set index.
    
    Parameters:
    
    index - relative data set 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.
    
    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).
    
    Returns:
    
    true to show the line as a stepped line (tension will be ignored).
  - setBackgroundColor
```
public void setBackgroundColor(IsColor backgroundColor)
```
    Sets the background color.
    
    Parameters:
    
    backgroundColor - the background color.
  - setBackgroundColor
```
public void setBackgroundColor(String backgroundColor)
```
    Sets the background color.
    
    Parameters:
    
    backgroundColor - the background color.
  - getBackgroundColorAsString
```
public String getBackgroundColorAsString()
```
    Returns the background color.
    
    Returns:
    
    the background color.
  - getBackgroundColor
```
public IsColor getBackgroundColor()
```
    Returns the background color.
    
    Returns:
    
    the background color.
  - setBorderWidth
```
public void setBorderWidth(int borderWidth)
```
    Sets the border width.
    
    Parameters:
    
    borderWidth - the border width.
  - getBorderWidth
```
public int getBorderWidth()
```
    Returns the border width.
    
    Returns:
    
    the border width.
  - setBorderColor
```
public void setBorderColor(IsColor borderColor)
```
    Sets the border color.
    
    Parameters:
    
    borderColor - the border color.
  - setBorderColor
```
public void setBorderColor(String borderColor)
```
    Sets the border color.
    
    Parameters:
    
    borderColor - the border color.
  - getBorderColorAsString
```
public String getBorderColorAsString()
```
    Returns the border color.
    
    Returns:
    
    the border color.
  - getBorderColor
```
public IsColor getBorderColor()
```
    Returns the border color.
    
    Returns:
    
    the border color.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(IsColor backgroundColor)
```
    Sets the background color when hovered.
    
    Parameters:
    
    backgroundColor - the background color when hovered.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(String backgroundColor)
```
    Sets the background color when hovered.
    
    Parameters:
    
    backgroundColor - the background color when hovered.
  - getHoverBackgroundColorAsString
```
public String getHoverBackgroundColorAsString()
```
    Returns the background color when hovered.
    
    Returns:
    
    the background color when hovered.
  - getHoverBackgroundColor
```
public IsColor getHoverBackgroundColor()
```
    Returns the background color when hovered.
    
    Returns:
    
    the background color when hovered.
  - setHoverBorderWidth
```
public void setHoverBorderWidth(int borderWidth)
```
    Sets the border width when hovered.
    
    Parameters:
    
    borderWidth - the border width when hovered.
  - getHoverBorderWidth
```
public int getHoverBorderWidth()
```
    Returns the border width when hovered.
    
    Returns:
    
    the border width when hovered.
  - setHoverBorderColor
```
public void setHoverBorderColor(IsColor borderColor)
```
    Sets the border color when hovered.
    
    Parameters:
    
    borderColor - the border color when hovered.
  - setHoverBorderColor
```
public void setHoverBorderColor(String borderColor)
```
    Sets the border color when hovered.
    
    Parameters:
    
    borderColor - the border color when hovered.
  - getHoverBorderColorAsString
```
public String getHoverBorderColorAsString()
```
    Returns the border color when hovered.
    
    Returns:
    
    the border color when hovered.
  - getHoverBorderColor
```
public IsColor getHoverBorderColor()
```
    Returns the border color when hovered.
    
    Returns:
    
    the border color when hovered.
  - getOptions
```
protected final ConfigurationOptions getOptions()
```
    Returns the configuration options.
    
    Returns:
    
    the configuration options.
  - getConfiguration
```
protected final ExtendedOptions getConfiguration()
```
    Returns the configuration element.
    
    Returns:
    
    the configuration element.
  - getChart
```
public final IsChart getChart()
```
    Returns the chart instance
    
    Returns:
    
    the chart

Class Line

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getElement

setTension

getTension

setBorderCapStyle

getBorderCapStyle

setBorderDash

getBorderDash

setBorderDashOffset

getBorderDashOffset

setBorderJoinStyle

getBorderJoinStyle

setCapBezierPoints

isCapBezierPoints

setCubicInterpolationMode

getCubicInterpolationMode

setFill

setFill

setFill

setFill

getFill

setStepped

isStepped

setBackgroundColor

setBackgroundColor

getBackgroundColorAsString

getBackgroundColor

setBorderWidth

getBorderWidth

setBorderColor

setBorderColor

getBorderColorAsString

getBorderColor

setHoverBackgroundColor

setHoverBackgroundColor

getHoverBackgroundColorAsString

getHoverBackgroundColor

setHoverBorderWidth

getHoverBorderWidth

setHoverBorderColor

setHoverBorderColor

getHoverBorderColorAsString

getHoverBorderColor

getOptions

getConfiguration

getChart