io.jmix.charts.model.stock

Class StockLegend

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.legend.AbstractLegend<StockLegend>

io.jmix.charts.model.stock.StockLegend

All Implemented Interfaces:

HasMargins<AbstractLegend>, java.io.Serializable

public class StockLegend
extends AbstractLegend<StockLegend>

StockLegend is a legend of StockPanel.
See documentation for properties of StockLegend JS object.
http://docs.amcharts.com/3/javascriptstockchart/StockLegend

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StockLegend()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPeriodValueTextComparing()
java.lang.String	getPeriodValueTextRegular()
java.lang.String	getValueTextComparing()
java.lang.String	getValueTextRegular()
StockLegend	setPeriodValueTextComparing(java.lang.String periodValueTextComparing) Sets the text which will be displayed in the value portion of the legend when user is not hovering above any data point and the data sets are compared.
StockLegend	setPeriodValueTextRegular(java.lang.String periodValueTextRegular) Sets the text which will be displayed in the value portion of the legend when user is not hovering above any data point.
StockLegend	setValueTextComparing(java.lang.String valueTextComparing) Sets the text which will be displayed in the value portion of the legend when graph is comparable and at least one data set is selected for comparing.
StockLegend	setValueTextRegular(java.lang.String valueTextRegular) Sets the text which will be displayed in the value portion of the legend.

Methods inherited from class io.jmix.charts.model.legend.AbstractLegend

addItems, getAccessibleLabel, getAlign, getAutoMargins, getBackgroundAlpha, getBackgroundColor, getBorderAlpha, getBorderColor, getBottom, getColor, getCombineLegend, getData, getDivId, getEnabled, getEqualWidths, getFontSize, getForceWidth, getGradientRotation, getHorizontalGap, getLabelText, getLabelWidth, getLeft, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarkerBorderAlpha, getMarkerBorderColor, getMarkerBorderThickness, getMarkerDisabledColor, getMarkerLabelGap, getMarkerSize, getMarkerType, getMaxColumns, getPeriodValueText, getPosition, getReversedOrder, getRight, getRollOverColor, getRollOverGraphAlpha, getShowEntries, getSpacing, getSwitchable, getSwitchColor, getSwitchType, getTabIndex, getTextClickEnabled, getTop, getUseGraphSettings, getUseMarkerColorForLabels, getUseMarkerColorForValues, getValueAlign, getValueFunction, getValueText, getValueWidth, getVerticalGap, getWidth, setAccessibleLabel, setAlign, setAutoMargins, setBackgroundAlpha, setBackgroundColor, setBorderAlpha, setBorderColor, setBottom, setColor, setCombineLegend, setData, setDivId, setEnabled, setEqualWidths, setFontSize, setForceWidth, setGradientRotation, setHorizontalGap, setLabelText, setLabelWidth, setLeft, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarkerBorderAlpha, setMarkerBorderColor, setMarkerBorderThickness, setMarkerDisabledColor, setMarkerLabelGap, setMarkerSize, setMarkerType, setMaxColumns, setPeriodValueText, setPosition, setReversedOrder, setRight, setRollOverColor, setRollOverGraphAlpha, setShowEntries, setSpacing, setSwitchable, setSwitchColor, setSwitchType, setTabIndex, setTextClickEnabled, setTop, setUseGraphSettings, setUseMarkerColorForLabels, setUseMarkerColorForValues, setValueAlign, setValueFunction, setValueText, setValueWidth, setVerticalGap, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

StockLegend

public StockLegend()

Method Detail

getPeriodValueTextComparing

public java.lang.String getPeriodValueTextComparing()

Returns:

period value text comparing

setPeriodValueTextComparing

@StudioProperty
public StockLegend setPeriodValueTextComparing(java.lang.String periodValueTextComparing)

Sets the text which will be displayed in the value portion of the legend when user is not hovering above any data point and the data sets are compared. The tags should be made out of two parts - the name of a field (value / open / close / high / low) and the value of the period you want to be show - open / close / high / low / sum / average / count. For example: [[value.sum]] means that sum of all data points of value field in the selected period will be displayed. In case you want to display percent values, you should add "percent" string in front of a tag, for example: [[percents.value.close]] means that last percent value of a period will be displayed.

Parameters:

periodValueTextComparing - period value text comparing

Returns:

stock legend

getPeriodValueTextRegular

public java.lang.String getPeriodValueTextRegular()

Returns:

period value text regular

setPeriodValueTextRegular

@StudioProperty
public StockLegend setPeriodValueTextRegular(java.lang.String periodValueTextRegular)

Sets the text which will be displayed in the value portion of the legend when user is not hovering above any data point. The tags should be made out of two parts - the name of a field (value / open / close / high / low) and the value of the period you want to be show - open / close / high / low / sum / average / count. For example: [[value.sum]] means that sum of all data points of value field in the selected period will be displayed.

Parameters:

periodValueTextRegular - period value text regular

Returns:

stock legend

getValueTextComparing

public java.lang.String getValueTextComparing()

Returns:

value text comparing

setValueTextComparing

@StudioProperty(defaultValue="[[percents.value]]%")
public StockLegend setValueTextComparing(java.lang.String valueTextComparing)

Sets the text which will be displayed in the value portion of the legend when graph is comparable and at least one data set is selected for comparing. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents.value/open/close/low/high]], [[description]]. If not set the default value is "[[percents.value]]%".

Parameters:

valueTextComparing - value text comparing

Returns:

stock legend

getValueTextRegular

public java.lang.String getValueTextRegular()

Returns:

value text regular

setValueTextRegular

@StudioProperty(defaultValue="[[value]]")
public StockLegend setValueTextRegular(java.lang.String valueTextRegular)

Sets the text which will be displayed in the value portion of the legend. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents]], [[description]]. If not set the default value is "[[value]]".

Parameters:

valueTextRegular - value text regular

Returns:

stock legend