Package io.jmix.charts.model.chart.impl

Class AbstractSerialChart<T extends AbstractSerialChart>

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.chart.impl.ChartModelImpl

io.jmix.charts.model.chart.impl.AbstractChart<T>

io.jmix.charts.model.chart.impl.CoordinateChartModelImpl<T>

io.jmix.charts.model.chart.impl.RectangularChartModelImpl<T>

io.jmix.charts.model.chart.impl.AbstractSerialChart<T>

All Implemented Interfaces:

HasStartEffect<T>, ChartModel<T>, CoordinateChartModel<T>, RectangularChartModel<T>, SeriesBasedChartModel<T>, HasColors<T>, HasMargins<T>, Serializable

Direct Known Subclasses:

GanttChartModelImpl, SerialChartModelImpl, StockPanel

public abstract class AbstractSerialChart<T extends AbstractSerialChart>
extends RectangularChartModelImpl<T>
implements SeriesBasedChartModel<T>

See documentation for properties of AmSerialChart JS object.
http://docs.amcharts.com/3/javascriptcharts/AmSerialChart

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.charts.model.chart.impl.AbstractChart

AbstractChart.DataProviderChangeListener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSerialChart(ChartType type)

Method Summary

Modifier and Type	Method	Description
String	getBalloonDateFormat()
CategoryAxis	getCategoryAxis()
String	getCategoryField()
Integer	getColumnSpacing()
Integer	getColumnSpacing3D()
Double	getColumnWidth()
String	getDataDateFormat()
Integer	getMaxSelectedSeries()
Long	getMaxSelectedTime()
Long	getMinSelectedTime()
Boolean	getMouseWheelScrollEnabled()
Boolean	getMouseWheelZoomEnabled()
Boolean	getRotate()
Boolean	getSynchronizeGrid()
Scrollbar	getValueScrollbar()
List<String>	getWiredFields()
Boolean	getZoomOutOnDataUpdate()
T	setBalloonDateFormat(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(String categoryField)	Sets the category field name.
T	setColumnSpacing(Integer columnSpacing)	Sets the gap in pixels between two columns of the same category.
T	setColumnSpacing3D(Integer columnSpacing3D)	Sets space between 3D stacked columns.
T	setColumnWidth(Double columnWidth)	Sets relative width of columns.
T	setDataDateFormat(String dataDateFormat)	Sets data date format.
T	setMaxSelectedSeries(Integer maxSelectedSeries)	Sets maximum number of series allowed to select.
T	setMaxSelectedTime(Long maxSelectedTime)	Sets the longest time span allowed to select in milliseconds for example, 259200000 will limit selection to 3 days.
T	setMinSelectedTime(Long minSelectedTime)	Sets the shortest time span allowed to select in milliseconds for example, 1000 will limit selection to 1 second.
T	setMouseWheelScrollEnabled(Boolean mouseWheelScrollEnabled)	Set true if you want scroll chart with the mouse wheel.
T	setMouseWheelZoomEnabled(Boolean mouseWheelZoomEnabled)	Set mouseWheelZoomEnabled to true if zooming of a chart with mouse wheel should be enabled.
T	setRotate(Boolean rotate)	Set rotate to true, if the chart should be rotated by 90 degrees (the columns will become bars).
T	setSynchronizeGrid(Boolean synchronizeGrid)	Set synchronizeGrid property to true and the chart will adjust minimum and maximum of axes so that the grid would be show at equal intervals.
T	setValueScrollbar(Scrollbar valueScrollbar)	Sets value scrollbar, enables scrolling value axes.
T	setZoomOutOnDataUpdate(Boolean zoomOutOnDataUpdate)	Set zoomOutOnDataUpdate to true if chart should be zoom-out when data is updated.

Methods inherited from class io.jmix.charts.model.chart.impl.RectangularChartModelImpl

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, setAngle, setAutoMarginOffset, setAutoMargins, setChartCursor, setChartScrollbar, setDepth3D, setMarginBottom, setMarginLeft, setMarginRight, setMarginsUpdated, setMarginTop, setMaxZoomFactor, setMinMarginBottom, setMinMarginLeft, setMinMarginRight, setMinMarginTop, setPlotAreaBorderAlpha, setPlotAreaBorderColor, setPlotAreaFillAlphas, setPlotAreaFillColors, setPlotAreaGradientAngle, setTrendLines, setZoomOutButtonAlpha, setZoomOutButtonColor, setZoomOutButtonImage, setZoomOutButtonImageSize, setZoomOutButtonPadding, setZoomOutButtonRollOverAlpha, setZoomOutButtonTabIndex, setZoomOutText

Methods inherited from class io.jmix.charts.model.chart.impl.CoordinateChartModelImpl

addColors, addGraphs, addGuides, addValueAxes, getColors, getGraphs, getGridAboveGraphs, getGuides, getSequencedAnimation, getStartAlpha, getStartDuration, getStartEffect, getUrlTarget, getValueAxes, setColors, setGraphs, setGridAboveGraphs, setGuides, setSequencedAnimation, setStartAlpha, setStartDuration, setStartEffect, setUrlTarget, setValueAxes

Methods inherited from class io.jmix.charts.model.chart.impl.AbstractChart

addAdditionalFields, addData, addDataProviderChangeListener, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, fireDataProviderChanged, 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, getType, getUsePrefixes, removeDataProviderSetListener, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addColors, getColors, setColors

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

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

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

getStartDuration, getStartEffect, setStartDuration, setStartEffect

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

Constructor Details

AbstractSerialChart

protected AbstractSerialChart(ChartType type)

Method Details

getCategoryAxis

public CategoryAxis getCategoryAxis()

Specified by:

getCategoryAxis in interface SeriesBasedChartModel<T extends AbstractSerialChart>

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

Parameters:

categoryAxis - the category axis

Returns:

chart model

getCategoryField

public String getCategoryField()

Specified by:

getCategoryField in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

category field name

setCategoryField

public T setCategoryField(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 AbstractSerialChart>

Parameters:

categoryField - category field name string

Returns:

chart model

getBalloonDateFormat

public String getBalloonDateFormat()

Specified by:

getBalloonDateFormat in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

balloon date format

setBalloonDateFormat

public T setBalloonDateFormat(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 AbstractSerialChart>

Parameters:

balloonDateFormat - the balloon date format

Returns:

chart model

getColumnSpacing3D

public Integer getColumnSpacing3D()

Specified by:

getColumnSpacing3D in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

space between 3D stacked columns

setColumnSpacing3D

public T setColumnSpacing3D(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 AbstractSerialChart>

Parameters:

columnSpacing3D - space between 3D stacked columns

Returns:

chart model

getColumnSpacing

public Integer getColumnSpacing()

Specified by:

getColumnSpacing in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

column spacing in pixels

setColumnSpacing

public T setColumnSpacing(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 AbstractSerialChart>

Parameters:

columnSpacing - column spacing in pixels

Returns:

chart model

getColumnWidth

public Double getColumnWidth()

Specified by:

getColumnWidth in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

relative width of columns

setColumnWidth

public T setColumnWidth(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 AbstractSerialChart>

Parameters:

columnWidth - relative width of columns

Returns:

chart model

getDataDateFormat

public String getDataDateFormat()

Specified by:

getDataDateFormat in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

data date format

setDataDateFormat

public T setDataDateFormat(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 AbstractSerialChart>

Parameters:

dataDateFormat - data date format string

Returns:

chart model

getMaxSelectedSeries

public Integer getMaxSelectedSeries()

Specified by:

getMaxSelectedSeries in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

maximum number of selected series

setMaxSelectedSeries

public T setMaxSelectedSeries(Integer maxSelectedSeries)

Description copied from interface: SeriesBasedChartModel

Sets maximum number of series allowed to select.

Specified by:

setMaxSelectedSeries in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Parameters:

maxSelectedSeries - the maximum number of selected series

Returns:

chart model

getMaxSelectedTime

public Long getMaxSelectedTime()

Specified by:

getMaxSelectedTime in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

maximum selected time in milliseconds

setMaxSelectedTime

public T setMaxSelectedTime(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 AbstractSerialChart>

Parameters:

maxSelectedTime - the maximum selected time in milliseconds

Returns:

chart model

getMinSelectedTime

public Long getMinSelectedTime()

Specified by:

getMinSelectedTime in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

minimum selected time in milliseconds

setMinSelectedTime

public T setMinSelectedTime(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 AbstractSerialChart>

Parameters:

minSelectedTime - the minimum selected time in milliseconds

Returns:

chart model

getMouseWheelScrollEnabled

public Boolean getMouseWheelScrollEnabled()

Specified by:

getMouseWheelScrollEnabled in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

true if scroll chart with the mouse wheel is enabled

setMouseWheelScrollEnabled

public T setMouseWheelScrollEnabled(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 AbstractSerialChart>

Parameters:

mouseWheelScrollEnabled - mouse wheel scroll option

Returns:

chart model

getRotate

public Boolean getRotate()

Specified by:

getRotate in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

true if rotate is enabled

setRotate

public T setRotate(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 AbstractSerialChart>

Parameters:

rotate - rotate option

Returns:

chart model

getZoomOutOnDataUpdate

public Boolean getZoomOutOnDataUpdate()

Specified by:

getZoomOutOnDataUpdate in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

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

setZoomOutOnDataUpdate

public T setZoomOutOnDataUpdate(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 AbstractSerialChart>

Parameters:

zoomOutOnDataUpdate - zoomOutOnDataUpdate option

Returns:

chart model

getMouseWheelZoomEnabled

public Boolean getMouseWheelZoomEnabled()

Specified by:

getMouseWheelZoomEnabled in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

true if zooming of a chart with mouse wheel is enabled

setMouseWheelZoomEnabled

public T setMouseWheelZoomEnabled(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 AbstractSerialChart>

Parameters:

mouseWheelZoomEnabled - mouseWheelZoomEnabled option

Returns:

chart model

getValueScrollbar

public Scrollbar getValueScrollbar()

Specified by:

getValueScrollbar in interface SeriesBasedChartModel<T extends AbstractSerialChart>

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

Parameters:

valueScrollbar - the value scrollbar

Returns:

chart model

getSynchronizeGrid

public Boolean getSynchronizeGrid()

Specified by:

getSynchronizeGrid in interface SeriesBasedChartModel<T extends AbstractSerialChart>

Returns:

true if synchronized grid is enabled

setSynchronizeGrid

public T setSynchronizeGrid(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 AbstractSerialChart>

Parameters:

synchronizeGrid - synchronized grid option

Returns:

chart model

getWiredFields

public List<String> getWiredFields()

Overrides:

getWiredFields in class CoordinateChartModelImpl<T extends AbstractSerialChart>

Returns:

fields of the DataItem that are bound to the chart