Package io.jmix.charts.model.chart

Interface AngularGaugeChartModel<T extends AngularGaugeChartModel>

All Superinterfaces:
ChartModel<T>, HasMargins<T>, HasStartEffect<T>
All Known Subinterfaces:
AngularGaugeChart
All Known Implementing Classes:
AngularGaugeChartImpl, AngularGaugeChartModelImpl
public interface AngularGaugeChartModel<T extends AngularGaugeChartModel> extends ChartModel<T>, HasMargins<T>, HasStartEffect<T>

  • Method Details

    • getAdjustSize

      Boolean getAdjustSize()
      Returns:
      true if adjust size is enabled

    • setAdjustSize

      @StudioProperty(defaultValue="true") T setAdjustSize(Boolean adjustSize)
      Sets using the whole space of the canvas to draw the gauge. If not set the default value is true.
      Parameters:
      adjustSize - adjust size option
      Returns:
      chart model

    • getArrows

      List<GaugeArrow> getArrows()
      Returns:
      list of GaugeArrow

    • setArrows

      @StudioElementsGroup(caption="Arrows", xmlElement="arrows") T setArrows(List<GaugeArrow> arrows)
      Sets list of GaugeArrow.
      Parameters:
      arrows - the arrows
      Returns:
      chart model

    • addArrows

      T addArrows(GaugeArrow... arrows)
      Adds GaugeArrows.
      Parameters:
      arrows - the arrows
      Returns:
      chart model

    • getAxes

      List<GaugeAxis> getAxes()
      Returns:
      list of GaugeAxis

    • setAxes

      @StudioElementsGroup(caption="Axes", xmlElement="axes") T setAxes(List<GaugeAxis> axes)
      Sets list of GaugeAxis.
      Parameters:
      axes - the axes
      Returns:
      chart model

    • addAxes

      T addAxes(GaugeAxis... axes)
      Adds GaugeAxis.
      Parameters:
      axes - the axes
      Returns:
      chart model

    • getClockWiseOnly

      Boolean getClockWiseOnly()
      Returns:
      true if clock wise only is enabled

    • setClockWiseOnly

      @StudioProperty(defaultValue="false") T setClockWiseOnly(Boolean clockWiseOnly)
      Set clockWiseOnly to true if you use gauge to create a clock. If not set the default value is false.
      Parameters:
      clockWiseOnly - clock wise only option
      Returns:
      chart model

    • getFaceAlpha

      Double getFaceAlpha()
      Returns:
      gauge face opacity

    • setFaceAlpha

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) T setFaceAlpha(Double faceAlpha)
      Sets gauge face opacity. If not set the default value is 0.
      Parameters:
      faceAlpha - the face alpha
      Returns:
      chart model

    • getFaceBorderAlpha

      Double getFaceBorderAlpha()
      Returns:
      gauge face border opacity.

    • setFaceBorderAlpha

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) T setFaceBorderAlpha(Double faceBorderAlpha)
      Sets gauge face border opacity. If not set the default value is 0.
      Parameters:
      faceBorderAlpha - the face border alpha
      Returns:
      chart model

    • getFaceBorderColor

      Color getFaceBorderColor()
      Returns:
      gauge face border color.

    • setFaceBorderColor

      @StudioProperty(type=OPTIONS, defaultValue="#555555") T setFaceBorderColor(Color faceBorderColor)
      Sets gauge face border color. If not set the default value is #555555.
      Parameters:
      faceBorderColor - the face border color
      Returns:
      chart model

    • getFaceBorderWidth

      Integer getFaceBorderWidth()
      Returns:
      gauge face border width.

    • setFaceBorderWidth

      @StudioProperty(defaultValue="1") T setFaceBorderWidth(Integer faceBorderWidth)
      Sets gauge face border width. If not set the default value is 1.
      Parameters:
      faceBorderWidth - the face border width
      Returns:
      chart model

    • getFaceColor

      Color getFaceColor()
      Returns:
      gauge face color

    • setFaceColor

      @StudioProperty(type=OPTIONS, defaultValue="#FAFAFA") T setFaceColor(Color faceColor)
      Sets gauge face color, requires faceAlpha greater than 0 value. If not set the default value is #FAFAFA.
      Parameters:
      faceColor - the face color
      Returns:
      chart model

    • getFacePattern

      Pattern getFacePattern()
      Returns:
      gauge face image-pattern

    • setFacePattern

      T setFacePattern(Pattern facePattern)
      Sets gauge face image-pattern.
      Parameters:
      facePattern - the face pattern
      Returns:
      chart model

    • getGaugeX

      String getGaugeX()
      Returns:
      gauge's horizontal position in pixel

    • setGaugeX

      @StudioProperty T setGaugeX(String gaugeX)
      Sets gauge's horizontal position in pixel, origin is the center. Centered by default.
      Parameters:
      gaugeX - horizontal position in pixel
      Returns:
      chart model

    • getGaugeY

      String getGaugeY()
      Returns:
      gauge's vertical position in pixel

    • setGaugeY

      @StudioProperty T setGaugeY(String gaugeY)
      Sets gauge's vertical position in pixel, origin is the center. Centered by default.
      Parameters:
      gaugeY - vertical position in pixel
      Returns:
      chart model

    • getMinRadius

      Integer getMinRadius()
      Returns:
      minimum radius of a gauge

    • setMinRadius

      @StudioProperty(defaultValue="10") T setMinRadius(Integer minRadius)
      Sets minimum radius of a gauge. If not set the default value is 10.
      Parameters:
      minRadius - minimum radius
      Returns:
      chart model