Package io.jmix.charts.model

Class GaugeArrow

java.lang.Object
io.jmix.charts.model.AbstractChartObject
io.jmix.charts.model.GaugeArrow
All Implemented Interfaces:
Serializable
public class GaugeArrow extends AbstractChartObject
Creates an arrow for AngularGaugeChart chart, multiple can be assigned.
See documentation for properties of GaugeArrow JS Object.
http://docs.amcharts.com/3/javascriptcharts/GaugeArrow
See Also:

  • Constructor Details

    • GaugeArrow

      public GaugeArrow()

  • Method Details

    • getAlpha

      public Double getAlpha()
      Returns:
      opacity of an arrow

    • setAlpha

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) public @Max(1L) @Min(0L) GaugeArrow setAlpha(Double alpha)
      Sets opacity of an arrow. If not set the default value is 1.
      Parameters:
      alpha - opacity
      Returns:
      gauge arrow

    • getBorderAlpha

      public Double getBorderAlpha()
      Returns:
      opacity of arrow border

    • setBorderAlpha

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) public @Max(1L) @Min(0L) GaugeArrow setBorderAlpha(Double borderAlpha)
      Sets opacity of arrow border. If not set the default value is 1.
      Parameters:
      borderAlpha - border opacity
      Returns:
      gauge arrow

    • getClockWiseOnly

      public Boolean getClockWiseOnly()
      Returns:
      true if clockWiseOnly is enabled

    • setClockWiseOnly

      @StudioProperty(defaultValue="false") public GaugeArrow setClockWiseOnly(Boolean clockWiseOnly)
      Set clockWiseOnly to true if you need the arrow to rotate only clock-wise. If not set the default value is false.
      Parameters:
      clockWiseOnly - clockWiseOnly option
      Returns:
      gauge arrow

    • getColor

      public Color getColor()
      Returns:
      color of an arrow

    • setColor

      @StudioProperty(type=OPTIONS, defaultValue="#000000") public GaugeArrow setColor(Color color)
      Sets color of an arrow. If not set the default value is #000000.
      Parameters:
      color - color
      Returns:
      gauge arrow

    • getInnerRadius

      public String getInnerRadius()
      Returns:
      inner radius

    • setInnerRadius

      @StudioProperty(defaultValue="0") public GaugeArrow setInnerRadius(String innerRadius)
      Sets inner radius of an arrow. If not set the default value is 0.
      Parameters:
      innerRadius - inner radius
      Returns:
      gauge arrow

    • getNailAlpha

      public Double getNailAlpha()
      Returns:
      opacity of a nail, holding the arrow

    • setNailAlpha

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) public @Max(1L) @Min(0L) GaugeArrow setNailAlpha(Double nailAlpha)
      Sets opacity of a nail, holding the arrow. If not set the default value is 1.
      Parameters:
      nailAlpha - opacity
      Returns:
      gauge arrow

    • getNailBorderAlpha

      public Double getNailBorderAlpha()
      Returns:
      opacity of nail border

    • setNailBorderAlpha

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) public @Max(1L) @Min(0L) GaugeArrow setNailBorderAlpha(Double nailBorderAlpha)
      Sets opacity of nail border. If not set the default value is 0.
      Parameters:
      nailBorderAlpha - opacity
      Returns:
      gauge arrow

    • getNailBorderThickness

      public Integer getNailBorderThickness()
      Returns:
      thickness of nail border

    • setNailBorderThickness

      @StudioProperty(defaultValue="1") public GaugeArrow setNailBorderThickness(Integer nailBorderThickness)
      Sets thickness of nail border. If not set the default value is 1.
      Parameters:
      nailBorderThickness - thickness
      Returns:
      gauge arrow

    • getNailRadius

      public Integer getNailRadius()
      Returns:
      radius

    • setNailRadius

      @StudioProperty(defaultValue="8") public GaugeArrow setNailRadius(Integer nailRadius)
      Sets radius of a nail, holding the arrow. If not set the default value is 8.
      Parameters:
      nailRadius - radius
      Returns:
      gauge arrow

    • getRadius

      public String getRadius()
      Returns:
      radius of an arrow

    • setRadius

      @StudioProperty(defaultValue="90%") public GaugeArrow setRadius(String radius)
      Sets radius of an arrow. If not set the default value is 90%.
      Parameters:
      radius - radius
      Returns:
      gauge arrow

    • getStartWidth

      public Integer getStartWidth()
      Returns:
      width of arrow root

    • setStartWidth

      @StudioProperty(defaultValue="8") public GaugeArrow setStartWidth(Integer startWidth)
      Sets width of arrow root. If not set the default value is 8.
      Parameters:
      startWidth - width
      Returns:
      gauge arrow

    • getAxis

      public String getAxis()
      Returns:
      axis id

    • setAxis

      @StudioProperty public GaugeArrow setAxis(String axis)
      Sets axis of the arrow. If you don't set any axis, the first axis of a chart will be used.
      Parameters:
      axis - axis id
      Returns:
      gauge arrow

    • getId

      public String getId()
      Returns:
      unique id of an arrow

    • setId

      @StudioProperty public GaugeArrow setId(String id)
      Sets unique id of an arrow.
      Parameters:
      id - unique id of an arrow
      Returns:
      gauge arrow

    • getValue

      public Double getValue()
      Returns:
      value to which the arrow is point at

    • setValue

      @StudioProperty public GaugeArrow setValue(Double value)
      Sets value to which the arrow should point at.
      Parameters:
      value - value
      Returns:
      gauge arrow