Package io.jmix.charts.model.chart

Interface SeriesBasedChartModel<T extends SeriesBasedChartModel>

All Superinterfaces:
ChartModel<T>, CoordinateChartModel<T>, HasColors<T>, HasMargins<T>, HasStartEffect<T>, RectangularChartModel<T>
All Known Subinterfaces:
GanttChart, GanttChartModel<T>, SerialChart, SeriesBasedChart<T>
All Known Implementing Classes:
AbstractSerialChart, GanttChartImpl, GanttChartModelImpl, SerialChartImpl, SerialChartModelImpl, SeriesBasedChartImpl, StockPanel
public interface SeriesBasedChartModel<T extends SeriesBasedChartModel> extends RectangularChartModel<T>

  • Method Details

    • getCategoryAxis

      CategoryAxis getCategoryAxis()
      Returns:
      category axis

    • setCategoryAxis

      T setCategoryAxis(CategoryAxis categoryAxis)
      Sets the category axis.
      Parameters:
      categoryAxis - the category axis
      Returns:
      chart model

    • getCategoryField

      String getCategoryField()
      Returns:
      category field name

    • setCategoryField

      @StudioProperty(type=PROPERTY_PATH_REF) T setCategoryField(String categoryField)
      Sets the category field name. It tells the chart the name of the field from your data provider object which will be used for category axis values.
      Parameters:
      categoryField - category field name string
      Returns:
      chart model

    • getBalloonDateFormat

      String getBalloonDateFormat()
      Returns:
      balloon date format

    • setBalloonDateFormat

      @StudioProperty(defaultValue="MMM DD, YYYY") T setBalloonDateFormat(String balloonDateFormat)
      Sets date format of the graph balloon (if chart parses dates and you don't use Cursor). If not set the default value is "MMM DD, YYYY".
      Parameters:
      balloonDateFormat - the balloon date format
      Returns:
      chart model

    • getColumnSpacing3D

      Integer getColumnSpacing3D()
      Returns:
      space between 3D stacked columns

    • setColumnSpacing3D

      @StudioProperty(defaultValue="0") T setColumnSpacing3D(Integer columnSpacing3D)
      Sets space between 3D stacked columns. If not set the default value is 0.
      Parameters:
      columnSpacing3D - space between 3D stacked columns
      Returns:
      chart model

    • getColumnSpacing

      Integer getColumnSpacing()
      Returns:
      column spacing in pixels

    • setColumnSpacing

      @StudioProperty(defaultValue="5") T setColumnSpacing(Integer columnSpacing)
      Sets the gap in pixels between two columns of the same category. If not set the default value is 5.
      Parameters:
      columnSpacing - column spacing in pixels
      Returns:
      chart model

    • getColumnWidth

      Double getColumnWidth()
      Returns:
      relative width of columns

    • setColumnWidth

      @StudioProperty(defaultValue="0.8") @Max(1L) @Min(0L) T setColumnWidth(Double columnWidth)
      Sets relative width of columns. Value range is 0 - 1. If not set the default value is 0.8.
      Parameters:
      columnWidth - relative width of columns
      Returns:
      chart model

    • getDataDateFormat

      String getDataDateFormat()
      Returns:
      data date format

    • setDataDateFormat

      @StudioProperty T setDataDateFormat(String dataDateFormat)
      Sets data date format. Even if your chart parses dates, you can pass them as strings in your data – all you need to do is to set data date format and the chart will parse dates to date objects. Please 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:
      chart model

    • getMaxSelectedSeries

      Integer getMaxSelectedSeries()
      Returns:
      maximum number of selected series

    • setMaxSelectedSeries

      @StudioProperty T setMaxSelectedSeries(Integer maxSelectedSeries)
      Sets maximum number of series allowed to select.
      Parameters:
      maxSelectedSeries - the maximum number of selected series
      Returns:
      chart model

    • getMaxSelectedTime

      Long getMaxSelectedTime()
      Returns:
      maximum selected time in milliseconds

    • setMaxSelectedTime

      @StudioProperty T setMaxSelectedTime(Long maxSelectedTime)
      Sets the longest time span allowed to select in milliseconds for example, 259200000 will limit selection to 3 days. Works if CategoryAxis.equalSpacing is set to false.
      Parameters:
      maxSelectedTime - the maximum selected time in milliseconds
      Returns:
      chart model

    • getMinSelectedTime

      Long getMinSelectedTime()
      Returns:
      minimum selected time in milliseconds

    • setMinSelectedTime

      @StudioProperty(defaultValue="0") T setMinSelectedTime(Long minSelectedTime)
      Sets the shortest time span allowed to select in milliseconds for example, 1000 will limit selection to 1 second. Works if CategoryAxis.equalSpacing is set to false. If not set the default value is 0.
      Parameters:
      minSelectedTime - the minimum selected time in milliseconds
      Returns:
      chart model

    • getMouseWheelScrollEnabled

      Boolean getMouseWheelScrollEnabled()
      Returns:
      true if scroll chart with the mouse wheel is enabled

    • setMouseWheelScrollEnabled

      @StudioProperty(defaultValue="false") T setMouseWheelScrollEnabled(Boolean mouseWheelScrollEnabled)
      Set true if you want scroll chart with the mouse wheel. If you press shift while rotating mouse wheel, the chart will zoom-in/out. If not set the default value is false.
      Parameters:
      mouseWheelScrollEnabled - mouse wheel scroll option
      Returns:
      chart model

    • getRotate

      Boolean getRotate()
      Returns:
      true if rotate is enabled

    • setRotate

      @StudioProperty(defaultValue="false") T setRotate(Boolean rotate)
      Set rotate to true, if the chart should be rotated by 90 degrees (the columns will become bars). If not set the default value is false.
      Parameters:
      rotate - rotate option
      Returns:
      chart model

    • getZoomOutOnDataUpdate

      Boolean getZoomOutOnDataUpdate()
      Returns:
      true if chart should be zoom-out when data is updated

    • setZoomOutOnDataUpdate

      @StudioProperty(defaultValue="true") T setZoomOutOnDataUpdate(Boolean zoomOutOnDataUpdate)
      Set zoomOutOnDataUpdate to true if chart should be zoom-out when data is updated. If not set the default value is true.
      Parameters:
      zoomOutOnDataUpdate - zoomOutOnDataUpdate option
      Returns:
      chart model

    • getMouseWheelZoomEnabled

      Boolean getMouseWheelZoomEnabled()
      Returns:
      true if zooming of a chart with mouse wheel is enabled

    • setMouseWheelZoomEnabled

      @StudioProperty(defaultValue="false") T setMouseWheelZoomEnabled(Boolean mouseWheelZoomEnabled)
      Set mouseWheelZoomEnabled to true if zooming of a chart with mouse wheel should be enabled. If you press shift while rotating mouse wheel, the chart will scroll. If not set the default value is false.
      Parameters:
      mouseWheelZoomEnabled - mouseWheelZoomEnabled option
      Returns:
      chart model

    • getValueScrollbar

      Scrollbar getValueScrollbar()
      Returns:
      value scrollbar

    • setValueScrollbar

      T setValueScrollbar(Scrollbar valueScrollbar)
      Sets value scrollbar, enables scrolling value axes.
      Parameters:
      valueScrollbar - the value scrollbar
      Returns:
      chart model

    • getSynchronizeGrid

      Boolean getSynchronizeGrid()
      Returns:
      true if synchronized grid is enabled

    • setSynchronizeGrid

      @StudioProperty T setSynchronizeGrid(Boolean synchronizeGrid)
      Set synchronizeGrid property to true and the chart will adjust minimum and maximum of axes so that the grid would be show at equal intervals. This helps users to compare values more easily.
      Parameters:
      synchronizeGrid - synchronized grid option
      Returns:
      chart model