io.jmix.charts.model.settings

Class ChartScrollbarSettings

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.settings.ChartScrollbarSettings

All Implemented Interfaces:

java.io.Serializable

public class ChartScrollbarSettings
extends AbstractChartObject

Defines set of properties for chart scrollbar. If there is no default value specified, default value of Scrollbar class will be used.
See documentation for properties of ChartScrollbarSettings JS object.
http://docs.amcharts.com/3/javascriptstockchart/ChartScrollbarSettings

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChartScrollbarSettings()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAutoGridCount()
java.lang.Double	getBackgroundAlpha()
Color	getBackgroundColor()
Color	getColor()
java.lang.Integer	getDragIconHeight()
java.lang.Integer	getDragIconWidth()
java.lang.Boolean	getEnabled()
java.lang.Integer	getFontSize()
java.lang.String	getGraph()
java.lang.Double	getGraphFillAlpha()
Color	getGraphFillColor()
java.lang.Double	getGraphLineAlpha()
Color	getGraphLineColor()
GraphType	getGraphType()
java.lang.Double	getGridAlpha()
Color	getGridColor()
java.lang.Integer	getGridCount()
java.lang.Integer	getHeight()
java.lang.Boolean	getHideResizeGrips()
java.lang.Boolean	getMarkPeriodChange()
ChartScrollbarPosition	getPosition()
java.lang.Boolean	getResizeEnabled()
java.lang.Double	getScrollDuration()
java.lang.Double	getSelectedBackgroundAlpha()
Color	getSelectedBackgroundColor()
java.lang.Double	getSelectedGraphFillAlpha()
Color	getSelectedGraphFillColor()
java.lang.Double	getSelectedGraphLineAlpha()
Color	getSelectedGraphLineColor()
java.lang.Boolean	getUpdateOnReleaseOnly()
java.lang.String	getUsePeriod()
ChartScrollbarSettings	setAutoGridCount(java.lang.Boolean autoGridCount) Set autoGridCount to false if you don't want that the number of gridCount will be specified automatically, according to the axis size.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setBackgroundAlpha(java.lang.Double backgroundAlpha) Sets background opacity.
ChartScrollbarSettings	setBackgroundColor(Color backgroundColor) Sets background color of the scrollbar.
ChartScrollbarSettings	setColor(Color color) Sets text color.
ChartScrollbarSettings	setDragIconHeight(java.lang.Integer dragIconHeight) Sets height of resize grip image.
ChartScrollbarSettings	setDragIconWidth(java.lang.Integer dragIconWidth) Sets width of resize grip image.
ChartScrollbarSettings	setEnabled(java.lang.Boolean enabled) Set enabled false if you don't need scrollbar.
ChartScrollbarSettings	setFontSize(java.lang.Integer fontSize) Sets font size
ChartScrollbarSettings	setGraph(java.lang.String graph) Sets graph which will be displayed in the scrollbar.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setGraphFillAlpha(java.lang.Double graphFillAlpha) Sets graph fill opacity.
ChartScrollbarSettings	setGraphFillColor(Color graphFillColor) Sets graph fill color.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setGraphLineAlpha(java.lang.Double graphLineAlpha) Sets graph line opacity.
ChartScrollbarSettings	setGraphLineColor(Color graphLineColor) Sets graph line color.
ChartScrollbarSettings	setGraphType(GraphType graphType) Sets type of chart scrollbar's graph.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setGridAlpha(java.lang.Double gridAlpha) Sets grid opacity.
ChartScrollbarSettings	setGridColor(Color gridColor) Sets grid color.
ChartScrollbarSettings	setGridCount(java.lang.Integer gridCount) Sets grid count.
ChartScrollbarSettings	setHeight(java.lang.Integer height) Sets height of scrollbar, in pixels.
ChartScrollbarSettings	setHideResizeGrips(java.lang.Boolean hideResizeGrips) Set hideResizeGrips to true if resize grips should be hidden when the mouse is away from the scrollbar.
ChartScrollbarSettings	setMarkPeriodChange(java.lang.Boolean markPeriodChange) Specifies if category axis of scrollbar should mark period change with a different date format.
ChartScrollbarSettings	setPosition(ChartScrollbarPosition position) Sets position of a scrollbar.
ChartScrollbarSettings	setResizeEnabled(java.lang.Boolean resizeEnabled) Set resizeEnabled to false if you want to disable a resizing.
ChartScrollbarSettings	setScrollDuration(java.lang.Double scrollDuration) Sets duration of scrolling, when the user clicks on scrollbar's background, in seconds.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setSelectedBackgroundAlpha(java.lang.Double selectedBackgroundAlpha) Sets selected background opacity.
ChartScrollbarSettings	setSelectedBackgroundColor(Color selectedBackgroundColor) Sets selected background color.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setSelectedGraphFillAlpha(java.lang.Double selectedGraphFillAlpha) Sets selected graph's fill opacity.
ChartScrollbarSettings	setSelectedGraphFillColor(Color selectedGraphFillColor) Sets selected graph's fill color.
@Max(value=1L) @Min(value=0L) ChartScrollbarSettings	setSelectedGraphLineAlpha(java.lang.Double selectedGraphLineAlpha) Sets selected graph's line opacity.
ChartScrollbarSettings	setSelectedGraphLineColor(Color selectedGraphLineColor) Sets selected graph's line color.
ChartScrollbarSettings	setUpdateOnReleaseOnly(java.lang.Boolean updateOnReleaseOnly) Set updateOnReleaseOnly to true if the chart should be updated only at the moment when user releases mouse button.
ChartScrollbarSettings	setUsePeriod(java.lang.String usePeriod) Sets the date period for the scrollbar.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartScrollbarSettings

public ChartScrollbarSettings()

Method Detail

getAutoGridCount

public java.lang.Boolean getAutoGridCount()

Returns:

true if number of gridCount is specified automatically, according to the axis size

setAutoGridCount

@StudioProperty(defaultValue="true")
public ChartScrollbarSettings setAutoGridCount(java.lang.Boolean autoGridCount)

Set autoGridCount to false if you don't want that the number of gridCount will be specified automatically, according to the axis size. If not set the default value is true.

Parameters:

autoGridCount - autoGridCount option

Returns:

chart scrollbar settings

getBackgroundAlpha

public java.lang.Double getBackgroundAlpha()

Returns:

background opacity

setBackgroundAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setBackgroundAlpha(java.lang.Double backgroundAlpha)

Sets background opacity.

Parameters:

backgroundAlpha - background opacity

Returns:

chart scrollbar settings

getBackgroundColor

public Color getBackgroundColor()

Returns:

background color of the scrollbar

setBackgroundColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setBackgroundColor(Color backgroundColor)

Sets background color of the scrollbar.

Parameters:

backgroundColor - background color

Returns:

chart scrollbar settings

getColor

public Color getColor()

Returns:

text color

setColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setColor(Color color)

Sets text color.

Parameters:

color - text color

Returns:

chart scrollbar settings

getDragIconHeight

public java.lang.Integer getDragIconHeight()

Returns:

height of resize grip image

setDragIconHeight

@StudioProperty(defaultValue="18")
public ChartScrollbarSettings setDragIconHeight(java.lang.Integer dragIconHeight)

Sets height of resize grip image. Note, you should also update the image in amcharts/images folder if you don't want it to be distorted because of resizing. If not set the default value is 18.

Parameters:

dragIconHeight - icon height

Returns:

chart scrollbar settings

getDragIconWidth

public java.lang.Integer getDragIconWidth()

Returns:

width of resize grip image

setDragIconWidth

@StudioProperty(defaultValue="11")
public ChartScrollbarSettings setDragIconWidth(java.lang.Integer dragIconWidth)

Sets width of resize grip image. Note, you should also update the image in amcharts/images folder if you don't want it to be distorted because of resizing. If not set the default value is 11.

Parameters:

dragIconWidth - icon width

Returns:

chart scrollbar settings

getEnabled

public java.lang.Boolean getEnabled()

Returns:

enabled option

setEnabled

@StudioProperty(defaultValue="true")
public ChartScrollbarSettings setEnabled(java.lang.Boolean enabled)

Set enabled false if you don't need scrollbar. If not set the default value is true.

Parameters:

enabled - enabled option

Returns:

chart scrollbar settings

getFontSize

public java.lang.Integer getFontSize()

Returns:

font size

setFontSize

@StudioProperty
public ChartScrollbarSettings setFontSize(java.lang.Integer fontSize)

Sets font size

Parameters:

fontSize - font size

Returns:

chart scrollbar settings

getGraph

public java.lang.String getGraph()

Returns:

graph id

setGraph

@StudioProperty
public ChartScrollbarSettings setGraph(java.lang.String graph)

Sets graph which will be displayed in the scrollbar.

Parameters:

graph - graph id

Returns:

chart scrollbar settings

getGraphFillAlpha

public java.lang.Double getGraphFillAlpha()

Returns:

graph fill opacity

setGraphFillAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setGraphFillAlpha(java.lang.Double graphFillAlpha)

Sets graph fill opacity.

Parameters:

graphFillAlpha - graph fill opacity

Returns:

chart scrollbar settings

getGraphFillColor

public Color getGraphFillColor()

Returns:

graph fill color

setGraphFillColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setGraphFillColor(Color graphFillColor)

Sets graph fill color.

Parameters:

graphFillColor - graph fill color

Returns:

chart scrollbar settings

getGraphLineAlpha

public java.lang.Double getGraphLineAlpha()

Returns:

graph line opacity

setGraphLineAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setGraphLineAlpha(java.lang.Double graphLineAlpha)

Sets graph line opacity.

Parameters:

graphLineAlpha - graph line opacity

Returns:

chart scrollbar settings

getGraphLineColor

public Color getGraphLineColor()

Returns:

graph line color

setGraphLineColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setGraphLineColor(Color graphLineColor)

Sets graph line color.

Parameters:

graphLineColor - graph line color

Returns:

chart scrollbar settings

getGraphType

public GraphType getGraphType()

Returns:

graph type

setGraphType

@StudioProperty(type=ENUMERATION)
public ChartScrollbarSettings setGraphType(GraphType graphType)

Sets type of chart scrollbar's graph. By default the graph type is the same as the original graph's type, however in case of candlestick or ohlc you might want to show line graph in the scrollbar. Possible values are: line, column, step, smoothedLine, candlestick, ohlc.

Parameters:

graphType - graph type

Returns:

chart scrollbar settings

getGridAlpha

public java.lang.Double getGridAlpha()

Returns:

grid opacity

setGridAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setGridAlpha(java.lang.Double gridAlpha)

Sets grid opacity.

Parameters:

gridAlpha - grid opacity

Returns:

chart scrollbar settings

getGridColor

public Color getGridColor()

Returns:

grid color

setGridColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setGridColor(Color gridColor)

Sets grid color.

Parameters:

gridColor - grid color

Returns:

chart scrollbar settings

getGridCount

public java.lang.Integer getGridCount()

Returns:

grid count

setGridCount

@StudioProperty
public ChartScrollbarSettings setGridCount(java.lang.Integer gridCount)

Sets grid count. You should set autoGridCount to false in order this property to work.

Parameters:

gridCount - grid count

Returns:

chart scrollbar settings

getHeight

public java.lang.Integer getHeight()

Returns:

height of scrollbar, in pixels.

setHeight

@StudioProperty(defaultValue="40")
public ChartScrollbarSettings setHeight(java.lang.Integer height)

Sets height of scrollbar, in pixels. If not set the default value is 40.

Parameters:

height - height, in pixels

Returns:

chart scrollbar settings

getHideResizeGrips

public java.lang.Boolean getHideResizeGrips()

Returns:

true if resize grips are hidden when the mouse is away from the scrollbar

setHideResizeGrips

@StudioProperty(defaultValue="false")
public ChartScrollbarSettings setHideResizeGrips(java.lang.Boolean hideResizeGrips)

Set hideResizeGrips to true if resize grips should be hidden when the mouse is away from the scrollbar. If not set the default value is false.

Parameters:

hideResizeGrips - hideResizeGrips option

Returns:

chart scrollbar settings

getMarkPeriodChange

public java.lang.Boolean getMarkPeriodChange()

Returns:

true if markPeriodChange is enabled

setMarkPeriodChange

@StudioProperty
public ChartScrollbarSettings setMarkPeriodChange(java.lang.Boolean markPeriodChange)

Specifies if category axis of scrollbar should mark period change with a different date format.

Parameters:

markPeriodChange - markPeriodChange option

Returns:

chart scrollbar settings

getPosition

public ChartScrollbarPosition getPosition()

Returns:

position of a scrollbar

setPosition

@StudioProperty(type=ENUMERATION,
                defaultValue="BOTTOM")
public ChartScrollbarSettings setPosition(ChartScrollbarPosition position)

Sets position of a scrollbar. Possible values are "top" and "bottom". If not set the default value is BOTTOM.

Parameters:

position - position of a scrollbar

Returns:

chart scrollbar settings

getResizeEnabled

public java.lang.Boolean getResizeEnabled()

Returns:

true if resizing is enabled

setResizeEnabled

@StudioProperty(defaultValue="true")
public ChartScrollbarSettings setResizeEnabled(java.lang.Boolean resizeEnabled)

Set resizeEnabled to false if you want to disable a resizing. If not set the default value is true.

Parameters:

resizeEnabled - resizeEnabled option

Returns:

chart scrollbar settings

getScrollDuration

public java.lang.Double getScrollDuration()

Returns:

duration of scrolling, in seconds

setScrollDuration

@StudioProperty(defaultValue="true")
public ChartScrollbarSettings setScrollDuration(java.lang.Double scrollDuration)

Sets duration of scrolling, when the user clicks on scrollbar's background, in seconds. Note, updateOnReleaseOnly should be set to false in order animation to happen. If not set the default value is true.

Parameters:

scrollDuration - duration of scrolling, in seconds

Returns:

chart scrollbar settings

getSelectedBackgroundAlpha

public java.lang.Double getSelectedBackgroundAlpha()

Returns:

selected background opacity

setSelectedBackgroundAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setSelectedBackgroundAlpha(java.lang.Double selectedBackgroundAlpha)

Sets selected background opacity.

Parameters:

selectedBackgroundAlpha - opacity

Returns:

chart scrollbar settings

getSelectedBackgroundColor

public Color getSelectedBackgroundColor()

Returns:

selected background color

setSelectedBackgroundColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setSelectedBackgroundColor(Color selectedBackgroundColor)

Sets selected background color.

Parameters:

selectedBackgroundColor - color

Returns:

chart scrollbar settings

getSelectedGraphFillAlpha

public java.lang.Double getSelectedGraphFillAlpha()

Returns:

selected graph's fill opacity

setSelectedGraphFillAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setSelectedGraphFillAlpha(java.lang.Double selectedGraphFillAlpha)

Sets selected graph's fill opacity.

Parameters:

selectedGraphFillAlpha - opacity

Returns:

chart scrollbar settings

getSelectedGraphFillColor

public Color getSelectedGraphFillColor()

Returns:

selected graph's fill color

setSelectedGraphFillColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setSelectedGraphFillColor(Color selectedGraphFillColor)

Sets selected graph's fill color.

Parameters:

selectedGraphFillColor - color

Returns:

chart scrollbar settings

getSelectedGraphLineAlpha

public java.lang.Double getSelectedGraphLineAlpha()

Returns:

selected graph'sline opacity

setSelectedGraphLineAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ChartScrollbarSettings setSelectedGraphLineAlpha(java.lang.Double selectedGraphLineAlpha)

Sets selected graph's line opacity.

Parameters:

selectedGraphLineAlpha - opacity

Returns:

chart scrollbar settings

getSelectedGraphLineColor

public Color getSelectedGraphLineColor()

Returns:

selected graph's line color

setSelectedGraphLineColor

@StudioProperty(type=OPTIONS)
public ChartScrollbarSettings setSelectedGraphLineColor(Color selectedGraphLineColor)

Sets selected graph's line color.

Parameters:

selectedGraphLineColor - color

Returns:

chart scrollbar settings

getUpdateOnReleaseOnly

public java.lang.Boolean getUpdateOnReleaseOnly()

Returns:

true if the chart is updated only at the moment when user releases mouse button

setUpdateOnReleaseOnly

@StudioProperty
public ChartScrollbarSettings setUpdateOnReleaseOnly(java.lang.Boolean updateOnReleaseOnly)

Set updateOnReleaseOnly to true if the chart should be updated only at the moment when user releases mouse button. Useful when working with large data sets.

Parameters:

updateOnReleaseOnly - updateOnReleaseOnly option

Returns:

chart scrollbar settings

getUsePeriod

public java.lang.String getUsePeriod()

Returns:

used date period

setUsePeriod

@StudioProperty
public ChartScrollbarSettings setUsePeriod(java.lang.String usePeriod)

Sets the date period for the scrollbar. This is very important feature for those, who work with large data sets. You can tell scrollbar what period it should use for it's graph and save a lot of time for rendering of this graph. For example, if your minPeriod is "DD" (days), set usePeriod = "WW" (weeks) and you will have 7 times less data points in scrollbar's graph. Note, the period you specify here should be set in CategoryAxesSettings.groupToPeriods.

Parameters:

usePeriod - date period

Returns:

chart scrollbar settings