RectangularChartModel (Jmix-ui 1.2 API)

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 Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`addTrendLines(TrendLine... trendLines)` Adds trend lines.
`java.lang.Integer`	`getAngle()`
`java.lang.Integer`	`getAutoMarginOffset()`
`java.lang.Boolean`	`getAutoMargins()`
`Cursor`	`getChartCursor()`
`Scrollbar`	`getChartScrollbar()`
`java.lang.Integer`	`getDepth3D()`
`java.lang.Boolean`	`getMarginsUpdated()`
`java.lang.Integer`	`getMaxZoomFactor()`
`java.lang.Integer`	`getMinMarginBottom()`
`java.lang.Integer`	`getMinMarginLeft()`
`java.lang.Integer`	`getMinMarginRight()`
`java.lang.Integer`	`getMinMarginTop()`
`java.lang.Double`	`getPlotAreaBorderAlpha()`
`Color`	`getPlotAreaBorderColor()`
`java.lang.Double`	`getPlotAreaFillAlphas()`
`java.util.List<Color>`	`getPlotAreaFillColors()`
`java.lang.Integer`	`getPlotAreaGradientAngle()`
`java.util.List<TrendLine>`	`getTrendLines()`
`java.lang.Double`	`getZoomOutButtonAlpha()`
`Color`	`getZoomOutButtonColor()`
`java.lang.String`	`getZoomOutButtonImage()`
`java.lang.Integer`	`getZoomOutButtonImageSize()`
`java.lang.Integer`	`getZoomOutButtonPadding()`
`java.lang.Double`	`getZoomOutButtonRollOverAlpha()`
`java.lang.Integer`	`getZoomOutButtonTabIndex()`
`java.lang.String`	`getZoomOutText()`
`T`	`setAngle(java.lang.Integer angle)` Sets the angle of the 3D part of plot area.
`T`	`setAutoMarginOffset(java.lang.Integer autoMarginOffset)` Sets space left from axis labels/title to the chart's outside border, if autoMargins set to true.
`T`	`setAutoMargins(java.lang.Boolean autoMargins)` Specifies if margins of a chart should be calculated automatically so that labels of axes would fit.
`T`	`setChartCursor(Cursor chartCursor)` Sets cursor of a chart.
`T`	`setChartScrollbar(Scrollbar chartScrollbar)` Sets chart scrollbar.
`T`	`setDepth3D(java.lang.Integer depth3D)` Sets the depth of the 3D part of plot area.
`T`	`setMarginsUpdated(java.lang.Boolean marginsUpdated)` Set to false if you need margins to be recalculated on next validateNow() call.
`T`	`setMaxZoomFactor(java.lang.Integer maxZoomFactor)` Sets the maximum zoom factor value axes.
`T`	`setMinMarginBottom(java.lang.Integer minMarginBottom)` Sets the minimum margin bottom.
`T`	`setMinMarginLeft(java.lang.Integer minMarginLeft)` Sets the minimum margin left.
`T`	`setMinMarginRight(java.lang.Integer minMarginRight)` Sets the minimum margin right.
`T`	`setMinMarginTop(java.lang.Integer minMarginTop)` Sets the minimum margin top.
`T`	`setPlotAreaBorderAlpha(java.lang.Double plotAreaBorderAlpha)` Sets the opacity of plot area's border.
`T`	`setPlotAreaBorderColor(Color plotAreaBorderColor)` Sets the color of the plot area's border.
`T`	`setPlotAreaFillAlphas(java.lang.Double plotAreaFillAlphas)` Sets opacity of plot area.
`T`	`setPlotAreaFillColors(java.util.List<Color> plotAreaFillColors)` Sets the list of plot area colors.
`T`	`setPlotAreaGradientAngle(java.lang.Integer plotAreaGradientAngle)` Sets the gradient angle, if you are using gradients to fill the plot area.
`T`	`setTrendLines(java.util.List<TrendLine> trendLines)` Sets the list of trend lines.
`T`	`setZoomOutButtonAlpha(java.lang.Double zoomOutButtonAlpha)` Sets opacity of zoom-out button background.
`T`	`setZoomOutButtonColor(Color zoomOutButtonColor)` Sets zoom-out button background color.
`T`	`setZoomOutButtonImage(java.lang.String zoomOutButtonImage)` Sets the name of zoom-out button image.
`T`	`setZoomOutButtonImageSize(java.lang.Integer zoomOutButtonImageSize)` Sets the size of zoom-out button image.
`T`	`setZoomOutButtonPadding(java.lang.Integer zoomOutButtonPadding)` Sets padding around the text and image.
`T`	`setZoomOutButtonRollOverAlpha(java.lang.Double zoomOutButtonRollOverAlpha)` Sets opacity of zoom-out button background when mouse is over it.
`T`	`setZoomOutButtonTabIndex(java.lang.Integer zoomOutButtonTabIndex)` In case you set it to some number, the chart will set focus on zoom-out button when user clicks tab key.
`T`	`setZoomOutText(java.lang.String zoomOutText)` Sets text in the zoom-out button.

Methods inherited from interface io.jmix.charts.model.chart.CoordinateChartModel
addGraphs, addGuides, addValueAxes, getGraphs, getGridAboveGraphs, getGuides, getSequencedAnimation, getStartAlpha, getUrlTarget, getValueAxes, setGraphs, setGridAboveGraphs, setGuides, setSequencedAnimation, setStartAlpha, setUrlTarget, setValueAxes

Methods inherited from interface io.jmix.charts.model.chart.ChartModel
addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleDescription, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

Methods inherited from interface io.jmix.charts.model.animation.HasStartEffect
getStartDuration, getStartEffect, setStartDuration, setStartEffect

Methods inherited from interface io.jmix.charts.model.HasColors
addColors, getColors, setColors

Methods inherited from interface io.jmix.charts.model.HasMargins
getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

- Method Detail
  - 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
```
java.util.List<TrendLine> getTrendLines()
```
    Returns:
    
    list of trend lines
  - setTrendLines
```
@StudioElementsGroup(caption="Trend Lines",
                     xmlElement="trendLines")
T setTrendLines(java.util.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
```
java.lang.Integer getAngle()
```
    Returns:
    
    angle of the 3D part of plot area
  - setAngle
```
@StudioProperty(defaultValue="0")
T setAngle(java.lang.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
```
java.lang.Integer getAutoMarginOffset()
```
    Returns:
    
    auto margin offset
  - setAutoMarginOffset
```
@StudioProperty(defaultValue="10")
T setAutoMarginOffset(java.lang.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
```
java.lang.Boolean getAutoMargins()
```
    Returns:
    
    true if auto margins is enabled
  - setAutoMargins
```
@StudioProperty(defaultValue="true")
T setAutoMargins(java.lang.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
```
java.lang.Integer getDepth3D()
```
    Returns:
    
    depth of the 3D part of plot area
  - setDepth3D
```
@StudioProperty(defaultValue="0")
T setDepth3D(java.lang.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
```
java.lang.Boolean getMarginsUpdated()
```
    Returns:
    
    true if margins update is enabled
  - setMarginsUpdated
```
@StudioProperty(defaultValue="false")
T setMarginsUpdated(java.lang.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
```
java.lang.Double getPlotAreaBorderAlpha()
```
    Returns:
    
    opacity of plot area's border
  - setPlotAreaBorderAlpha
```
@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
T setPlotAreaBorderAlpha(java.lang.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
```
java.lang.Double getPlotAreaFillAlphas()
```
    Returns:
    
    opacity of plot area
  - setPlotAreaFillAlphas
```
@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
T setPlotAreaFillAlphas(java.lang.Double plotAreaFillAlphas)
```
    Sets opacity of plot area. If not set the default value is 0.
    
    Parameters:
    
    plotAreaFillAlphas - opacity
    
    Returns:
    
    rectangular chart model
  - getPlotAreaFillColors
```
java.util.List<Color> getPlotAreaFillColors()
```
    Returns:
    
    list of plot area colors
  - setPlotAreaFillColors
```
T setPlotAreaFillColors(java.util.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
```
java.lang.Integer getPlotAreaGradientAngle()
```
    Returns:
    
    plot area gradient angle
  - setPlotAreaGradientAngle
```
@StudioProperty(type=ENUMERATION,
                options={"0","90","180","270"},
                defaultValue="0")
T setPlotAreaGradientAngle(java.lang.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
```
java.lang.Double getZoomOutButtonAlpha()
```
    Returns:
    
    opacity of zoom-out button background
  - setZoomOutButtonAlpha
```
@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
T setZoomOutButtonAlpha(java.lang.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
```
java.lang.String getZoomOutButtonImage()
```
    Returns:
    
    zoom out button image name
  - setZoomOutButtonImage
```
@StudioProperty(defaultValue="lens")
T setZoomOutButtonImage(java.lang.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
```
java.lang.Integer getZoomOutButtonImageSize()
```
    Returns:
    
    zoom out button image size
  - setZoomOutButtonImageSize
```
@StudioProperty(defaultValue="17")
T setZoomOutButtonImageSize(java.lang.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
```
java.lang.Integer getZoomOutButtonPadding()
```
    Returns:
    
    zoom out button padding
  - setZoomOutButtonPadding
```
@StudioProperty(defaultValue="8")
T setZoomOutButtonPadding(java.lang.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
```
java.lang.Double getZoomOutButtonRollOverAlpha()
```
    Returns:
    
    opacity of zoom-out button background
  - setZoomOutButtonRollOverAlpha
```
@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
T setZoomOutButtonRollOverAlpha(java.lang.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
```
java.lang.String getZoomOutText()
```
    Returns:
    
    zoom out text
  - setZoomOutText
```
@StudioProperty(defaultValue="Show all")
T setZoomOutText(java.lang.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
```
java.lang.Integer getMaxZoomFactor()
```
    Returns:
    
    maximum zoom factor
  - setMaxZoomFactor
```
@StudioProperty(defaultValue="20")
T setMaxZoomFactor(java.lang.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
```
java.lang.Integer getMinMarginBottom()
```
    Returns:
    
    minimum margin bottom
  - setMinMarginBottom
```
@StudioProperty
T setMinMarginBottom(java.lang.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
```
java.lang.Integer getMinMarginLeft()
```
    Returns:
    
    minimum margin left
  - setMinMarginLeft
```
@StudioProperty
T setMinMarginLeft(java.lang.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
```
java.lang.Integer getMinMarginRight()
```
    Returns:
    
    minimum margin right
  - setMinMarginRight
```
@StudioProperty
T setMinMarginRight(java.lang.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
```
java.lang.Integer getMinMarginTop()
```
    Returns:
    
    minimum margin top
  - setMinMarginTop
```
@StudioProperty
T setMinMarginTop(java.lang.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
```
java.lang.Integer getZoomOutButtonTabIndex()
```
    Returns:
    
    zoom out button tab index
  - setZoomOutButtonTabIndex
```
@StudioProperty
T setZoomOutButtonTabIndex(java.lang.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

Interface RectangularChartModel<T extends RectangularChartModel>

Method Summary

Methods inherited from interface io.jmix.charts.model.chart.CoordinateChartModel

Methods inherited from interface io.jmix.charts.model.chart.ChartModel

Methods inherited from interface io.jmix.charts.model.animation.HasStartEffect

Methods inherited from interface io.jmix.charts.model.HasColors

Methods inherited from interface io.jmix.charts.model.HasMargins

Method Detail

getChartCursor

setChartCursor

getChartScrollbar

setChartScrollbar

getTrendLines

setTrendLines

addTrendLines

getAngle

setAngle

getAutoMarginOffset

setAutoMarginOffset

getAutoMargins

setAutoMargins

getDepth3D

setDepth3D

getMarginsUpdated

setMarginsUpdated

getPlotAreaBorderAlpha

setPlotAreaBorderAlpha

getPlotAreaBorderColor

setPlotAreaBorderColor

getPlotAreaFillAlphas

setPlotAreaFillAlphas

getPlotAreaFillColors

setPlotAreaFillColors

getPlotAreaGradientAngle

setPlotAreaGradientAngle

getZoomOutButtonAlpha

setZoomOutButtonAlpha

getZoomOutButtonColor

setZoomOutButtonColor

getZoomOutButtonImage

setZoomOutButtonImage

getZoomOutButtonImageSize

setZoomOutButtonImageSize

getZoomOutButtonPadding

setZoomOutButtonPadding

getZoomOutButtonRollOverAlpha

setZoomOutButtonRollOverAlpha

getZoomOutText

setZoomOutText

getMaxZoomFactor

setMaxZoomFactor

getMinMarginBottom

setMinMarginBottom

getMinMarginLeft

setMinMarginLeft

getMinMarginRight

setMinMarginRight

getMinMarginTop

setMinMarginTop

getZoomOutButtonTabIndex

setZoomOutButtonTabIndex