io.jmix.charts.model.chart

Interface SeriesBasedChartModel<T extends SeriesBasedChartModel>

All Superinterfaces:

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

All Known Subinterfaces:

GanttChart, GanttChartModel<T>, SerialChart, SeriesBasedChart<T>

All Known Implementing Classes:

AbstractSerialChart, GanttChartImpl, GanttChartModelImpl, SerialChartImpl, SerialChartModelImpl, SeriesBasedChartImpl, StockPanel

public interface SeriesBasedChartModel<T extends SeriesBasedChartModel>
extends RectangularChartModel<T>

Method Summary

Modifier and Type	Method and Description
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()
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.
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.

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, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

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

getStartDuration, getStartEffect, setStartDuration, setStartEffect

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

addColors, getColors, setColors

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

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

Method Detail

getCategoryAxis

CategoryAxis getCategoryAxis()

Returns:

category axis

setCategoryAxis

T setCategoryAxis(CategoryAxis categoryAxis)

Sets the category axis.

Parameters:

categoryAxis - the category axis

Returns:

chart model

getCategoryField

java.lang.String getCategoryField()

Returns:

category field name

setCategoryField

@StudioProperty(type=PROPERTY_PATH_REF)
T setCategoryField(java.lang.String categoryField)

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.

Parameters:

categoryField - category field name string

Returns:

chart model

getBalloonDateFormat

java.lang.String getBalloonDateFormat()

Returns:

balloon date format

setBalloonDateFormat

@StudioProperty(defaultValue="MMM DD, YYYY")
T setBalloonDateFormat(java.lang.String balloonDateFormat)

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

Parameters:

balloonDateFormat - the balloon date format

Returns:

chart model

getColumnSpacing3D

java.lang.Integer getColumnSpacing3D()

Returns:

space between 3D stacked columns

setColumnSpacing3D

@StudioProperty(defaultValue="0")
T setColumnSpacing3D(java.lang.Integer columnSpacing3D)

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

Parameters:

columnSpacing3D - space between 3D stacked columns

Returns:

chart model

getColumnSpacing

java.lang.Integer getColumnSpacing()

Returns:

column spacing in pixels

setColumnSpacing

@StudioProperty(defaultValue="5")
T setColumnSpacing(java.lang.Integer columnSpacing)

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

Parameters:

columnSpacing - column spacing in pixels

Returns:

chart model

getColumnWidth

java.lang.Double getColumnWidth()

Returns:

relative width of columns

setColumnWidth

@StudioProperty(defaultValue="0.8")
 @Max(value=1L)
 @Min(value=0L)
T setColumnWidth(java.lang.Double columnWidth)

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

Parameters:

columnWidth - relative width of columns

Returns:

chart model

getDataDateFormat

java.lang.String getDataDateFormat()

Returns:

data date format

setDataDateFormat

@StudioProperty
T setDataDateFormat(java.lang.String dataDateFormat)

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.

Parameters:

dataDateFormat - data date format string

Returns:

chart model

getMaxSelectedSeries

java.lang.Integer getMaxSelectedSeries()

Returns:

maximum number of selected series

setMaxSelectedSeries

@StudioProperty
T setMaxSelectedSeries(java.lang.Integer maxSelectedSeries)

Sets maximum number of series allowed to select.

Parameters:

maxSelectedSeries - the maximum number of selected series

Returns:

chart model

getMaxSelectedTime

java.lang.Long getMaxSelectedTime()

Returns:

maximum selected time in milliseconds

setMaxSelectedTime

@StudioProperty
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. Works if CategoryAxis.equalSpacing is set to false.

Parameters:

maxSelectedTime - the maximum selected time in milliseconds

Returns:

chart model

getMinSelectedTime

java.lang.Long getMinSelectedTime()

Returns:

minimum selected time in milliseconds

setMinSelectedTime

@StudioProperty(defaultValue="0")
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. Works if CategoryAxis.equalSpacing is set to false. If not set the default value is 0.

Parameters:

minSelectedTime - the minimum selected time in milliseconds

Returns:

chart model

getMouseWheelScrollEnabled

java.lang.Boolean getMouseWheelScrollEnabled()

Returns:

true if scroll chart with the mouse wheel is enabled

setMouseWheelScrollEnabled

@StudioProperty(defaultValue="false")
T setMouseWheelScrollEnabled(java.lang.Boolean mouseWheelScrollEnabled)

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.

Parameters:

mouseWheelScrollEnabled - mouse wheel scroll option

Returns:

chart model

getRotate

java.lang.Boolean getRotate()

Returns:

true if rotate is enabled

setRotate

@StudioProperty(defaultValue="false")
T setRotate(java.lang.Boolean rotate)

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.

Parameters:

rotate - rotate option

Returns:

chart model

getZoomOutOnDataUpdate

java.lang.Boolean getZoomOutOnDataUpdate()

Returns:

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

setZoomOutOnDataUpdate

@StudioProperty(defaultValue="true")
T setZoomOutOnDataUpdate(java.lang.Boolean zoomOutOnDataUpdate)

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

Parameters:

zoomOutOnDataUpdate - zoomOutOnDataUpdate option

Returns:

chart model

getMouseWheelZoomEnabled

java.lang.Boolean getMouseWheelZoomEnabled()

Returns:

true if zooming of a chart with mouse wheel is enabled

setMouseWheelZoomEnabled

@StudioProperty(defaultValue="false")
T setMouseWheelZoomEnabled(java.lang.Boolean mouseWheelZoomEnabled)

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.

Parameters:

mouseWheelZoomEnabled - mouseWheelZoomEnabled option

Returns:

chart model

getValueScrollbar

Scrollbar getValueScrollbar()

Returns:

value scrollbar

setValueScrollbar

T setValueScrollbar(Scrollbar valueScrollbar)

Sets value scrollbar, enables scrolling value axes.

Parameters:

valueScrollbar - the value scrollbar

Returns:

chart model

getSynchronizeGrid

java.lang.Boolean getSynchronizeGrid()

Returns:

true if synchronized grid is enabled

setSynchronizeGrid

@StudioProperty
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. This helps users to compare values more easily.

Parameters:

synchronizeGrid - synchronized grid option

Returns:

chart model