io.jmix.charts.component.impl

Class SeriesBasedChartImpl<T extends SeriesBasedChart,M extends AbstractSerialChart>

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>

io.jmix.charts.component.impl.SeriesBasedChartImpl<T,M>

All Implemented Interfaces:

Chart<T>, CoordinateChart<T>, RectangularChart<T>, SeriesBasedChart<T>, HasStartEffect<T>, ChartModel<T>, CoordinateChartModel<T>, RectangularChartModel<T>, SeriesBasedChartModel<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:

GanttChartImpl, SerialChartImpl

public abstract class SeriesBasedChartImpl<T extends SeriesBasedChart,M extends AbstractSerialChart>
extends RectangularChartImpl<T,M>
implements SeriesBasedChart<T>

Nested Class Summary

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

SeriesBasedChart.CategoryItemClickEvent

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 CategoryItemClickListener	categoryItemClickHandler
protected ZoomListener	zoomHandler

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

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

Constructor Summary

Constructors

Constructor and Description
SeriesBasedChartImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addCategoryItemClickListener(java.util.function.Consumer<SeriesBasedChart.CategoryItemClickEvent> listener) Adds a listener for category item click.
io.jmix.core.common.event.Subscription	addZoomListener(java.util.function.Consumer<Chart.ZoomEvent> listener) Adds a listener for zoom.
protected void	detectDateBasedCategoryAxis()
java.lang.String	getBalloonDateFormat()
CategoryAxis	getCategoryAxis()
java.lang.String	getCategoryField()
java.lang.Integer	getColumnSpacing()
java.lang.Integer	getColumnSpacing3D()
java.lang.Double	getColumnWidth()
java.lang.String	getDataDateFormat()
java.lang.Integer	getMaxSelectedSeries()
java.lang.Long	getMaxSelectedTime()
java.lang.Long	getMinSelectedTime()
java.lang.Boolean	getMouseWheelScrollEnabled()
java.lang.Boolean	getMouseWheelZoomEnabled()
java.lang.Boolean	getRotate()
java.lang.Boolean	getSynchronizeGrid()
Scrollbar	getValueScrollbar()
java.lang.Boolean	getZoomOutOnDataUpdate()
protected void	onCategoryItemClick(CategoryItemClickEvent e)
protected void	onZoomEvent(ZoomEvent e)
T	setBalloonDateFormat(java.lang.String balloonDateFormat) Sets date format of the graph balloon (if chart parses dates and you don't use Cursor).
T	setCategoryAxis(CategoryAxis categoryAxis) Sets the category axis.
T	setCategoryField(java.lang.String categoryField) Sets the category field name.
T	setColumnSpacing(java.lang.Integer columnSpacing) Sets the gap in pixels between two columns of the same category.
T	setColumnSpacing3D(java.lang.Integer columnSpacing3D) Sets space between 3D stacked columns.
T	setColumnWidth(java.lang.Double columnWidth) Sets relative width of columns.
T	setDataDateFormat(java.lang.String dataDateFormat) Sets data date format.
T	setMaxSelectedSeries(java.lang.Integer maxSelectedSeries) Sets maximum number of series allowed to select.
T	setMaxSelectedTime(java.lang.Long maxSelectedTime) Sets the longest time span allowed to select in milliseconds for example, 259200000 will limit selection to 3 days.
T	setMinSelectedTime(java.lang.Long minSelectedTime) Sets the shortest time span allowed to select in milliseconds for example, 1000 will limit selection to 1 second.
T	setMouseWheelScrollEnabled(java.lang.Boolean mouseWheelScrollEnabled) Set true if you want scroll chart with the mouse wheel.
T	setMouseWheelZoomEnabled(java.lang.Boolean mouseWheelZoomEnabled) Set mouseWheelZoomEnabled to true if zooming of a chart with mouse wheel should be enabled.
T	setRotate(java.lang.Boolean rotate) Set rotate to true, if the chart should be rotated by 90 degrees (the columns will become bars).
T	setSynchronizeGrid(java.lang.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.
protected void	setupDefaults(M chart)
protected void	setupSerialChartDefaults(AbstractSerialChart chart)
T	setValueScrollbar(Scrollbar valueScrollbar) Sets value scrollbar, enables scrolling value axes.
T	setZoomOutOnDataUpdate(java.lang.Boolean zoomOutOnDataUpdate) Set zoomOutOnDataUpdate to true if chart should be zoom-out when data is updated.
void	zoomOut() Zooms out, charts shows all available data.
void	zoomToDates(java.util.Date start, java.util.Date end) Zooms the chart from one date to another.
void	zoomToIndexes(int start, int end) Zooms the chart by the index of the category.

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

addCursorPeriodSelectListener, addCursorZoomListener, addTrendLines, getAngle, getAutoMarginOffset, getAutoMargins, getChartCursor, getChartScrollbar, getDepth3D, getMarginBottom, getMarginLeft, getMarginRight, getMarginsUpdated, getMarginTop, getMaxZoomFactor, getMinMarginBottom, getMinMarginLeft, getMinMarginRight, getMinMarginTop, getPlotAreaBorderAlpha, getPlotAreaBorderColor, getPlotAreaFillAlphas, getPlotAreaFillColors, getPlotAreaGradientAngle, getTrendLines, getZoomOutButtonAlpha, getZoomOutButtonColor, getZoomOutButtonImage, getZoomOutButtonImageSize, getZoomOutButtonPadding, getZoomOutButtonRollOverAlpha, getZoomOutButtonTabIndex, getZoomOutText, onCursorPeriodSelect, onCursorZoom, setAngle, setAutoMarginOffset, setAutoMargins, setChartCursor, setChartScrollbar, setDepth3D, setMarginBottom, setMarginLeft, setMarginRight, setMarginsUpdated, setMarginTop, setMaxZoomFactor, setMinMarginBottom, setMinMarginLeft, setMinMarginRight, setMinMarginTop, setPlotAreaBorderAlpha, setPlotAreaBorderColor, setPlotAreaFillAlphas, setPlotAreaFillColors, setPlotAreaGradientAngle, setTrendLines, setupRectangularChartDefaults, setZoomOutButtonAlpha, setZoomOutButtonColor, setZoomOutButtonImage, setZoomOutButtonImageSize, setZoomOutButtonPadding, setZoomOutButtonRollOverAlpha, setZoomOutButtonTabIndex, setZoomOutText

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.RectangularChart

addCursorPeriodSelectListener, addCursorZoomListener

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.RectangularChartModel

addTrendLines, getAngle, getAutoMarginOffset, getAutoMargins, getChartCursor, getChartScrollbar, getDepth3D, getMarginsUpdated, getMaxZoomFactor, getMinMarginBottom, getMinMarginLeft, getMinMarginRight, getMinMarginTop, getPlotAreaBorderAlpha, getPlotAreaBorderColor, getPlotAreaFillAlphas, getPlotAreaFillColors, getPlotAreaGradientAngle, getTrendLines, getZoomOutButtonAlpha, getZoomOutButtonColor, getZoomOutButtonImage, getZoomOutButtonImageSize, getZoomOutButtonPadding, getZoomOutButtonRollOverAlpha, getZoomOutButtonTabIndex, getZoomOutText, setAngle, setAutoMarginOffset, setAutoMargins, setChartCursor, setChartScrollbar, setDepth3D, setMarginsUpdated, setMaxZoomFactor, setMinMarginBottom, setMinMarginLeft, setMinMarginRight, setMinMarginTop, setPlotAreaBorderAlpha, setPlotAreaBorderColor, setPlotAreaFillAlphas, setPlotAreaFillColors, setPlotAreaGradientAngle, setTrendLines, setZoomOutButtonAlpha, setZoomOutButtonColor, setZoomOutButtonImage, setZoomOutButtonImageSize, setZoomOutButtonPadding, setZoomOutButtonRollOverAlpha, setZoomOutButtonTabIndex, setZoomOutText

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

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

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Field Detail

zoomHandler

protected ZoomListener zoomHandler

categoryItemClickHandler

protected CategoryItemClickListener categoryItemClickHandler

Constructor Detail

SeriesBasedChartImpl

public SeriesBasedChartImpl()

Method Detail

setupDefaults

protected void setupDefaults(M chart)

Overrides:

setupDefaults in class RectangularChartImpl<T extends SeriesBasedChart,M extends AbstractSerialChart>

setupSerialChartDefaults

protected void setupSerialChartDefaults(AbstractSerialChart chart)

detectDateBasedCategoryAxis

protected void detectDateBasedCategoryAxis()

getCategoryAxis

public CategoryAxis getCategoryAxis()

Specified by:

getCategoryAxis in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

category axis

setCategoryAxis

public T setCategoryAxis(CategoryAxis categoryAxis)

Description copied from interface: SeriesBasedChartModel

Sets the category axis.

Specified by:

setCategoryAxis in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

categoryAxis - the category axis

Returns:

chart model

getCategoryField

public java.lang.String getCategoryField()

Specified by:

getCategoryField in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

category field name

setCategoryField

public T setCategoryField(java.lang.String categoryField)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setCategoryField in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

categoryField - category field name string

Returns:

chart model

getBalloonDateFormat

public java.lang.String getBalloonDateFormat()

Specified by:

getBalloonDateFormat in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

balloon date format

setBalloonDateFormat

public T setBalloonDateFormat(java.lang.String balloonDateFormat)

Description copied from interface: SeriesBasedChartModel

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".

Specified by:

setBalloonDateFormat in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

balloonDateFormat - the balloon date format

Returns:

chart model

getColumnSpacing3D

public java.lang.Integer getColumnSpacing3D()

Specified by:

getColumnSpacing3D in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

space between 3D stacked columns

setColumnSpacing3D

public T setColumnSpacing3D(java.lang.Integer columnSpacing3D)

Description copied from interface: SeriesBasedChartModel

Sets space between 3D stacked columns. If not set the default value is 0.

Specified by:

setColumnSpacing3D in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

columnSpacing3D - space between 3D stacked columns

Returns:

chart model

getColumnSpacing

public java.lang.Integer getColumnSpacing()

Specified by:

getColumnSpacing in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

column spacing in pixels

setColumnSpacing

public T setColumnSpacing(java.lang.Integer columnSpacing)

Description copied from interface: SeriesBasedChartModel

Sets the gap in pixels between two columns of the same category. If not set the default value is 5.

Specified by:

setColumnSpacing in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

columnSpacing - column spacing in pixels

Returns:

chart model

getColumnWidth

public java.lang.Double getColumnWidth()

Specified by:

getColumnWidth in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

relative width of columns

setColumnWidth

public T setColumnWidth(java.lang.Double columnWidth)

Description copied from interface: SeriesBasedChartModel

Sets relative width of columns. Value range is 0 - 1. If not set the default value is 0.8.

Specified by:

setColumnWidth in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

columnWidth - relative width of columns

Returns:

chart model

getDataDateFormat

public java.lang.String getDataDateFormat()

Specified by:

getDataDateFormat in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

data date format

setDataDateFormat

public T setDataDateFormat(java.lang.String dataDateFormat)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setDataDateFormat in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

dataDateFormat - data date format string

Returns:

chart model

getMaxSelectedSeries

public java.lang.Integer getMaxSelectedSeries()

Specified by:

getMaxSelectedSeries in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

maximum number of selected series

setMaxSelectedSeries

public T setMaxSelectedSeries(java.lang.Integer maxSelectedSeries)

Description copied from interface: SeriesBasedChartModel

Sets maximum number of series allowed to select.

Specified by:

setMaxSelectedSeries in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

maxSelectedSeries - the maximum number of selected series

Returns:

chart model

getMaxSelectedTime

public java.lang.Long getMaxSelectedTime()

Specified by:

getMaxSelectedTime in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

maximum selected time in milliseconds

setMaxSelectedTime

public T setMaxSelectedTime(java.lang.Long maxSelectedTime)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setMaxSelectedTime in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

maxSelectedTime - the maximum selected time in milliseconds

Returns:

chart model

getMinSelectedTime

public java.lang.Long getMinSelectedTime()

Specified by:

getMinSelectedTime in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

minimum selected time in milliseconds

setMinSelectedTime

public T setMinSelectedTime(java.lang.Long minSelectedTime)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setMinSelectedTime in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

minSelectedTime - the minimum selected time in milliseconds

Returns:

chart model

getMouseWheelScrollEnabled

public java.lang.Boolean getMouseWheelScrollEnabled()

Specified by:

getMouseWheelScrollEnabled in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

true if scroll chart with the mouse wheel is enabled

setMouseWheelScrollEnabled

public T setMouseWheelScrollEnabled(java.lang.Boolean mouseWheelScrollEnabled)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setMouseWheelScrollEnabled in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

mouseWheelScrollEnabled - mouse wheel scroll option

Returns:

chart model

getRotate

public java.lang.Boolean getRotate()

Specified by:

getRotate in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

true if rotate is enabled

setRotate

public T setRotate(java.lang.Boolean rotate)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setRotate in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

rotate - rotate option

Returns:

chart model

getZoomOutOnDataUpdate

public java.lang.Boolean getZoomOutOnDataUpdate()

Specified by:

getZoomOutOnDataUpdate in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

true if chart should be zoom-out when data is updated

setZoomOutOnDataUpdate

public T setZoomOutOnDataUpdate(java.lang.Boolean zoomOutOnDataUpdate)

Description copied from interface: SeriesBasedChartModel

Set zoomOutOnDataUpdate to true if chart should be zoom-out when data is updated. If not set the default value is true.

Specified by:

setZoomOutOnDataUpdate in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

zoomOutOnDataUpdate - zoomOutOnDataUpdate option

Returns:

chart model

getMouseWheelZoomEnabled

public java.lang.Boolean getMouseWheelZoomEnabled()

Specified by:

getMouseWheelZoomEnabled in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

true if zooming of a chart with mouse wheel is enabled

setMouseWheelZoomEnabled

public T setMouseWheelZoomEnabled(java.lang.Boolean mouseWheelZoomEnabled)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setMouseWheelZoomEnabled in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

mouseWheelZoomEnabled - mouseWheelZoomEnabled option

Returns:

chart model

getValueScrollbar

public Scrollbar getValueScrollbar()

Specified by:

getValueScrollbar in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

value scrollbar

setValueScrollbar

public T setValueScrollbar(Scrollbar valueScrollbar)

Description copied from interface: SeriesBasedChartModel

Sets value scrollbar, enables scrolling value axes.

Specified by:

setValueScrollbar in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

valueScrollbar - the value scrollbar

Returns:

chart model

getSynchronizeGrid

public java.lang.Boolean getSynchronizeGrid()

Specified by:

getSynchronizeGrid in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Returns:

true if synchronized grid is enabled

setSynchronizeGrid

public T setSynchronizeGrid(java.lang.Boolean synchronizeGrid)

Description copied from interface: SeriesBasedChartModel

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.

Specified by:

setSynchronizeGrid in interface SeriesBasedChartModel<T extends SeriesBasedChart>

Parameters:

synchronizeGrid - synchronized grid option

Returns:

chart model

zoomOut

public void zoomOut()

Description copied from interface: SeriesBasedChart

Zooms out, charts shows all available data.

Specified by:

zoomOut in interface SeriesBasedChart<T extends SeriesBasedChart>

zoomToIndexes

public void zoomToIndexes(int start,
                          int end)

Description copied from interface: SeriesBasedChart

Zooms the chart by the index of the category.

Specified by:

zoomToIndexes in interface SeriesBasedChart<T extends SeriesBasedChart>

Parameters:

start - start index

end - end index

zoomToDates

public void zoomToDates(java.util.Date start,
                        java.util.Date end)

Description copied from interface: SeriesBasedChart

Zooms the chart from one date to another.

Specified by:

zoomToDates in interface SeriesBasedChart<T extends SeriesBasedChart>

Parameters:

start - start date

end - end date

addZoomListener

public io.jmix.core.common.event.Subscription addZoomListener(java.util.function.Consumer<Chart.ZoomEvent> listener)

Description copied from interface: SeriesBasedChart

Adds a listener for zoom. Called when value of the chart zoom changed.

Specified by:

addZoomListener in interface SeriesBasedChart<T extends SeriesBasedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onZoomEvent

protected void onZoomEvent(ZoomEvent e)

addCategoryItemClickListener

public io.jmix.core.common.event.Subscription addCategoryItemClickListener(java.util.function.Consumer<SeriesBasedChart.CategoryItemClickEvent> listener)

Description copied from interface: SeriesBasedChart

Adds a listener for category item click. Called when user clicks on the category.

Specified by:

addCategoryItemClickListener in interface SeriesBasedChart<T extends SeriesBasedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onCategoryItemClick

protected void onCategoryItemClick(CategoryItemClickEvent e)