io.jmix.charts.model.chart

Interface XYChartModel<T extends XYChartModel>

All Superinterfaces:

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

All Known Subinterfaces:

XYChart

All Known Implementing Classes:

XYChartImpl, XYChartModelImpl

public interface XYChartModel<T extends XYChartModel>
extends RectangularChartModel<T>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataDateFormat()
java.lang.Boolean	getHideXScrollbar()
java.lang.Boolean	getHideYScrollbar()
java.lang.Integer	getMaxValue()
java.lang.Integer	getMinValue()
T	setDataDateFormat(java.lang.String dataDateFormat) Sets the data date format (date/time).
T	setHideXScrollbar(java.lang.Boolean hideXScrollbar) Set hideXScrollbar to true if scrollbar of X axis (horizontal) should be hidden.
T	setHideYScrollbar(java.lang.Boolean hideYScrollbar) Set hideYScrollbar to true if scrollbar of Y axis (vertical) should be hidden.
T	setMaxValue(java.lang.Integer maxValue) Sets the size/scale of bubbles.
T	setMinValue(java.lang.Integer minValue) Sets the size/scale of bubbles.

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

getHideXScrollbar

java.lang.Boolean getHideXScrollbar()

Returns:

true if scrollbar of X axis (horizontal) is hidden

setHideXScrollbar

T setHideXScrollbar(java.lang.Boolean hideXScrollbar)

Set hideXScrollbar to true if scrollbar of X axis (horizontal) should be hidden. If not set the default value is false.

Parameters:

hideXScrollbar - hide X scrollbar option

Returns:

XY chart model

getHideYScrollbar

java.lang.Boolean getHideYScrollbar()

Returns:

true if scrollbar of Y axis (vertical) is hidden

setHideYScrollbar

T setHideYScrollbar(java.lang.Boolean hideYScrollbar)

Set hideYScrollbar to true if scrollbar of Y axis (vertical) should be hidden. If not set the default value is false.

Parameters:

hideYScrollbar - hide Y scrollbar option

Returns:

XY chart model

getDataDateFormat

java.lang.String getDataDateFormat()

Returns:

data date format

setDataDateFormat

T setDataDateFormat(java.lang.String dataDateFormat)

Sets the data date format (date/time). Use it if you have date-based value axis in your XY chart. 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:

XY chart model

getMaxValue

java.lang.Integer getMaxValue()

Returns:

maximum value of the size/scale of bubbles

setMaxValue

T setMaxValue(java.lang.Integer maxValue)

Sets the size/scale of bubbles. If these properties are not set, the bubble with smallest value will be of minBulletSize and bubble with biggest value will be of maxBulletSize. However, you might want bubble size to change relative to 0 or some other value. In this case you can use minValue and maxValue properties. Note, if you use these two settings, you might also want to set minBulletSize to 0.

Parameters:

maxValue - maximum value of the size/scale of bubbles

Returns:

XY chart model

getMinValue

java.lang.Integer getMinValue()

Returns:

minimum value of the size/scale of bubbles

setMinValue

T setMinValue(java.lang.Integer minValue)

Sets the size/scale of bubbles. If these properties are not set, the bubble with smallest value will be of minBulletSize and bubble with biggest value will be of maxBulletSize. However, you might want bubble size to change relative to 0 or some other value. In this case you can use minValue and maxValue properties. Note, if you use these two settings, you might also want to set minBulletSize to 0.

Parameters:

minValue - minimum value of the size/scale of bubbles

Returns:

XY chart model