RectangularChartImpl (Jmix-ui 1.2 API)

java.lang.Object
- io.jmix.ui.component.impl.AbstractComponent<JmixAmchartsScene>
- - io.jmix.charts.component.impl.ChartImpl<T,M>
  - - io.jmix.charts.component.impl.CoordinateChartImpl<T,M>
    - - io.jmix.charts.component.impl.RectangularChartImpl<T,M>

All Implemented Interfaces:

Chart<T>, CoordinateChart<T>, RectangularChart<T>, HasStartEffect<T>, ChartModel<T>, CoordinateChartModel<T>, RectangularChartModel<T>, HasColors<T>, HasMargins<T>, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SeriesBasedChartImpl, XYChartImpl
```
public abstract class RectangularChartImpl<T extends RectangularChart,M extends RectangularChartModelImpl>
extends CoordinateChartImpl<T,M>
implements RectangularChart<T>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface io.jmix.charts.component.Chart
  Chart.AbstractChartClickEvent, Chart.AbstractChartEvent, Chart.AbstractClickEvent, Chart.AbstractCursorEvent, Chart.AbstractGraphItemClickEvent, Chart.AbstractItemEvent, Chart.AbstractSliceClickEvent, Chart.AxisZoomEvent, Chart.ChartClickEvent, Chart.ChartRightClickEvent, Chart.CursorPeriodSelectEvent, Chart.CursorZoomEvent, Chart.GraphClickEvent, Chart.GraphItemClickEvent, Chart.GraphItemRightClickEvent, Chart.LegendItemClickEvent, Chart.LegendItemEvent, Chart.LegendItemHideEvent, Chart.LegendItemShowEvent, Chart.LegendMarkerClickEvent, Chart.RollOutGraphEvent, Chart.RollOutGraphItemEvent, Chart.RollOverGraphEvent, Chart.RollOverGraphItemEvent, Chart.SliceClickEvent, Chart.SlicePullInEvent, Chart.SlicePullOutEvent, Chart.SliceRightClickEvent, Chart.ZoomEvent
- Nested classes/interfaces inherited from interface io.jmix.ui.component.Component
  Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
- Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
  HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields
Modifier and Type Field and Description

protected CursorZoomListener cursorZoomHandler

protected CursorPeriodSelectListener periodSelectHandler
- Fields inherited from class io.jmix.charts.component.impl.CoordinateChartImpl
  axisZoomHandler, graphClickHandler, graphItemClickHandler, graphItemRightClickHandler, rollOutGraphItemListener, rollOutGraphListener, rollOverGraphItemListener, rollOverGraphListener
- Fields inherited from class io.jmix.charts.component.impl.ChartImpl
  chartLocaleHelper, clickHandler, currentAuthentication, formatStringsRegistry, legendItemHideHandler, legendItemShowHandler, legendLabelClickHandler, legendMarkerClickHandler, messages, messageTools, rightClickHandler
- Fields inherited from class io.jmix.ui.component.impl.AbstractComponent
  alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent
- Fields inherited from interface io.jmix.ui.component.Component
  AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields
Modifier and Type	Field and Description
`protected CursorZoomListener`	`cursorZoomHandler`
`protected CursorPeriodSelectListener`	`periodSelectHandler`

Constructor Summary

Constructors
Constructor and Description

RectangularChartImpl()

Constructors
Constructor and Description
`RectangularChartImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.jmix.core.common.event.Subscription`	`addCursorPeriodSelectListener(java.util.function.Consumer<Chart.CursorPeriodSelectEvent> listener)` Adds a listener for period selection by cursor.
`io.jmix.core.common.event.Subscription`	`addCursorZoomListener(java.util.function.Consumer<Chart.CursorZoomEvent> listener)` Adds a listener for cursor zoom.
`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.Integer`	`getMarginBottom()`
`java.lang.Integer`	`getMarginLeft()`
`java.lang.Integer`	`getMarginRight()`
`java.lang.Boolean`	`getMarginsUpdated()`
`java.lang.Integer`	`getMarginTop()`
`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()`
`protected void`	`onCursorPeriodSelect(CursorPeriodSelectEvent e)`
`protected void`	`onCursorZoom(CursorZoomEvent e)`
`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`	`setMarginBottom(java.lang.Integer marginBottom)` Sets bottom spacing.
`T`	`setMarginLeft(java.lang.Integer marginLeft)` Sets left-hand spacing.
`T`	`setMarginRight(java.lang.Integer marginRight)` Sets right-hand spacing.
`T`	`setMarginsUpdated(java.lang.Boolean marginsUpdated)` Set to false if you need margins to be recalculated on next validateNow() call.
`T`	`setMarginTop(java.lang.Integer marginTop)` Sets top spacing.
`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 list)` Sets the list of trend lines.
`protected void`	`setupDefaults(M chart)`
`protected void`	`setupRectangularChartDefaults(RectangularChartModelImpl chart)`
`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 class io.jmix.charts.component.impl.CoordinateChartImpl
addAxisZoomListener, addColors, addGraphClickListener, addGraphItemClickListener, addGraphItemRightClickListener, addGraphs, addGuides, addRollOutGraphItemListener, addRollOutGraphListener, addRollOverGraphItemListener, addRollOverGraphListener, addValueAxes, getColors, getGraphById, getGraphs, getGridAboveGraphs, getGuides, getSequencedAnimation, getStartAlpha, getStartDuration, getStartEffect, getUrlTarget, getValueAxes, onAxisZoomListener, onGraphClick, onGraphItemClick, onGraphItemRightClick, onRollOutGraphClick, onRollOutGraphItemClick, onRollOverGraphClick, onRollOverGraphItemClick, setColors, setGraphs, setGridAboveGraphs, setGuides, setSequencedAnimation, setStartAlpha, setStartDuration, setStartEffect, setUrlTarget, setValueAxes, zoomOutValueAxes, zoomOutValueAxis, zoomOutValueAxis, zoomValueAxisToValues, zoomValueAxisToValues

Methods inherited from class io.jmix.charts.component.impl.ChartImpl
addAdditionalFields, addClickListener, addData, addLabels, addLegendItemHideListener, addLegendItemShowListener, addLegendLabelClickListener, addLegendMarkerClickListener, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addRightClickListener, addTitles, afterPropertiesSet, createChartConfiguration, createChartSerializer, createComponent, 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, getModel, getNativeJson, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, initLocale, onChartClick, onChartRightClick, onLegendItemHide, onLegendItemShow, onLegendLabelClick, onLegendMarkerClick, repaint, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setChartLocaleHelper, setClassNamePrefix, setColor, setCreditsPosition, setCurrentAuthentication, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setFormatStringsRegistry, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setMessages, setMessageTools, setNativeJson, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setupChartLocale, setUsePrefixes

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent
addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.charts.component.CoordinateChart
addAxisZoomListener, addGraphClickListener, addGraphItemClickListener, addGraphItemRightClickListener, addRollOutGraphItemListener, addRollOutGraphListener, addRollOverGraphItemListener, addRollOverGraphListener, zoomOutValueAxes, zoomOutValueAxis, zoomOutValueAxis, zoomValueAxisToValues, zoomValueAxisToValues

Methods inherited from interface io.jmix.charts.component.Chart
addClickListener, addLegendItemHideListener, addLegendItemShowListener, addLegendLabelClickListener, addLegendMarkerClickListener, addRightClickListener, getDataProvider, getNativeJson, repaint, setDataProvider, setNativeJson

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.HasCaption
getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescription

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, 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, 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

- Field Detail
  - periodSelectHandler
```
protected CursorPeriodSelectListener periodSelectHandler
```
  - cursorZoomHandler
```
protected CursorZoomListener cursorZoomHandler
```
- Constructor Detail
  - RectangularChartImpl
```
public RectangularChartImpl()
```
- Method Detail
  - setupDefaults
```
protected void setupDefaults(M chart)
```
    Overrides:
    
    setupDefaults in class ChartImpl<T extends RectangularChart,M extends RectangularChartModelImpl>
  - setupRectangularChartDefaults
```
protected void setupRectangularChartDefaults(RectangularChartModelImpl chart)
```
  - getChartCursor
```
public Cursor getChartCursor()
```
    Specified by:
    
    getChartCursor in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    chart cursor
  - setChartCursor
```
public T setChartCursor(Cursor chartCursor)
```
    Description copied from interface: RectangularChartModel
    
    Sets cursor of a chart.
    
    Specified by:
    
    setChartCursor in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    chartCursor - the chart cursor
    
    Returns:
    
    rectangular chart model
  - getChartScrollbar
```
public Scrollbar getChartScrollbar()
```
    Specified by:
    
    getChartScrollbar in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    chart scrollbar
  - setChartScrollbar
```
public T setChartScrollbar(Scrollbar chartScrollbar)
```
    Description copied from interface: RectangularChartModel
    
    Sets chart scrollbar.
    
    Specified by:
    
    setChartScrollbar in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    chartScrollbar - the chart scrollbar
    
    Returns:
    
    rectangular chart model
  - getTrendLines
```
public java.util.List<TrendLine> getTrendLines()
```
    Specified by:
    
    getTrendLines in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    list of trend lines
  - setTrendLines
```
public T setTrendLines(java.util.List list)
```
    Description copied from interface: RectangularChartModel
    
    Sets the list of trend lines.
    
    Specified by:
    
    setTrendLines in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    list - list of trend lines
    
    Returns:
    
    rectangular chart model
  - addTrendLines
```
public T addTrendLines(TrendLine... trendLines)
```
    Description copied from interface: RectangularChartModel
    
    Adds trend lines.
    
    Specified by:
    
    addTrendLines in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    trendLines - the trend lines
    
    Returns:
    
    rectangular chart model
  - getAngle
```
public java.lang.Integer getAngle()
```
    Specified by:
    
    getAngle in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    angle of the 3D part of plot area
  - setAngle
```
public T setAngle(java.lang.Integer angle)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setAngle in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    angle - the angle
    
    Returns:
    
    rectangular chart model
  - getAutoMarginOffset
```
public java.lang.Integer getAutoMarginOffset()
```
    Specified by:
    
    getAutoMarginOffset in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    auto margin offset
  - setAutoMarginOffset
```
public T setAutoMarginOffset(java.lang.Integer autoMarginOffset)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setAutoMarginOffset in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    autoMarginOffset - the auto margin offset
    
    Returns:
    
    rectangular chart model
  - getAutoMargins
```
public java.lang.Boolean getAutoMargins()
```
    Specified by:
    
    getAutoMargins in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    true if auto margins is enabled
  - setAutoMargins
```
public T setAutoMargins(java.lang.Boolean autoMargins)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setAutoMargins in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    autoMargins - auto margins option
    
    Returns:
    
    rectangular chart model
  - getDepth3D
```
public java.lang.Integer getDepth3D()
```
    Specified by:
    
    getDepth3D in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    depth of the 3D part of plot area
  - setDepth3D
```
public T setDepth3D(java.lang.Integer depth3D)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setDepth3D in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    depth3D - the depth 3D
    
    Returns:
    
    rectangular chart model
  - getMarginBottom
```
public java.lang.Integer getMarginBottom()
```
    Specified by:
    
    getMarginBottom in interface HasMargins<T extends RectangularChart>
    
    Returns:
    
    bottom spacing
  - setMarginBottom
```
public T setMarginBottom(java.lang.Integer marginBottom)
```
    Description copied from interface: HasMargins
    
    Sets bottom spacing. If not set the default value is 10.
    If is used for Legend default value is 0.
    If is used for RadarChartModelImpl the default value is 0.
    If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.
    If is used for chart based on SlicedChartModelImpl (FunnelChart, PieChart) the default value is 10.
    If is used for PanelsSettings the default value is 0.
    
    Specified by:
    
    setMarginBottom in interface HasMargins<T extends RectangularChart>
    
    Parameters:
    
    marginBottom - bottom spacing
    
    Returns:
    
    object with set bottom spacing
  - getMarginLeft
```
public java.lang.Integer getMarginLeft()
```
    Specified by:
    
    getMarginLeft in interface HasMargins<T extends RectangularChart>
    
    Returns:
    
    left-hand spacing
  - setMarginLeft
```
public T setMarginLeft(java.lang.Integer marginLeft)
```
    Description copied from interface: HasMargins
    
    Sets left-hand spacing.
    marginLeft will be ignored if chart is SerialChart or XYChartModelImpl and AbstractLegend.autoMargins is true.
    If is used for Legend the default value is 20.
    If is used for RadarChartModelImpl the default value is 0.
    If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.
    If is used for chart based on SlicedChartModelImpl the default value is 0.
    If is used for PanelsSettings the default value is 0.
    
    Specified by:
    
    setMarginLeft in interface HasMargins<T extends RectangularChart>
    
    Parameters:
    
    marginLeft - left-hand spacing
    
    Returns:
    
    object with set left-hand spacing
  - getMarginRight
```
public java.lang.Integer getMarginRight()
```
    Specified by:
    
    getMarginRight in interface HasMargins<T extends RectangularChart>
    
    Returns:
    
    right-hand spacing
  - setMarginRight
```
public T setMarginRight(java.lang.Integer marginRight)
```
    Description copied from interface: HasMargins
    
    Sets right-hand spacing.
    marginRight will be ignored if chart is SerialChart or XYChartModelImpl and AbstractLegend.autoMargins is true.
    If is used for Legend the default value is 20.
    If is used for RadarChartModelImpl the default value is 0.
    If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.
    If is used for chart based on SlicedChartModelImpl (FunnelChart, PieChart) the default value is 0.
    If is used for PanelsSettings the default value is 0.
    
    Specified by:
    
    setMarginRight in interface HasMargins<T extends RectangularChart>
    
    Parameters:
    
    marginRight - right-hand spacing
    
    Returns:
    
    object with set right-hand spacing
  - getMarginTop
```
public java.lang.Integer getMarginTop()
```
    Specified by:
    
    getMarginTop in interface HasMargins<T extends RectangularChart>
    
    Returns:
    
    top spacing
  - setMarginTop
```
public T setMarginTop(java.lang.Integer marginTop)
```
    Description copied from interface: HasMargins
    
    Sets top spacing. If not set the default value is 10.
    If is used for Legend the default value is 0.
    If is used for RadarChartModelImpl the default value is 0.
    If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.
    If is used for chart based on SlicedChartModelImpl the default value is 10.
    If is used for PanelsSettings the default value is 0.
    
    Specified by:
    
    setMarginTop in interface HasMargins<T extends RectangularChart>
    
    Parameters:
    
    marginTop - top spacing
    
    Returns:
    
    object with set top spacing
  - getMarginsUpdated
```
public java.lang.Boolean getMarginsUpdated()
```
    Specified by:
    
    getMarginsUpdated in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    true if margins update is enabled
  - setMarginsUpdated
```
public T setMarginsUpdated(java.lang.Boolean marginsUpdated)
```
    Description copied from interface: RectangularChartModel
    
    Set to false if you need margins to be recalculated on next validateNow() call. If not set the default value is false.
    
    Specified by:
    
    setMarginsUpdated in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    marginsUpdated - the margin update option
    
    Returns:
    
    rectangular chart model
  - getPlotAreaBorderAlpha
```
public java.lang.Double getPlotAreaBorderAlpha()
```
    Specified by:
    
    getPlotAreaBorderAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    opacity of plot area's border
  - setPlotAreaBorderAlpha
```
public T setPlotAreaBorderAlpha(java.lang.Double plotAreaBorderAlpha)
```
    Description copied from interface: RectangularChartModel
    
    Sets the opacity of plot area's border. Value range is 0 - 1. If not set the default value is 0.
    
    Specified by:
    
    setPlotAreaBorderAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    plotAreaBorderAlpha - opacity of plot area's border
    
    Returns:
    
    rectangular chart model
  - getPlotAreaBorderColor
```
public Color getPlotAreaBorderColor()
```
    Specified by:
    
    getPlotAreaBorderColor in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    plot area border color
  - setPlotAreaBorderColor
```
public T setPlotAreaBorderColor(Color plotAreaBorderColor)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setPlotAreaBorderColor in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    plotAreaBorderColor - the plot area border color
    
    Returns:
    
    rectangular chart model
  - getPlotAreaFillAlphas
```
public java.lang.Double getPlotAreaFillAlphas()
```
    Specified by:
    
    getPlotAreaFillAlphas in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    opacity of plot area
  - setPlotAreaFillAlphas
```
public T setPlotAreaFillAlphas(java.lang.Double plotAreaFillAlphas)
```
    Description copied from interface: RectangularChartModel
    
    Sets opacity of plot area. If not set the default value is 0.
    
    Specified by:
    
    setPlotAreaFillAlphas in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    plotAreaFillAlphas - opacity
    
    Returns:
    
    rectangular chart model
  - getPlotAreaFillColors
```
public java.util.List<Color> getPlotAreaFillColors()
```
    Specified by:
    
    getPlotAreaFillColors in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    list of plot area colors
  - setPlotAreaFillColors
```
public T setPlotAreaFillColors(java.util.List<Color> plotAreaFillColors)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setPlotAreaFillColors in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    plotAreaFillColors - list of plot area colors
    
    Returns:
    
    rectangular chart model
  - getPlotAreaGradientAngle
```
public java.lang.Integer getPlotAreaGradientAngle()
```
    Specified by:
    
    getPlotAreaGradientAngle in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    plot area gradient angle
  - setPlotAreaGradientAngle
```
public T setPlotAreaGradientAngle(java.lang.Integer plotAreaGradientAngle)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setPlotAreaGradientAngle in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    plotAreaGradientAngle - the plot area gradient angle
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonAlpha
```
public java.lang.Double getZoomOutButtonAlpha()
```
    Specified by:
    
    getZoomOutButtonAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    opacity of zoom-out button background
  - setZoomOutButtonAlpha
```
public T setZoomOutButtonAlpha(java.lang.Double zoomOutButtonAlpha)
```
    Description copied from interface: RectangularChartModel
    
    Sets opacity of zoom-out button background. If not set the default value is 0.
    
    Specified by:
    
    setZoomOutButtonAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonAlpha - opacity of zoom-out button background
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonColor
```
public Color getZoomOutButtonColor()
```
    Specified by:
    
    getZoomOutButtonColor in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom-out button background color
  - setZoomOutButtonColor
```
public T setZoomOutButtonColor(Color zoomOutButtonColor)
```
    Description copied from interface: RectangularChartModel
    
    Sets zoom-out button background color. If not set the default value is #e5e5e5.
    
    Specified by:
    
    setZoomOutButtonColor in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonColor - zoom-out button background color
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonImage
```
public java.lang.String getZoomOutButtonImage()
```
    Specified by:
    
    getZoomOutButtonImage in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom out button image name
  - setZoomOutButtonImage
```
public T setZoomOutButtonImage(java.lang.String zoomOutButtonImage)
```
    Description copied from interface: RectangularChartModel
    
    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".
    
    Specified by:
    
    setZoomOutButtonImage in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonImage - zoom out button image name string
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonImageSize
```
public java.lang.Integer getZoomOutButtonImageSize()
```
    Specified by:
    
    getZoomOutButtonImageSize in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom out button image size
  - setZoomOutButtonImageSize
```
public T setZoomOutButtonImageSize(java.lang.Integer zoomOutButtonImageSize)
```
    Description copied from interface: RectangularChartModel
    
    Sets the size of zoom-out button image. If not set the default value is 17.
    
    Specified by:
    
    setZoomOutButtonImageSize in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonImageSize - the zoom out button image size
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonPadding
```
public java.lang.Integer getZoomOutButtonPadding()
```
    Specified by:
    
    getZoomOutButtonPadding in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom out button padding
  - setZoomOutButtonPadding
```
public T setZoomOutButtonPadding(java.lang.Integer zoomOutButtonPadding)
```
    Description copied from interface: RectangularChartModel
    
    Sets padding around the text and image. If not set the default value is 8.
    
    Specified by:
    
    setZoomOutButtonPadding in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonPadding - the zoom out button padding
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonRollOverAlpha
```
public java.lang.Double getZoomOutButtonRollOverAlpha()
```
    Specified by:
    
    getZoomOutButtonRollOverAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    opacity of zoom-out button background
  - setZoomOutButtonRollOverAlpha
```
public T setZoomOutButtonRollOverAlpha(java.lang.Double zoomOutButtonRollOverAlpha)
```
    Description copied from interface: RectangularChartModel
    
    Sets opacity of zoom-out button background when mouse is over it. If not set the default value is 1.
    
    Specified by:
    
    setZoomOutButtonRollOverAlpha in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonRollOverAlpha - opacity of zoom-out button background
    
    Returns:
    
    rectangular chart model
  - getZoomOutText
```
public java.lang.String getZoomOutText()
```
    Specified by:
    
    getZoomOutText in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom out text
  - setZoomOutText
```
public T setZoomOutText(java.lang.String zoomOutText)
```
    Description copied from interface: RectangularChartModel
    
    Sets text in the zoom-out button. If not set the default value is "Show all".
    
    Specified by:
    
    setZoomOutText in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutText - zoom out text string
    
    Returns:
    
    rectangular chart model
  - getMaxZoomFactor
```
public java.lang.Integer getMaxZoomFactor()
```
    Specified by:
    
    getMaxZoomFactor in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    maximum zoom factor
  - setMaxZoomFactor
```
public T setMaxZoomFactor(java.lang.Integer maxZoomFactor)
```
    Description copied from interface: RectangularChartModel
    
    Sets the maximum zoom factor value axes. If not set the default value is 20.
    
    Specified by:
    
    setMaxZoomFactor in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    maxZoomFactor - maximum zoom factor
    
    Returns:
    
    rectangular chart model
  - getMinMarginBottom
```
public java.lang.Integer getMinMarginBottom()
```
    Specified by:
    
    getMinMarginBottom in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    minimum margin bottom
  - setMinMarginBottom
```
public T setMinMarginBottom(java.lang.Integer minMarginBottom)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setMinMarginBottom in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    minMarginBottom - the minimum margin bottom
    
    Returns:
    
    rectangular chart model
  - getMinMarginLeft
```
public java.lang.Integer getMinMarginLeft()
```
    Specified by:
    
    getMinMarginLeft in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    minimum margin left
  - setMinMarginLeft
```
public T setMinMarginLeft(java.lang.Integer minMarginLeft)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setMinMarginLeft in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    minMarginLeft - the minimum margin left
    
    Returns:
    
    rectangular chart model
  - getMinMarginRight
```
public java.lang.Integer getMinMarginRight()
```
    Specified by:
    
    getMinMarginRight in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    minimum margin right
  - setMinMarginRight
```
public T setMinMarginRight(java.lang.Integer minMarginRight)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setMinMarginRight in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    minMarginRight - the minimum margin right
    
    Returns:
    
    rectangular chart model
  - getMinMarginTop
```
public java.lang.Integer getMinMarginTop()
```
    Specified by:
    
    getMinMarginTop in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    minimum margin top
  - setMinMarginTop
```
public T setMinMarginTop(java.lang.Integer minMarginTop)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setMinMarginTop in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    minMarginTop - the minimum margin top
    
    Returns:
    
    rectangular chart model
  - getZoomOutButtonTabIndex
```
public java.lang.Integer getZoomOutButtonTabIndex()
```
    Specified by:
    
    getZoomOutButtonTabIndex in interface RectangularChartModel<T extends RectangularChart>
    
    Returns:
    
    zoom out button tab index
  - setZoomOutButtonTabIndex
```
public T setZoomOutButtonTabIndex(java.lang.Integer zoomOutButtonTabIndex)
```
    Description copied from interface: RectangularChartModel
    
    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.
    
    Specified by:
    
    setZoomOutButtonTabIndex in interface RectangularChartModel<T extends RectangularChart>
    
    Parameters:
    
    zoomOutButtonTabIndex - the zoom out button tab index
    
    Returns:
    
    rectangular chart model
  - addCursorPeriodSelectListener
```
public io.jmix.core.common.event.Subscription addCursorPeriodSelectListener(java.util.function.Consumer<Chart.CursorPeriodSelectEvent> listener)
```
    Description copied from interface: RectangularChart
    
    Adds a listener for period selection by cursor. Called when value of the cursor period changed.
    
    Specified by:
    
    addCursorPeriodSelectListener in interface RectangularChart<T extends RectangularChart>
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    subscription
  - onCursorPeriodSelect
```
protected void onCursorPeriodSelect(CursorPeriodSelectEvent e)
```
  - addCursorZoomListener
```
public io.jmix.core.common.event.Subscription addCursorZoomListener(java.util.function.Consumer<Chart.CursorZoomEvent> listener)
```
    Description copied from interface: RectangularChart
    
    Adds a listener for cursor zoom. Called when value of the cursor zoom changed.
    
    Specified by:
    
    addCursorZoomListener in interface RectangularChart<T extends RectangularChart>
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    subscription
  - onCursorZoom
```
protected void onCursorZoom(CursorZoomEvent e)
```

Class RectangularChartImpl<T extends RectangularChart,M extends RectangularChartModelImpl>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.charts.component.Chart

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

Field Summary

Fields inherited from class io.jmix.charts.component.impl.CoordinateChartImpl

Fields inherited from class io.jmix.charts.component.impl.ChartImpl

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

Fields inherited from interface io.jmix.ui.component.Component

Constructor Summary

Method Summary

Methods inherited from class io.jmix.charts.component.impl.CoordinateChartImpl

Methods inherited from class io.jmix.charts.component.impl.ChartImpl

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.charts.component.CoordinateChart

Methods inherited from interface io.jmix.charts.component.Chart

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

Methods inherited from interface io.jmix.ui.component.Component

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

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

Field Detail

periodSelectHandler

cursorZoomHandler

Constructor Detail

RectangularChartImpl

Method Detail

setupDefaults

setupRectangularChartDefaults

getChartCursor

setChartCursor

getChartScrollbar

setChartScrollbar

getTrendLines

setTrendLines

addTrendLines

getAngle

setAngle

getAutoMarginOffset

setAutoMarginOffset

getAutoMargins

setAutoMargins

getDepth3D

setDepth3D

getMarginBottom

setMarginBottom

getMarginLeft

setMarginLeft

getMarginRight

setMarginRight

getMarginTop

setMarginTop

getMarginsUpdated

setMarginsUpdated

getPlotAreaBorderAlpha

setPlotAreaBorderAlpha

getPlotAreaBorderColor

setPlotAreaBorderColor

getPlotAreaFillAlphas

setPlotAreaFillAlphas

getPlotAreaFillColors

setPlotAreaFillColors

getPlotAreaGradientAngle

setPlotAreaGradientAngle

getZoomOutButtonAlpha

setZoomOutButtonAlpha

getZoomOutButtonColor

setZoomOutButtonColor

getZoomOutButtonImage

setZoomOutButtonImage

getZoomOutButtonImageSize

setZoomOutButtonImageSize

getZoomOutButtonPadding

setZoomOutButtonPadding