Package io.jmix.charts.model

Class GaugeBand

java.lang.Object
io.jmix.charts.model.AbstractChartObject
io.jmix.charts.model.GaugeBand
All Implemented Interfaces:
Serializable
public class GaugeBand extends AbstractChartObject
Creates a band for a specified value range on the GaugeAxis. Multiple bands can be assigned to a single GaugeAxis.
See documentation for properties of GaugeBand JS Object.
http://docs.amcharts.com/3/javascriptcharts/GaugeBand
See Also:

  • Constructor Details

    • GaugeBand

      public GaugeBand()

  • Method Details

    • getAlpha

      public Double getAlpha()
      Returns:
      opacity of band fill

    • setAlpha

      @StudioProperty @Max(1L) @Min(0L) public @Max(1L) @Min(0L) GaugeBand setAlpha(Double alpha)
      Sets opacity of band fill. Will use GaugeAxis.bandAlpha if not set any.
      Parameters:
      alpha - opacity
      Returns:
      gauge band

    • getColor

      public Color getColor()
      Returns:
      color of a band

    • setColor

      @StudioProperty(type=OPTIONS) public GaugeBand setColor(Color color)
      Sets color of a band.
      Parameters:
      color - color
      Returns:
      gauge band

    • getEndValue

      public Double getEndValue()
      Returns:
      end value of a fill

    • setEndValue

      @StudioProperty public GaugeBand setEndValue(Double endValue)
      Sets end value of a fill.
      Parameters:
      endValue - end value
      Returns:
      gauge band

    • getInnerRadius

      public String getInnerRadius()
      Returns:
      inner radius of a band

    • setInnerRadius

      @StudioProperty public GaugeBand setInnerRadius(String innerRadius)
      Sets inner radius of a band. If not set any, the band will end with the end of minor ticks. Set 0 if you want the band to be drawn to the axis center.
      Parameters:
      innerRadius - inner radius
      Returns:
      gauge band

    • getRadius

      public String getRadius()
      Returns:
      band radius

    • setRadius

      @StudioProperty public GaugeBand setRadius(String radius)
      Sets band radius. If not set any, the band will start with the axis outline.
      Parameters:
      radius - band radius
      Returns:
      gauge band

    • getStartValue

      public Double getStartValue()
      Returns:
      start value of a fill

    • setStartValue

      @StudioProperty public GaugeBand setStartValue(Double startValue)
      Sets start value of a fill.
      Parameters:
      startValue - start value
      Returns:
      gauge band

    • getBalloonText

      public String getBalloonText()
      Returns:
      balloon text

    • setBalloonText

      @StudioProperty public GaugeBand setBalloonText(String balloonText)
      Sets balloon text. When rolled-over, band will display balloon.
      Parameters:
      balloonText - balloon text
      Returns:
      gauge band

    • getId

      public String getId()
      Returns:
      unique id of a band

    • setId

      @StudioProperty public GaugeBand setId(String id)
      Sets unique id of a band.
      Parameters:
      id - id
      Returns:
      gauge band

    • getUrl

      public String getUrl()
      Returns:
      the URL

    • setUrl

      @StudioProperty public GaugeBand setUrl(String url)
      Sets URL for band. Gauge band can be clickable and can lead to some page.
      Parameters:
      url - the URL
      Returns:
      gauge band

    • getGradientRatio

      public List<Float> getGradientRatio()
      Returns:
      list of gradient ratio

    • setGradientRatio

      @StudioProperty(type=STRING) public GaugeBand setGradientRatio(List<Float> gradientRatio)
      Sets list of gradient ratio. Will make bands to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter.
      Parameters:
      gradientRatio - list of gradient ratio
      Returns:
      gauge band