Package io.jmix.charts.model

Class Guide

java.lang.Object
io.jmix.charts.model.AbstractChartObject
io.jmix.charts.model.Guide
All Implemented Interfaces:
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:

  • Constructor Details

    • Guide

      public Guide()

  • Method Details

    • getAbove

      public Boolean getAbove()
      Returns:
      true if guide displayed above the graphs

    • setAbove

      @StudioProperty(defaultValue="false") public Guide setAbove(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 Integer getAngle()
      Returns:
      angle at which guide starts

    • setAngle

      @StudioProperty public Guide setAngle(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 String getBalloonText()
      Returns:
      balloon text which is displayed if the user rolls-over the guide

    • setBalloonText

      @StudioProperty public Guide setBalloonText(String balloonText)
      Sets the text which will be displayed if the user rolls-over the guide.
      Parameters:
      balloonText - balloon text
      Returns:
      guide

    • getCategory

      public String getCategory()
      Returns:
      category value

    • setCategory

      @StudioProperty public Guide setCategory(String category)
      Sets category of the guide (in case the guide is for category axis).
      Parameters:
      category - category value
      Returns:
      guide

    • getDashLength

      public Integer getDashLength()
      Returns:
      dash length.

    • setDashLength

      @StudioProperty public Guide setDashLength(Integer dashLength)
      Sets dash length.
      Parameters:
      dashLength - dash length
      Returns:
      guide

    • getDate

      public Date getDate()
      Returns:
      date of the guide

    • setDate

      @StudioProperty public Guide setDate(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 Double getFillAlpha()
      Returns:
      fill opacity

    • setFillAlpha

      @StudioProperty @Max(1L) @Min(0L) public @Max(1L) @Min(0L) Guide setFillAlpha(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 Integer getFontSize()
      Returns:
      font size of guide label

    • setFontSize

      @StudioProperty public Guide setFontSize(Integer fontSize)
      Sets font size of guide label.
      Parameters:
      fontSize - font size
      Returns:
      guide

    • getInside

      public Boolean getInside()
      Returns:
      true if if label is placed inside plot area

    • setInside

      @StudioProperty public Guide setInside(Boolean inside)
      Set inside to true if label should be placed inside plot area.
      Parameters:
      inside - inside option
      Returns:
      guide

    • getLabel

      public String getLabel()
      Returns:
      label which is displayed near the guide

    • setLabel

      @StudioProperty public Guide setLabel(String label)
      Sets the label which will be displayed near the guide.
      Parameters:
      label - label string
      Returns:
      guide

    • getLabelRotation

      public Integer getLabelRotation()
      Returns:
      rotation angle of a guide label

    • setLabelRotation

      @StudioProperty public Guide setLabelRotation(Integer labelRotation)
      Sets rotation angle of a guide label.
      Parameters:
      labelRotation - rotation angle
      Returns:
      guide

    • getLineAlpha

      public Double getLineAlpha()
      Returns:
      line opacity

    • setLineAlpha

      @StudioProperty @Max(1L) @Min(0L) public @Max(1L) @Min(0L) Guide setLineAlpha(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 Integer getLineThickness()
      Returns:
      line thickness

    • setLineThickness

      @StudioProperty public Guide setLineThickness(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 Integer getTickLength()
      Returns:
      tick length

    • setTickLength

      @StudioProperty public Guide setTickLength(Integer tickLength)
      Sets tick length.
      Parameters:
      tickLength - tick length
      Returns:
      guide

    • getToAngle

      public Integer getToAngle()
      Returns:
      angle at which guide ends

    • setToAngle

      @StudioProperty public Guide setToAngle(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 String getToCategory()
      Returns:
      "to" category of the guide

    • setToCategory

      @StudioProperty public Guide setToCategory(String toCategory)
      Sets "to" category of the guide (in case the guide is for category axis).
      Parameters:
      toCategory - to category
      Returns:
      guide

    • getToDate

      public Date getToDate()
      Returns:
      "to" date of the guide

    • setToDate

      @StudioProperty public Guide setToDate(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 Object getToValue()
      Returns:
      "to" value of the guide

    • setToValue

      @StudioProperty(type=DOUBLE) public Guide setToValue(Object toValue)
      Sets "to" value of the guide (in case the guide is for value axis).
      Parameters:
      toValue - to value
      Returns:
      guide

    • getValue

      public Object getValue()
      Returns:
      value of the guide

    • setValue

      @StudioProperty(type=DOUBLE) public Guide setValue(Object value)
      Sets value of the guide (in case the guide is for value axis).
      Parameters:
      value - value
      Returns:
      guide

    • getBoldLabel

      public Boolean getBoldLabel()
      Returns:
      true if label is bold

    • setBoldLabel

      @StudioProperty(defaultValue="false") public Guide setBoldLabel(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 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(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 String getId()
      Returns:
      unique id of a guide

    • setId

      @StudioProperty public Guide setId(String id)
      Sets unique id of a guide.
      Parameters:
      id - id
      Returns:
      guide

    • getValueAxis

      public String getValueAxis()
      Returns:
      value axis id

    • setValueAxis

      @StudioProperty public Guide setValueAxis(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