Package io.jmix.charts.model.chart

Interface XYChartModel<T extends XYChartModel>

All Superinterfaces:
ChartModel<T>, CoordinateChartModel<T>, HasColors<T>, HasMargins<T>, HasStartEffect<T>, RectangularChartModel<T>
All Known Subinterfaces:
XYChart
All Known Implementing Classes:
XYChartImpl, XYChartModelImpl
public interface XYChartModel<T extends XYChartModel> extends RectangularChartModel<T>

  • Method Details

    • getHideXScrollbar

      Boolean getHideXScrollbar()
      Returns:
      true if scrollbar of X axis (horizontal) is hidden

    • setHideXScrollbar

      @StudioProperty(defaultValue="false") T setHideXScrollbar(Boolean hideXScrollbar)
      Set hideXScrollbar to true if scrollbar of X axis (horizontal) should be hidden. If not set the default value is false.
      Parameters:
      hideXScrollbar - hide X scrollbar option
      Returns:
      XY chart model

    • getHideYScrollbar

      Boolean getHideYScrollbar()
      Returns:
      true if scrollbar of Y axis (vertical) is hidden

    • setHideYScrollbar

      @StudioProperty(defaultValue="false") T setHideYScrollbar(Boolean hideYScrollbar)
      Set hideYScrollbar to true if scrollbar of Y axis (vertical) should be hidden. If not set the default value is false.
      Parameters:
      hideYScrollbar - hide Y scrollbar option
      Returns:
      XY chart model

    • getDataDateFormat

      String getDataDateFormat()
      Returns:
      data date format

    • setDataDateFormat

      @StudioProperty T setDataDateFormat(String dataDateFormat)
      Sets the data date format (date/time). Use it if you have date-based value axis in your XY chart. Note, that two-digit years "YY" as well as literal month names "MMM" are NOT supported in this setting.
      Parameters:
      dataDateFormat - data date format string
      Returns:
      XY chart model

    • getMaxValue

      Integer getMaxValue()
      Returns:
      maximum value of the size/scale of bubbles

    • setMaxValue

      @StudioProperty T setMaxValue(Integer maxValue)
      Sets the size/scale of bubbles. If these properties are not set, the bubble with smallest value will be of minBulletSize and bubble with biggest value will be of maxBulletSize. However, you might want bubble size to change relative to 0 or some other value. In this case you can use minValue and maxValue properties. Note, if you use these two settings, you might also want to set minBulletSize to 0.
      Parameters:
      maxValue - maximum value of the size/scale of bubbles
      Returns:
      XY chart model

    • getMinValue

      Integer getMinValue()
      Returns:
      minimum value of the size/scale of bubbles

    • setMinValue

      @StudioProperty T setMinValue(Integer minValue)
      Sets the size/scale of bubbles. If these properties are not set, the bubble with smallest value will be of minBulletSize and bubble with biggest value will be of maxBulletSize. However, you might want bubble size to change relative to 0 or some other value. In this case you can use minValue and maxValue properties. Note, if you use these two settings, you might also want to set minBulletSize to 0.
      Parameters:
      minValue - minimum value of the size/scale of bubbles
      Returns:
      XY chart model