Guide (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.charts.model.AbstractChartObject
- - io.jmix.charts.model.Guide

All Implemented Interfaces:

java.io.Serializable
```
public class Guide
extends AbstractChartObject
```
Creates a horizontal/vertical guideline-/area for SerialChartModelImpl, XYChartModelImpl and RadarChartModelImpl charts, automatically adapts it's settings from the axes if none has been specified.
See documentation for properties of Guide JS Object.
http://docs.amcharts.com/3/javascriptcharts/Guide

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Guide()

Constructors
Constructor and Description
`Guide()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAbove()`
`java.lang.Integer`	`getAngle()`
`Color`	`getBalloonColor()`
`java.lang.String`	`getBalloonText()`
`java.lang.Boolean`	`getBoldLabel()`
`java.lang.String`	`getCategory()`
`Color`	`getColor()`
`java.lang.Integer`	`getDashLength()`
`java.util.Date`	`getDate()`
`java.lang.Boolean`	`getExpand()`
`java.lang.Double`	`getFillAlpha()`
`Color`	`getFillColor()`
`java.lang.Integer`	`getFontSize()`
`java.lang.String`	`getId()`
`java.lang.Boolean`	`getInside()`
`java.lang.String`	`getLabel()`
`java.lang.Integer`	`getLabelRotation()`
`java.lang.Double`	`getLineAlpha()`
`Color`	`getLineColor()`
`java.lang.Integer`	`getLineThickness()`
`Position`	`getPosition()`
`java.lang.Integer`	`getTickLength()`
`java.lang.Integer`	`getToAngle()`
`java.lang.String`	`getToCategory()`
`java.util.Date`	`getToDate()`
`java.lang.Object`	`getToValue()`
`java.lang.Object`	`getValue()`
`java.lang.String`	`getValueAxis()`
`Guide`	`setAbove(java.lang.Boolean above)` Set above to true if the guide should be displayed above the graphs.
`Guide`	`setAngle(java.lang.Integer angle)` Sets angle at which guide should start.
`Guide`	`setBalloonColor(Color balloonColor)` Sets balloon fill color.
`Guide`	`setBalloonText(java.lang.String balloonText)` Sets the text which will be displayed if the user rolls-over the guide.
`Guide`	`setBoldLabel(java.lang.Boolean boldLabel)` Set boldLabel to true if label should be bold.
`Guide`	`setCategory(java.lang.String category)` Sets category of the guide (in case the guide is for category axis).
`Guide`	`setColor(Color color)` Sets color of a guide label.
`Guide`	`setDashLength(java.lang.Integer dashLength)` Sets dash length.
`Guide`	`setDate(java.util.Date date)` Sets date of the guide (in case the guide is for category axis and `CategoryAxis.parseDates` is set to true).
`Guide`	`setExpand(java.lang.Boolean expand)` Set expand to true if the guide should start (or be placed, if it's not a fill) on the beginning of the category cell and should end at the end of "toCategory" cell.
`@Max(value=1L) @Min(value=0L) Guide`	`setFillAlpha(java.lang.Double fillAlpha)` Sets fill opacity.
`Guide`	`setFillColor(Color fillColor)` Sets fill color.
`Guide`	`setFontSize(java.lang.Integer fontSize)` Sets font size of guide label.
`Guide`	`setId(java.lang.String id)` Sets unique id of a guide.
`Guide`	`setInside(java.lang.Boolean inside)` Set inside to true if label should be placed inside plot area.
`Guide`	`setLabel(java.lang.String label)` Sets the label which will be displayed near the guide.
`Guide`	`setLabelRotation(java.lang.Integer labelRotation)` Sets rotation angle of a guide label.
`@Max(value=1L) @Min(value=0L) Guide`	`setLineAlpha(java.lang.Double lineAlpha)` Sets line opacity.
`Guide`	`setLineColor(Color lineColor)` Sets line color.
`Guide`	`setLineThickness(java.lang.Integer lineThickness)` Sets line thickness.
`Guide`	`setPosition(Position position)` Sets position of guide label.
`Guide`	`setTickLength(java.lang.Integer tickLength)` Sets tick length.
`Guide`	`setToAngle(java.lang.Integer toAngle)` Sets the angle at which guide should end.
`Guide`	`setToCategory(java.lang.String toCategory)` Sets "to" category of the guide (in case the guide is for category axis).
`Guide`	`setToDate(java.util.Date toDate)` Sets "to" date of the guide (in case the guide is for category axis and `CategoryAxis.parseDates` is set to true) If you have both date and toDate, the space between these two dates can be filled with color.
`Guide`	`setToValue(java.lang.Object toValue)` Sets "to" value of the guide (in case the guide is for value axis).
`Guide`	`setValue(java.lang.Object value)` Sets value of the guide (in case the guide is for value axis).
`Guide`	`setValueAxis(java.lang.String valueAxis)` Sets value axis of a guide.

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

- Constructor Detail
  - Guide
```
public Guide()
```
- Method Detail
  - getAbove
```
public java.lang.Boolean getAbove()
```
    Returns:
    
    true if guide displayed above the graphs
  - setAbove
```
@StudioProperty(defaultValue="false")
public Guide setAbove(java.lang.Boolean above)
```
    Set above to true if the guide should be displayed above the graphs. If not set the default value is false.
    
    Parameters:
    
    above - above option
    
    Returns:
    
    guide
  - getAngle
```
public java.lang.Integer getAngle()
```
    Returns:
    
    angle at which guide starts
  - setAngle
```
@StudioProperty
public Guide setAngle(java.lang.Integer angle)
```
    Sets angle at which guide should start. Affects only fills, not lines. Radar chart only.
    
    Parameters:
    
    angle - angle
    
    Returns:
    
    guide
  - getBalloonColor
```
public Color getBalloonColor()
```
    Returns:
    
    balloon fill color
  - setBalloonColor
```
@StudioProperty(type=OPTIONS)
public Guide setBalloonColor(Color balloonColor)
```
    Sets balloon fill color.
    
    Parameters:
    
    balloonColor - fill color
    
    Returns:
    
    guide
  - getBalloonText
```
public java.lang.String getBalloonText()
```
    Returns:
    
    balloon text which is displayed if the user rolls-over the guide
  - setBalloonText
```
@StudioProperty
public Guide setBalloonText(java.lang.String balloonText)
```
    Sets the text which will be displayed if the user rolls-over the guide.
    
    Parameters:
    
    balloonText - balloon text
    
    Returns:
    
    guide
  - getCategory
```
public java.lang.String getCategory()
```
    Returns:
    
    category value
  - setCategory
```
@StudioProperty
public Guide setCategory(java.lang.String category)
```
    Sets category of the guide (in case the guide is for category axis).
    
    Parameters:
    
    category - category value
    
    Returns:
    
    guide
  - getDashLength
```
public java.lang.Integer getDashLength()
```
    Returns:
    
    dash length.
  - setDashLength
```
@StudioProperty
public Guide setDashLength(java.lang.Integer dashLength)
```
    Sets dash length.
    
    Parameters:
    
    dashLength - dash length
    
    Returns:
    
    guide
  - getDate
```
public java.util.Date getDate()
```
    Returns:
    
    date of the guide
  - setDate
```
@StudioProperty
public Guide setDate(java.util.Date date)
```
    Sets date of the guide (in case the guide is for category axis and CategoryAxis.parseDates is set to true).
    
    Parameters:
    
    date - date
    
    Returns:
    
    guide
  - getFillAlpha
```
public java.lang.Double getFillAlpha()
```
    Returns:
    
    fill opacity
  - setFillAlpha
```
@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) Guide setFillAlpha(java.lang.Double fillAlpha)
```
    Sets fill opacity. Value range is 0 - 1.
    
    Parameters:
    
    fillAlpha - fill opacity
    
    Returns:
    
    guide
  - getFillColor
```
public Color getFillColor()
```
    Returns:
    
    fill color
  - setFillColor
```
@StudioProperty(type=OPTIONS)
public Guide setFillColor(Color fillColor)
```
    Sets fill color.
    
    Parameters:
    
    fillColor - fill color
    
    Returns:
    
    guide
  - getFontSize
```
public java.lang.Integer getFontSize()
```
    Returns:
    
    font size of guide label
  - setFontSize
```
@StudioProperty
public Guide setFontSize(java.lang.Integer fontSize)
```
    Sets font size of guide label.
    
    Parameters:
    
    fontSize - font size
    
    Returns:
    
    guide
  - getInside
```
public java.lang.Boolean getInside()
```
    Returns:
    
    true if if label is placed inside plot area
  - setInside
```
@StudioProperty
public Guide setInside(java.lang.Boolean inside)
```
    Set inside to true if label should be placed inside plot area.
    
    Parameters:
    
    inside - inside option
    
    Returns:
    
    guide
  - getLabel
```
public java.lang.String getLabel()
```
    Returns:
    
    label which is displayed near the guide
  - setLabel
```
@StudioProperty
public Guide setLabel(java.lang.String label)
```
    Sets the label which will be displayed near the guide.
    
    Parameters:
    
    label - label string
    
    Returns:
    
    guide
  - getLabelRotation
```
public java.lang.Integer getLabelRotation()
```
    Returns:
    
    rotation angle of a guide label
  - setLabelRotation
```
@StudioProperty
public Guide setLabelRotation(java.lang.Integer labelRotation)
```
    Sets rotation angle of a guide label.
    
    Parameters:
    
    labelRotation - rotation angle
    
    Returns:
    
    guide
  - getLineAlpha
```
public java.lang.Double getLineAlpha()
```
    Returns:
    
    line opacity
  - setLineAlpha
```
@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) Guide setLineAlpha(java.lang.Double lineAlpha)
```
    Sets line opacity.
    
    Parameters:
    
    lineAlpha - line opacity
    
    Returns:
    
    guide
  - getLineColor
```
public Color getLineColor()
```
    Returns:
    
    line color
  - setLineColor
```
@StudioProperty(type=OPTIONS)
public Guide setLineColor(Color lineColor)
```
    Sets line color.
    
    Parameters:
    
    lineColor - line color
    
    Returns:
    
    guide
  - getLineThickness
```
public java.lang.Integer getLineThickness()
```
    Returns:
    
    line thickness
  - setLineThickness
```
@StudioProperty
public Guide setLineThickness(java.lang.Integer lineThickness)
```
    Sets line thickness.
    
    Parameters:
    
    lineThickness - line thickness
    
    Returns:
    
    guide
  - getPosition
```
public Position getPosition()
```
    Returns:
    
    position of guide label
  - setPosition
```
@StudioProperty(type=ENUMERATION)
public Guide setPosition(Position position)
```
    Sets position of guide label. Possible values are "left" or "right" for horizontal axis and "top" or "bottom" for vertical axis.
    
    Parameters:
    
    position - position of guide label
    
    Returns:
    
    guide
  - getTickLength
```
public java.lang.Integer getTickLength()
```
    Returns:
    
    tick length
  - setTickLength
```
@StudioProperty
public Guide setTickLength(java.lang.Integer tickLength)
```
    Sets tick length.
    
    Parameters:
    
    tickLength - tick length
    
    Returns:
    
    guide
  - getToAngle
```
public java.lang.Integer getToAngle()
```
    Returns:
    
    angle at which guide ends
  - setToAngle
```
@StudioProperty
public Guide setToAngle(java.lang.Integer toAngle)
```
    Sets the angle at which guide should end. Affects only fills, not lines. Radar chart only.
    
    Parameters:
    
    toAngle - angle
    
    Returns:
    
    guide
  - getToCategory
```
public java.lang.String getToCategory()
```
    Returns:
    
    "to" category of the guide
  - setToCategory
```
@StudioProperty
public Guide setToCategory(java.lang.String toCategory)
```
    Sets "to" category of the guide (in case the guide is for category axis).
    
    Parameters:
    
    toCategory - to category
    
    Returns:
    
    guide
  - getToDate
```
public java.util.Date getToDate()
```
    Returns:
    
    "to" date of the guide
  - setToDate
```
@StudioProperty
public Guide setToDate(java.util.Date toDate)
```
    Sets "to" date of the guide (in case the guide is for category axis and CategoryAxis.parseDates is set to true) If you have both date and toDate, the space between these two dates can be filled with color.
    
    Parameters:
    
    toDate - date
    
    Returns:
    
    guide
  - getToValue
```
public java.lang.Object getToValue()
```
    Returns:
    
    "to" value of the guide
  - setToValue
```
@StudioProperty(type=DOUBLE)
public Guide setToValue(java.lang.Object toValue)
```
    Sets "to" value of the guide (in case the guide is for value axis).
    
    Parameters:
    
    toValue - to value
    
    Returns:
    
    guide
  - getValue
```
public java.lang.Object getValue()
```
    Returns:
    
    value of the guide
  - setValue
```
@StudioProperty(type=DOUBLE)
public Guide setValue(java.lang.Object value)
```
    Sets value of the guide (in case the guide is for value axis).
    
    Parameters:
    
    value - value
    
    Returns:
    
    guide
  - getBoldLabel
```
public java.lang.Boolean getBoldLabel()
```
    Returns:
    
    true if label is bold
  - setBoldLabel
```
@StudioProperty(defaultValue="false")
public Guide setBoldLabel(java.lang.Boolean boldLabel)
```
    Set boldLabel to true if label should be bold. If not set the default value is false.
    
    Parameters:
    
    boldLabel - boldLabel option
    
    Returns:
    
    guide
  - getColor
```
public Color getColor()
```
    Returns:
    
    color of a guide label
  - setColor
```
@StudioProperty(type=OPTIONS)
public Guide setColor(Color color)
```
    Sets color of a guide label.
    
    Parameters:
    
    color - color
    
    Returns:
    
    guide
  - getExpand
```
public java.lang.Boolean getExpand()
```
    Returns:
    
    true if the guide starts on the beginning of the category cell and ends at the end of "toCategory" cell
  - setExpand
```
@StudioProperty(defaultValue="false")
public Guide setExpand(java.lang.Boolean expand)
```
    Set expand to true if the guide should start (or be placed, if it's not a fill) on the beginning of the category cell and should end at the end of "toCategory" cell. Works if a guide is added to CategoryAxis and this axis is non-date-based. If not set the default value is false.
    
    Parameters:
    
    expand - expand option
    
    Returns:
    
    guide
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    unique id of a guide
  - setId
```
@StudioProperty
public Guide setId(java.lang.String id)
```
    Sets unique id of a guide.
    
    Parameters:
    
    id - id
    
    Returns:
    
    guide
  - getValueAxis
```
public java.lang.String getValueAxis()
```
    Returns:
    
    value axis id
  - setValueAxis
```
@StudioProperty
public Guide setValueAxis(java.lang.String valueAxis)
```
    Sets value axis of a guide. As you can add guides directly to the chart, you might need to specify which value axis should be used.
    
    Parameters:
    
    valueAxis - value axis id
    
    Returns:
    
    guide

Class Guide

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Guide

Method Detail

getAbove

setAbove

getAngle

setAngle

getBalloonColor

setBalloonColor

getBalloonText

setBalloonText

getCategory

setCategory

getDashLength

setDashLength

getDate

setDate

getFillAlpha

setFillAlpha

getFillColor

setFillColor

getFontSize

setFontSize

getInside

setInside

getLabel

setLabel

getLabelRotation

setLabelRotation

getLineAlpha

setLineAlpha

getLineColor

setLineColor

getLineThickness

setLineThickness

getPosition

setPosition

getTickLength

setTickLength

getToAngle

setToAngle

getToCategory

setToCategory

getToDate

setToDate

getToValue

setToValue

getValue

setValue

getBoldLabel

setBoldLabel

getColor

setColor

getExpand

setExpand

getId

setId

getValueAxis

setValueAxis