TrendLine (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.charts.model.AbstractChartObject
- - io.jmix.charts.model.trendline.TrendLine

All Implemented Interfaces:

java.io.Serializable
```
public class TrendLine
extends AbstractChartObject
```
Creates a trendline for SerialChartModelImpl and XYChartModelImpl charts which indicates the trend of your data or covers some different purposes. Multiple can be assigned.
See documentation for properties of TrendLine JS Object.
http://docs.amcharts.com/3/javascriptcharts/TrendLine

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TrendLine()

Constructors
Constructor and Description
`TrendLine()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBalloonText()`
`java.lang.Integer`	`getDashLength()`
`java.lang.String`	`getFinalCategory()`
`java.util.Date`	`getFinalDate()`
`Image`	`getFinalImage()`
`java.lang.Double`	`getFinalValue()`
`java.lang.Double`	`getFinalXValue()`
`java.lang.String`	`getId()`
`java.lang.String`	`getInitialCategory()`
`java.util.Date`	`getInitialDate()`
`Image`	`getInitialImage()`
`java.lang.Double`	`getInitialValue()`
`java.lang.Double`	`getInitialXValue()`
`java.lang.Double`	`getLineAlpha()`
`Color`	`getLineColor()`
`java.lang.Integer`	`getLineThickness()`
`java.lang.Boolean`	`getProtected()`
`java.lang.String`	`getValueAxis()`
`java.lang.String`	`getValueAxisX()`
`TrendLine`	`setBalloonText(java.lang.String balloonText)` Sets balloon text.
`TrendLine`	`setDashLength(java.lang.Integer dashLength)` Sets dash length.
`TrendLine`	`setFinalCategory(java.lang.String finalCategory)` Sets string, equal to category value to which trend line should be drawn.
`TrendLine`	`setFinalDate(java.util.Date finalDate)` Sets date to which trend line should be drawn.
`TrendLine`	`setFinalImage(Image finalImage)` Sets an image to the end of a trend line.
`TrendLine`	`setFinalValue(java.lang.Double finalValue)` Sets value at which trend line should end.
`TrendLine`	`setFinalXValue(java.lang.Double finalXValue)` Sets X value at which trend line should end.
`TrendLine`	`setId(java.lang.String id)` Sets unique id of a trend line.
`TrendLine`	`setInitialCategory(java.lang.String initialCategory)` Sets string equal to category value from which trend line should start.
`TrendLine`	`setInitialDate(java.util.Date initialDate)` Sets date from which trend line should start.
`TrendLine`	`setInitialImage(Image initialImage)` Sets an image to the beginning of a trend line.
`TrendLine`	`setInitialValue(java.lang.Double initialValue)` Sets value from which trend line should start.
`TrendLine`	`setInitialXValue(java.lang.Double initialXValue)` Sets X value from which trend line should start.
`TrendLine`	`setLineAlpha(java.lang.Double lineAlpha)` Sets line opacity.
`TrendLine`	`setLineColor(Color lineColor)` Sets line color.
`TrendLine`	`setLineThickness(java.lang.Integer lineThickness)` Sets line thickness.
`TrendLine`	`setProtected(java.lang.Boolean aProtected)` Set isProtected to true if trend line shouldn't be removed when clicked on eraser tool.
`TrendLine`	`setValueAxis(java.lang.String valueAxis)` Sets value axis of the trend line.
`TrendLine`	`setValueAxisX(java.lang.String valueAxisX)` Sets X axis of the trend line.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TrendLine
```
public TrendLine()
```
- Method Detail
  - getBalloonText
```
public java.lang.String getBalloonText()
```
    Returns:
    
    balloon text
  - setBalloonText
```
public TrendLine setBalloonText(java.lang.String balloonText)
```
    Sets balloon text. When set, enables displaying a roll-over balloon.
    
    Parameters:
    
    balloonText - balloon text
    
    Returns:
    
    trend line
  - getDashLength
```
public java.lang.Integer getDashLength()
```
    Returns:
    
    dash length
  - setDashLength
```
public TrendLine setDashLength(java.lang.Integer dashLength)
```
    Sets dash length. If not set the default value is 0.
    
    Parameters:
    
    dashLength - dash length
    
    Returns:
    
    trend line
  - getFinalCategory
```
public java.lang.String getFinalCategory()
```
    Returns:
    
    final category string
  - setFinalCategory
```
public TrendLine setFinalCategory(java.lang.String finalCategory)
```
    Sets string, equal to category value to which trend line should be drawn. It should be used if chart doesn't parse dates.
    
    Parameters:
    
    finalCategory - final category string
    
    Returns:
    
    trend line
  - getFinalDate
```
public java.util.Date getFinalDate()
```
    Returns:
    
    date to which trend line should be drawn
  - setFinalDate
```
public TrendLine setFinalDate(java.util.Date finalDate)
```
    Sets date to which trend line should be drawn.
    
    Parameters:
    
    finalDate - final date
    
    Returns:
    
    trend line
  - getFinalValue
```
public java.lang.Double getFinalValue()
```
    Returns:
    
    value at which trend line is end
  - setFinalValue
```
public TrendLine setFinalValue(java.lang.Double finalValue)
```
    Sets value at which trend line should end.
    
    Parameters:
    
    finalValue - final value
    
    Returns:
    
    trend line
  - getFinalXValue
```
public java.lang.Double getFinalXValue()
```
    Returns:
    
    X value at which trend line is end
  - setFinalXValue
```
public TrendLine setFinalXValue(java.lang.Double finalXValue)
```
    Sets X value at which trend line should end. Used by XY chart only.
    
    Parameters:
    
    finalXValue - final X value
    
    Returns:
    
    trend line
  - getInitialCategory
```
public java.lang.String getInitialCategory()
```
    Returns:
    
    string equal to category value from which trend line should start
  - setInitialCategory
```
public TrendLine setInitialCategory(java.lang.String initialCategory)
```
    Sets string equal to category value from which trend line should start. It should be used if chart doesn't parse dates.
    
    Parameters:
    
    initialCategory - initial category
    
    Returns:
    
    trend line
  - getInitialDate
```
public java.util.Date getInitialDate()
```
    Returns:
    
    date from which trend line should start
  - setInitialDate
```
public TrendLine setInitialDate(java.util.Date initialDate)
```
    Sets date from which trend line should start.
    
    Parameters:
    
    initialDate - initial date
    
    Returns:
    
    trend line
  - getInitialValue
```
public java.lang.Double getInitialValue()
```
    Returns:
    
    value from which trend line should start
  - setInitialValue
```
public TrendLine setInitialValue(java.lang.Double initialValue)
```
    Sets value from which trend line should start.
    
    Parameters:
    
    initialValue - initial value
    
    Returns:
    
    trend line
  - getInitialXValue
```
public java.lang.Double getInitialXValue()
```
    Returns:
    
    X value from which trend line should start
  - setInitialXValue
```
public TrendLine setInitialXValue(java.lang.Double initialXValue)
```
    Sets X value from which trend line should start. Used by XY chart only
    
    Parameters:
    
    initialXValue - initial X value
    
    Returns:
    
    trend line
  - getProtected
```
public java.lang.Boolean getProtected()
```
    Returns:
    
    true if isProtected is enabled
  - setProtected
```
public TrendLine setProtected(java.lang.Boolean aProtected)
```
    Set isProtected to true if trend line shouldn't be removed when clicked on eraser tool. Used by stock chart. If not set the default value is false.
    
    Parameters:
    
    aProtected - isProtected option
    
    Returns:
    
    trend line
  - getLineAlpha
```
public java.lang.Double getLineAlpha()
```
    Returns:
    
    line opacity
  - setLineAlpha
```
public TrendLine setLineAlpha(java.lang.Double lineAlpha)
```
    Sets line opacity. If not set the default value is 1.
    
    Parameters:
    
    lineAlpha - opacity
    
    Returns:
    
    trend line
  - getLineColor
```
public Color getLineColor()
```
    Returns:
    
    line color
  - setLineColor
```
public TrendLine setLineColor(Color lineColor)
```
    Sets line color. If not set the default value is #00CC00.
    
    Parameters:
    
    lineColor - color
    
    Returns:
    
    trend line
  - getLineThickness
```
public java.lang.Integer getLineThickness()
```
    Returns:
    
    line thickness
  - setLineThickness
```
public TrendLine setLineThickness(java.lang.Integer lineThickness)
```
    Sets line thickness. If not set the default value is 1.
    
    Parameters:
    
    lineThickness - thickness
    
    Returns:
    
    trend line
  - getValueAxis
```
public java.lang.String getValueAxis()
```
    Returns:
    
    value axis id
  - setValueAxis
```
public TrendLine setValueAxis(java.lang.String valueAxis)
```
    Sets value axis of the trend line. Will use first value axis of the chart if not set any.
    
    Parameters:
    
    valueAxis - value axis id
    
    Returns:
    
    trend line
  - getValueAxisX
```
public java.lang.String getValueAxisX()
```
    Returns:
    
    value axis X id
  - setValueAxisX
```
public TrendLine setValueAxisX(java.lang.String valueAxisX)
```
    Sets X axis of the trend line. Will use first X axis of the chart if not set any. Used by XY chart only.
    
    Parameters:
    
    valueAxisX - value axis X id
    
    Returns:
    
    trend line
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    id of a trend line
  - setId
```
public TrendLine setId(java.lang.String id)
```
    Sets unique id of a trend line.
    
    Parameters:
    
    id - id
    
    Returns:
    
    trend line
  - getFinalImage
```
public Image getFinalImage()
```
    Returns:
    
    final image
  - setFinalImage
```
public TrendLine setFinalImage(Image finalImage)
```
    Sets an image to the end of a trend line.
    
    Parameters:
    
    finalImage - final image
    
    Returns:
    
    trend line
  - getInitialImage
```
public Image getInitialImage()
```
    Returns:
    
    initial image
  - setInitialImage
```
public TrendLine setInitialImage(Image initialImage)
```
    Sets an image to the beginning of a trend line.
    
    Parameters:
    
    initialImage - initial image
    
    Returns:
    
    trend line

Class TrendLine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrendLine

Method Detail

getBalloonText

setBalloonText

getDashLength

setDashLength

getFinalCategory

setFinalCategory

getFinalDate

setFinalDate

getFinalValue

setFinalValue

getFinalXValue

setFinalXValue

getInitialCategory

setInitialCategory

getInitialDate

setInitialDate

getInitialValue

setInitialValue

getInitialXValue

setInitialXValue

getProtected

setProtected

getLineAlpha

setLineAlpha

getLineColor

setLineColor

getLineThickness

setLineThickness

getValueAxis

setValueAxis

getValueAxisX

setValueAxisX

getId

setId

getFinalImage

setFinalImage

getInitialImage

setInitialImage