Package io.jmix.charts.model.chart

Interface RectangularChartModel<T extends RectangularChartModel>

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

  • Method Details

    • getChartCursor

      Cursor getChartCursor()
      Returns:
      chart cursor

    • setChartCursor

      T setChartCursor(Cursor chartCursor)
      Sets cursor of a chart.
      Parameters:
      chartCursor - the chart cursor
      Returns:
      rectangular chart model

    • getChartScrollbar

      Scrollbar getChartScrollbar()
      Returns:
      chart scrollbar

    • setChartScrollbar

      T setChartScrollbar(Scrollbar chartScrollbar)
      Sets chart scrollbar.
      Parameters:
      chartScrollbar - the chart scrollbar
      Returns:
      rectangular chart model

    • getTrendLines

      List<TrendLine> getTrendLines()
      Returns:
      list of trend lines

    • setTrendLines

      @StudioElementsGroup(caption="Trend Lines", xmlElement="trendLines") T setTrendLines(List<TrendLine> trendLines)
      Sets the list of trend lines.
      Parameters:
      trendLines - list of trend lines
      Returns:
      rectangular chart model

    • addTrendLines

      T addTrendLines(TrendLine... trendLines)
      Adds trend lines.
      Parameters:
      trendLines - the trend lines
      Returns:
      rectangular chart model

    • getAngle

      Integer getAngle()
      Returns:
      angle of the 3D part of plot area

    • setAngle

      @StudioProperty(defaultValue="0") T setAngle(Integer angle)
      Sets the angle of the 3D part of plot area. This creates a 3D effect (if the depth3D is greater than 0). If not set the default value is 0.
      Parameters:
      angle - the angle
      Returns:
      rectangular chart model

    • getAutoMarginOffset

      Integer getAutoMarginOffset()
      Returns:
      auto margin offset

    • setAutoMarginOffset

      @StudioProperty(defaultValue="10") T setAutoMarginOffset(Integer autoMarginOffset)
      Sets space left from axis labels/title to the chart's outside border, if autoMargins set to true. If not set the default value is 10.
      Parameters:
      autoMarginOffset - the auto margin offset
      Returns:
      rectangular chart model

    • getAutoMargins

      Boolean getAutoMargins()
      Returns:
      true if auto margins is enabled

    • setAutoMargins

      @StudioProperty(defaultValue="true") T setAutoMargins(Boolean autoMargins)
      Specifies if margins of a chart should be calculated automatically so that labels of axes would fit. The chart will adjust only margins with axes. Other margins will use values set with marginRight, marginTop, marginLeft and marginBottom properties. If not set the default value is true.
      Parameters:
      autoMargins - auto margins option
      Returns:
      rectangular chart model

    • getDepth3D

      Integer getDepth3D()
      Returns:
      depth of the 3D part of plot area

    • setDepth3D

      @StudioProperty(defaultValue="0") T setDepth3D(Integer depth3D)
      Sets the depth of the 3D part of plot area. This creates a 3D effect (if the angle is greater than 0). If not set the default value is 0.
      Parameters:
      depth3D - the depth 3D
      Returns:
      rectangular chart model

    • getMarginsUpdated

      Boolean getMarginsUpdated()
      Returns:
      true if margins update is enabled

    • setMarginsUpdated

      @StudioProperty(defaultValue="false") T setMarginsUpdated(Boolean marginsUpdated)
      Set to false if you need margins to be recalculated on next validateNow() call. If not set the default value is false.
      Parameters:
      marginsUpdated - the margin update option
      Returns:
      rectangular chart model

    • getPlotAreaBorderAlpha

      Double getPlotAreaBorderAlpha()
      Returns:
      opacity of plot area's border

    • setPlotAreaBorderAlpha

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) T setPlotAreaBorderAlpha(Double plotAreaBorderAlpha)
      Sets the opacity of plot area's border. Value range is 0 - 1. If not set the default value is 0.
      Parameters:
      plotAreaBorderAlpha - opacity of plot area's border
      Returns:
      rectangular chart model

    • getPlotAreaBorderColor

      Color getPlotAreaBorderColor()
      Returns:
      plot area border color

    • setPlotAreaBorderColor

      @StudioProperty(type=OPTIONS, defaultValue="#000000") T setPlotAreaBorderColor(Color plotAreaBorderColor)
      Sets the color of the plot area's border. Set it to a value higher than 0 to make it visible. If not set the default value is #000000.
      Parameters:
      plotAreaBorderColor - the plot area border color
      Returns:
      rectangular chart model

    • getPlotAreaFillAlphas

      Double getPlotAreaFillAlphas()
      Returns:
      opacity of plot area

    • setPlotAreaFillAlphas

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) T setPlotAreaFillAlphas(Double plotAreaFillAlphas)
      Sets opacity of plot area. If not set the default value is 0.
      Parameters:
      plotAreaFillAlphas - opacity
      Returns:
      rectangular chart model

    • getPlotAreaFillColors

      List<Color> getPlotAreaFillColors()
      Returns:
      list of plot area colors

    • setPlotAreaFillColors

      T setPlotAreaFillColors(List<Color> plotAreaFillColors)
      Sets the list of plot area colors. Create several colors if you need to generate gradients or create one if you need to get a solid color. If not set the default value is #FFFFFF.
      Parameters:
      plotAreaFillColors - list of plot area colors
      Returns:
      rectangular chart model

    • getPlotAreaGradientAngle

      Integer getPlotAreaGradientAngle()
      Returns:
      plot area gradient angle

    • setPlotAreaGradientAngle

      @StudioProperty(type=ENUMERATION, options={"0","90","180","270"}, defaultValue="0") T setPlotAreaGradientAngle(Integer plotAreaGradientAngle)
      Sets the gradient angle, if you are using gradients to fill the plot area. The only allowed values are horizontal and vertical: 0, 90, 180, 270. If not set the default value is 0.
      Parameters:
      plotAreaGradientAngle - the plot area gradient angle
      Returns:
      rectangular chart model

    • getZoomOutButtonAlpha

      Double getZoomOutButtonAlpha()
      Returns:
      opacity of zoom-out button background

    • setZoomOutButtonAlpha

      @StudioProperty(defaultValue="0") @Max(1L) @Min(0L) T setZoomOutButtonAlpha(Double zoomOutButtonAlpha)
      Sets opacity of zoom-out button background. If not set the default value is 0.
      Parameters:
      zoomOutButtonAlpha - opacity of zoom-out button background
      Returns:
      rectangular chart model

    • getZoomOutButtonColor

      Color getZoomOutButtonColor()
      Returns:
      zoom-out button background color

    • setZoomOutButtonColor

      @StudioProperty(type=OPTIONS, defaultValue="#E5E5E5") T setZoomOutButtonColor(Color zoomOutButtonColor)
      Sets zoom-out button background color. If not set the default value is #e5e5e5.
      Parameters:
      zoomOutButtonColor - zoom-out button background color
      Returns:
      rectangular chart model

    • getZoomOutButtonImage

      String getZoomOutButtonImage()
      Returns:
      zoom out button image name

    • setZoomOutButtonImage

      @StudioProperty(defaultValue="lens") T setZoomOutButtonImage(String zoomOutButtonImage)
      Sets the name of zoom-out button image. Note, you don't have to set image extension. If svgIcons is set to true, ".svg" will be added to the file name if SVG is supported by the browser, otherwise – ".png". If not set the default value is "lens".
      Parameters:
      zoomOutButtonImage - zoom out button image name string
      Returns:
      rectangular chart model

    • getZoomOutButtonImageSize

      Integer getZoomOutButtonImageSize()
      Returns:
      zoom out button image size

    • setZoomOutButtonImageSize

      @StudioProperty(defaultValue="17") T setZoomOutButtonImageSize(Integer zoomOutButtonImageSize)
      Sets the size of zoom-out button image. If not set the default value is 17.
      Parameters:
      zoomOutButtonImageSize - the zoom out button image size
      Returns:
      rectangular chart model

    • getZoomOutButtonPadding

      Integer getZoomOutButtonPadding()
      Returns:
      zoom out button padding

    • setZoomOutButtonPadding

      @StudioProperty(defaultValue="8") T setZoomOutButtonPadding(Integer zoomOutButtonPadding)
      Sets padding around the text and image. If not set the default value is 8.
      Parameters:
      zoomOutButtonPadding - the zoom out button padding
      Returns:
      rectangular chart model

    • getZoomOutButtonRollOverAlpha

      Double getZoomOutButtonRollOverAlpha()
      Returns:
      opacity of zoom-out button background

    • setZoomOutButtonRollOverAlpha

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) T setZoomOutButtonRollOverAlpha(Double zoomOutButtonRollOverAlpha)
      Sets opacity of zoom-out button background when mouse is over it. If not set the default value is 1.
      Parameters:
      zoomOutButtonRollOverAlpha - opacity of zoom-out button background
      Returns:
      rectangular chart model

    • getZoomOutText

      String getZoomOutText()
      Returns:
      zoom out text

    • setZoomOutText

      @StudioProperty(defaultValue="Show all") T setZoomOutText(String zoomOutText)
      Sets text in the zoom-out button. If not set the default value is "Show all".
      Parameters:
      zoomOutText - zoom out text string
      Returns:
      rectangular chart model

    • getMaxZoomFactor

      Integer getMaxZoomFactor()
      Returns:
      maximum zoom factor

    • setMaxZoomFactor

      @StudioProperty(defaultValue="20") T setMaxZoomFactor(Integer maxZoomFactor)
      Sets the maximum zoom factor value axes. If not set the default value is 20.
      Parameters:
      maxZoomFactor - maximum zoom factor
      Returns:
      rectangular chart model

    • getMinMarginBottom

      Integer getMinMarginBottom()
      Returns:
      minimum margin bottom

    • setMinMarginBottom

      @StudioProperty T setMinMarginBottom(Integer minMarginBottom)
      Sets the minimum margin bottom. If bottom side has a value axis and autoMargins is set to true, the margin of this side will be not less than set on minMarginBottom property.
      Parameters:
      minMarginBottom - the minimum margin bottom
      Returns:
      rectangular chart model

    • getMinMarginLeft

      Integer getMinMarginLeft()
      Returns:
      minimum margin left

    • setMinMarginLeft

      @StudioProperty T setMinMarginLeft(Integer minMarginLeft)
      Sets the minimum margin left. If left side has a value axis and autoMargins is set to true, the margin of this side will be not less than set on minMarginLeft property.
      Parameters:
      minMarginLeft - the minimum margin left
      Returns:
      rectangular chart model

    • getMinMarginRight

      Integer getMinMarginRight()
      Returns:
      minimum margin right

    • setMinMarginRight

      @StudioProperty T setMinMarginRight(Integer minMarginRight)
      Sets the minimum margin right. If right side has a value axis and autoMargins is set to true, the margin of this side will be not less than set on minMarginRight property.
      Parameters:
      minMarginRight - the minimum margin right
      Returns:
      rectangular chart model

    • getMinMarginTop

      Integer getMinMarginTop()
      Returns:
      minimum margin top

    • setMinMarginTop

      @StudioProperty T setMinMarginTop(Integer minMarginTop)
      Sets the minimum margin top. If top side has a value axis and autoMargins is set to true, the margin of this side will be not less than set on minMarginTop property.
      Parameters:
      minMarginTop - the minimum margin top
      Returns:
      rectangular chart model

    • getZoomOutButtonTabIndex

      Integer getZoomOutButtonTabIndex()
      Returns:
      zoom out button tab index

    • setZoomOutButtonTabIndex

      @StudioProperty T setZoomOutButtonTabIndex(Integer zoomOutButtonTabIndex)
      In case you set it to some number, the chart will set focus on zoom-out button when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read zoomOutText. If user clicks Enter when a focus is set, the chart will zoom-out. Note, not all browsers and readers support this.
      Parameters:
      zoomOutButtonTabIndex - the zoom out button tab index
      Returns:
      rectangular chart model