io.jmix.charts.model.dataset

Class DataSetSelector

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.dataset.DataSetSelector

All Implemented Interfaces:

java.io.Serializable

public class DataSetSelector
extends AbstractChartObject

DataSetSelector is a tool for selecting data set's as main and for comparing with main data set
See documentation for properties of DataSetSelector JS object.
http://docs.amcharts.com/3/javascriptstockchart/DataSetSelector

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSetSelector()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComboBoxSelectText()
java.lang.String	getCompareText()
java.lang.Integer	getListHeight()
Position	getPosition()
java.lang.String	getSelectText()
java.lang.Integer	getWidth()
DataSetSelector	setComboBoxSelectText(java.lang.String comboBoxSelectText) Sets text displayed in the "compare to" combobox (when position is "top" or "bottom").
DataSetSelector	setCompareText(java.lang.String compareText) Sets text displayed near "compare to" list.
DataSetSelector	setListHeight(java.lang.Integer listHeight) Sets the maximum height of the "compare to" field in pixels.
DataSetSelector	setPosition(Position position) Sets position.
DataSetSelector	setSelectText(java.lang.String selectText) Sets text displayed near "Select" drop down.
DataSetSelector	setWidth(java.lang.Integer width) Sets width of a data set selector, when position is "left" or "right".

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSetSelector

public DataSetSelector()

Method Detail

getComboBoxSelectText

public java.lang.String getComboBoxSelectText()

Returns:

text displayed in the "compare to" combobox

setComboBoxSelectText

@StudioProperty(defaultValue="Select...")
public DataSetSelector setComboBoxSelectText(java.lang.String comboBoxSelectText)

Sets text displayed in the "compare to" combobox (when position is "top" or "bottom"). If not set the default value is "Select..."

Parameters:

comboBoxSelectText - text

Returns:

data set selector

getCompareText

public java.lang.String getCompareText()

Returns:

text displayed near "compare to" list

setCompareText

@StudioProperty(defaultValue="Compare to:")
public DataSetSelector setCompareText(java.lang.String compareText)

Sets text displayed near "compare to" list. If not set the default value is "Compare to:".

Parameters:

compareText - compare text

Returns:

data set selector

getListHeight

public java.lang.Integer getListHeight()

Returns:

maximum height, in pixels

setListHeight

@StudioProperty(defaultValue="150")
public DataSetSelector setListHeight(java.lang.Integer listHeight)

Sets the maximum height of the "compare to" field in pixels. If not set the default value is 150.

Parameters:

listHeight - list height

Returns:

data set selector

getPosition

public Position getPosition()

Returns:

position

setPosition

@StudioProperty(type=ENUMERATION)
public DataSetSelector setPosition(Position position)

Sets position. Possible values: "right", "left", "top", "bottom". "top" and "bottom" positions has a limitation - only one data set can be selected for comparing. If not set the default value is "right, left, top, bottom".

Parameters:

position - position

Returns:

data set selector

getSelectText

public java.lang.String getSelectText()

Returns:

select text

setSelectText

@StudioProperty(defaultValue="Select:")
public DataSetSelector setSelectText(java.lang.String selectText)

Sets text displayed near "Select" drop down. If not set the default value is "Select:".

Parameters:

selectText - select text

Returns:

data set selector

getWidth

public java.lang.Integer getWidth()

Returns:

width of a data set selector

setWidth

@StudioProperty(defaultValue="180")
public DataSetSelector setWidth(java.lang.Integer width)

Sets width of a data set selector, when position is "left" or "right". If not set the default value is 180.

Parameters:

width - width

Returns:

data set selector