io.jmix.charts.model.dataset

Class DataSet

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.dataset.DataSet

All Implemented Interfaces:

java.io.Serializable

public class DataSet
extends AbstractChartObject

Holds all information about data.
See documentation for properties of DataSet JS object.
http://docs.amcharts.com/3/javascriptstockchart/DataSet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSet.DataProviderChangeEvent
static interface	DataSet.DataProviderChangeListener

Constructor Summary

Constructors

Constructor and Description
DataSet()

Method Summary

Modifier and Type	Method and Description
void	addDataProviderChangeListener(DataSet.DataProviderChangeListener listener)
DataSet	addFieldMappings(FieldMapping... fieldMappings) Adds field mappings.
DataSet	addStockEvents(StockEvent... stockEvents) Adds stock events.
protected void	fireDataProviderChanged()
java.lang.String	getCategoryField()
Color	getColor()
java.lang.Boolean	getCompared()
DataProvider	getDataProvider()
java.util.List<FieldMapping>	getFieldMappings()
java.lang.String	getId()
java.lang.Boolean	getShowInCompare()
java.lang.Boolean	getShowInSelect()
java.util.List<StockEvent>	getStockEvents()
java.lang.String	getTitle()
java.util.List<java.lang.String>	getWiredFields()
void	removeDataProviderChangeListener(DataSet.DataProviderChangeListener listener)
DataSet	setCategoryField(java.lang.String categoryField) Sets category field name in your data provider.
DataSet	setColor(Color color) Sets color of the data set.
DataSet	setCompared(java.lang.Boolean compared) Set to true if this data set selected for comparing.
DataSet	setDataProvider(DataProvider dataProvider) Sets data provider to the data set.
DataSet	setFieldMappings(java.util.List<FieldMapping> fieldMappings) Sets list of field mappings.
DataSet	setId(java.lang.String id)
DataSet	setShowInCompare(java.lang.Boolean showInCompare) Set showInCompare to false if this data set shouldn't be visible in "compare to" list.
DataSet	setShowInSelect(java.lang.Boolean showInSelect) Set showInSelect to false if this data set shouldn't be visible in "select" dropdown.
DataSet	setStockEvents(java.util.List<StockEvent> stockEvents) Sets list of stock events.
DataSet	setTitle(java.lang.String title) Sets data set title.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSet

public DataSet()

Method Detail

getId

public java.lang.String getId()

setId

@StudioProperty
public DataSet setId(java.lang.String id)

getCategoryField

public java.lang.String getCategoryField()

Returns:

category field name

setCategoryField

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

Sets category field name in your data provider. It needs to contains a date/time value. If you are specifying dates as strings in your data, i.e. "2015-01-05", it is strongly recommend setting dataDateFormat as well.

Parameters:

categoryField - category field name

Returns:

data set

getColor

public Color getColor()

Returns:

color of the data set

setColor

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

Sets color of the data set. One of colors from colors array will be used if not set.

Parameters:

color - color

Returns:

data set

getCompared

public java.lang.Boolean getCompared()

Returns:

true if data set is selected for comparing

setCompared

@StudioProperty(defaultValue="false")
public DataSet setCompared(java.lang.Boolean compared)

Set to true if this data set selected for comparing. If not set the default value is false.

Parameters:

compared - compared option

Returns:

data set

getDataProvider

public DataProvider getDataProvider()

Returns:

data provider

setDataProvider

@StudioProperty(name="dataContainer",
                type=DATACONTAINER_REF)
public DataSet setDataProvider(DataProvider dataProvider)

Sets data provider to the data set. An array of data points to be used as data. Important, the data points needs to come pre-ordered in ascending order. Data with incorrect order might result in visual and functional glitches on the chart.

Parameters:

dataProvider - data provider

Returns:

data set

fireDataProviderChanged

protected void fireDataProviderChanged()

getFieldMappings

public java.util.List<FieldMapping> getFieldMappings()

Returns:

list of field mappings

setFieldMappings

@StudioElementsGroup(caption="Field Mappings",
                     xmlElement="fieldMappings")
public DataSet setFieldMappings(java.util.List<FieldMapping> fieldMappings)

Sets list of field mappings. Field mapping is an object with fromField and toField properties. fromField is a name of your value field in data provider. toField might be chosen freely, it will be used to set value/open/close/high/low fields for the StockGraph.

Parameters:

fieldMappings - list of field mappings

Returns:

data set

addFieldMappings

public DataSet addFieldMappings(FieldMapping... fieldMappings)

Adds field mappings.

Parameters:

fieldMappings - field mappings

Returns:

data set

getShowInCompare

public java.lang.Boolean getShowInCompare()

Returns:

true if this data set is visible in "compare to" list

setShowInCompare

@StudioProperty(defaultValue="true")
public DataSet setShowInCompare(java.lang.Boolean showInCompare)

Set showInCompare to false if this data set shouldn't be visible in "compare to" list. If not set the default value is true.

Parameters:

showInCompare - showInCompare option

Returns:

data set

getShowInSelect

public java.lang.Boolean getShowInSelect()

Returns:

true if this data set is visible in "select" dropdown

setShowInSelect

@StudioProperty(defaultValue="true")
public DataSet setShowInSelect(java.lang.Boolean showInSelect)

Set showInSelect to false if this data set shouldn't be visible in "select" dropdown. If not set the default value is true.

Parameters:

showInSelect - showInSelect option

Returns:

data set

getStockEvents

public java.util.List<StockEvent> getStockEvents()

Returns:

list of stock events

setStockEvents

@StudioElementsGroup(caption="Stock Events",
                     xmlElement="stockEvents")
public DataSet setStockEvents(java.util.List<StockEvent> stockEvents)

Sets list of stock events.

Parameters:

stockEvents - list of stock events

Returns:

data set

addStockEvents

public DataSet addStockEvents(StockEvent... stockEvents)

Adds stock events.

Parameters:

stockEvents - stock events

Returns:

data set

getTitle

public java.lang.String getTitle()

Returns:

data set title

setTitle

@StudioProperty
public DataSet setTitle(java.lang.String title)

Sets data set title.

Parameters:

title - title

Returns:

data set

getWiredFields

public java.util.List<java.lang.String> getWiredFields()

Returns:

fields that are bound to the data set

addDataProviderChangeListener

public void addDataProviderChangeListener(DataSet.DataProviderChangeListener listener)

removeDataProviderChangeListener

public void removeDataProviderChangeListener(DataSet.DataProviderChangeListener listener)