io.jmix.charts.model.stock

Class StockGraph

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.graph.AbstractGraph<StockGraph>

io.jmix.charts.model.stock.StockGraph

All Implemented Interfaces:

java.io.Serializable

public class StockGraph
extends AbstractGraph<StockGraph>

StockGraph displays graphs on StockPanel.
See documentation for properties of StockGraph JS object.
http://docs.amcharts.com/3/javascriptstockchart/StockGraph

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StockGraph()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getComparable()
java.lang.String	getCompareField()
java.lang.Boolean	getCompareFromStart()
Graph	getCompareGraph()
Color	getCompareGraphBalloonColor()
JsFunction	getCompareGraphBalloonFunction()
java.lang.String	getCompareGraphBalloonText()
java.lang.String	getCompareGraphBullet()
java.lang.Double	getCompareGraphBulletBorderAlpha()
Color	getCompareGraphBulletBorderColor()
java.lang.Integer	getCompareGraphBulletBorderThickness()
Color	getCompareGraphBulletColor()
java.lang.Integer	getCompareGraphBulletSize()
java.lang.Integer	getCompareGraphCornerRadiusTop()
java.lang.Integer	getCompareGraphDashLength()
java.lang.Double	getCompareGraphFillAlphas()
java.util.List<Color>	getCompareGraphFillColors()
java.lang.Double	getCompareGraphLineAlpha()
Color	getCompareGraphLineColor()
java.lang.Integer	getCompareGraphLineThickness()
GraphType	getCompareGraphType()
java.lang.Boolean	getCompareGraphVisibleInLegend()
StockGraphValue	getPeriodValue()
StockGraphValue	getRecalculateValue()
java.lang.Boolean	getShowEventsOnComparedGraphs()
java.lang.Boolean	getUseDataSetColors()
java.util.List<java.lang.String>	getWiredFields()
StockGraph	setComparable(java.lang.Boolean comparable) Sets comparable to true if this graph should be compared if some data set is selected for comparing.
StockGraph	setCompareField(java.lang.String compareField) Sets the field to be used to generate comparing the graph.
StockGraph	setCompareFromStart(java.lang.Boolean compareFromStart) Set compareFromStart to true if the graphs should use first value as a base value instead of using the first value of selected period when data sets are compared.
StockGraph	setCompareGraph(Graph compareGraph) Sets config of compared graphs.
StockGraph	setCompareGraphBalloonColor(Color compareGraphBalloonColor) Sets balloon color of comparing graph.
StockGraph	setCompareGraphBalloonFunction(JsFunction compareGraphBalloonFunction) Sets JS function.
StockGraph	setCompareGraphBalloonText(java.lang.String compareGraphBalloonText) Sets balloon text of comparing graph.
StockGraph	setCompareGraphBullet(java.lang.String compareGraphBullet) Sets bullet of comparing graph.
@Max(value=1L) @Min(value=0L) StockGraph	setCompareGraphBulletBorderAlpha(java.lang.Double compareGraphBulletBorderAlpha) Sets opacity of bullet border of comparing graph.
StockGraph	setCompareGraphBulletBorderColor(Color compareGraphBulletBorderColor) Sets color of bullet border of comparing graph.
StockGraph	setCompareGraphBulletBorderThickness(java.lang.Integer compareGraphBulletBorderThickness) Sets thickness of bullet border of comparing graph.
StockGraph	setCompareGraphBulletColor(Color compareGraphBulletColor) Sets color of compared graphs bullets.
StockGraph	setCompareGraphBulletSize(java.lang.Integer compareGraphBulletSize) Sets bullet size of comparing graph.
StockGraph	setCompareGraphCornerRadiusTop(java.lang.Integer compareGraphCornerRadiusTop) Sets corner radius of comparing graph (if type is "column").
StockGraph	setCompareGraphDashLength(java.lang.Integer compareGraphDashLength) Sets dash length of compare graph.
@Max(value=1L) @Min(value=0L) StockGraph	setCompareGraphFillAlphas(java.lang.Double compareGraphFillAlphas) Sets fill alpha of comparing graph.
StockGraph	setCompareGraphFillColors(java.util.List<Color> compareGraphFillColors) Sets list of fill colors of comparing graph.
@Max(value=1L) @Min(value=0L) StockGraph	setCompareGraphLineAlpha(java.lang.Double compareGraphLineAlpha) Sets opacity of comparing graph line.
StockGraph	setCompareGraphLineColor(Color compareGraphLineColor) Sets color of compare graph (by default data set color is used).
StockGraph	setCompareGraphLineThickness(java.lang.Integer compareGraphLineThickness) Sets thickness of compare graph.
StockGraph	setCompareGraphType(GraphType compareGraphType) Sets type of comparing graph.
StockGraph	setCompareGraphVisibleInLegend(java.lang.Boolean compareGraphVisibleInLegend) Set compareGraphVisibleInLegend to false if compare graph shouldn't be visible in legend.
StockGraph	setPeriodValue(StockGraphValue periodValue) Sets period value.
StockGraph	setRecalculateValue(StockGraphValue recalculateValue) Sets recalculate value.
StockGraph	setShowEventsOnComparedGraphs(java.lang.Boolean showEventsOnComparedGraphs) Set showEventsOnComparedGraphs to true if events of compared graphs should be shown.
StockGraph	setUseDataSetColors(java.lang.Boolean useDataSetColors) Specifies whether data set color should be used as this graph's lineColor.

Methods inherited from class io.jmix.charts.model.graph.AbstractGraph

getAccessibleLabel, getAlphaField, getAnimationPlayed, getBalloon, getBalloonColor, getBalloonFunction, getBalloonText, getBehindColumns, getBullet, getBulletAlpha, getBulletAxis, getBulletBorderAlpha, getBulletBorderColor, getBulletBorderThickness, getBulletColor, getBulletField, getBulletHitAreaSize, getBulletOffset, getBulletSize, getBulletSizeField, getClassNameField, getCloseField, getClustered, getColor, getColorField, getColumnIndexField, getColumnWidth, getConnect, getCornerRadiusTop, getCursorBulletAlpha, getCustomBullet, getCustomBulletField, getCustomMarker, getDashLength, getDashLengthField, getDateFormat, getDescriptionField, getErrorField, getFillAlphas, getFillColors, getFillColorsField, getFillToAxis, getFillToGraph, getFixedColumnWidth, getFontSize, getForceGap, getGapField, getGapPeriod, getGradientOrientation, getHidden, getHideBulletsCount, getHighField, getId, getIncludeInMinMax, getLabelAnchor, getLabelColorField, getLabelFunction, getLabelOffset, getLabelPosition, getLabelRotation, getLabelText, getLegendAlpha, getLegendColor, getLegendColorFunction, getLegendPeriodValueText, getLegendValueText, getLineAlpha, getLineColor, getLineColorField, getLineThickness, getLowField, getMarkerType, getMaxBulletSize, getMinBulletSize, getMinDistance, getNegativeBase, getNegativeFillAlphas, getNegativeFillColors, getNegativeLineAlpha, getNegativeLineColor, getNewStack, getNoStepRisers, getOpenField, getPattern, getPatternField, getPeriodSpan, getPointPosition, getPrecision, getProCandlesticks, getShowAllValueLabels, getShowBalloon, getShowBalloonAt, getShowBulletsAt, getShowHandOnHover, getShowOnAxis, getStackable, getStepDirection, getSwitchable, getTabIndex, getTitle, getTopRadius, getType, getUrlField, getUrlTarget, getUseLineColorForBulletBorder, getUseNegativeColorIfDown, getValueAxis, getValueField, getVisibleInLegend, getXAxis, getXField, getYAxis, getYField, setAccessibleLabel, setAlphaField, setAnimationPlayed, setBalloon, setBalloonColor, setBalloonFunction, setBalloonText, setBehindColumns, setBullet, setBulletAlpha, setBulletAxis, setBulletBorderAlpha, setBulletBorderColor, setBulletBorderThickness, setBulletColor, setBulletField, setBulletHitAreaSize, setBulletOffset, setBulletSize, setBulletSizeField, setClassNameField, setCloseField, setClustered, setColor, setColorField, setColumnIndexField, setColumnWidth, setConnect, setCornerRadiusTop, setCursorBulletAlpha, setCustomBullet, setCustomBulletField, setCustomMarker, setDashLength, setDashLengthField, setDateFormat, setDescriptionField, setErrorField, setFillAlphas, setFillColors, setFillColorsField, setFillToAxis, setFillToGraph, setFixedColumnWidth, setFontSize, setForceGap, setGapField, setGapPeriod, setGradientOrientation, setHidden, setHideBulletsCount, setHighField, setId, setIncludeInMinMax, setLabelAnchor, setLabelColorField, setLabelFunction, setLabelOffset, setLabelPosition, setLabelRotation, setLabelText, setLegendAlpha, setLegendColor, setLegendColorFunction, setLegendPeriodValueText, setLegendValueText, setLineAlpha, setLineColor, setLineColorField, setLineThickness, setLowField, setMarkerType, setMaxBulletSize, setMinBulletSize, setMinDistance, setNegativeBase, setNegativeFillAlphas, setNegativeFillColors, setNegativeLineAlpha, setNegativeLineColor, setNewStack, setNoStepRisers, setOpenField, setPattern, setPatternField, setPeriodSpan, setPointPosition, setPrecision, setProCandlesticks, setShowAllValueLabels, setShowBalloon, setShowBalloonAt, setShowBulletsAt, setShowHandOnHover, setShowOnAxis, setStackable, setStepDirection, setSwitchable, setTabIndex, setTitle, setTopRadius, setType, setUrlField, setUrlTarget, setUseLineColorForBulletBorder, setUseNegativeColorIfDown, setValueAxis, setValueField, setVisibleInLegend, setXAxis, setXField, setYAxis, setYField

Methods inherited from class java.lang.Object

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

Constructor Detail

StockGraph

public StockGraph()

Method Detail

getComparable

public java.lang.Boolean getComparable()

Returns:

true if this graph is compared

setComparable

@StudioProperty(defaultValue="false")
public StockGraph setComparable(java.lang.Boolean comparable)

Sets comparable to true if this graph should be compared if some data set is selected for comparing. If not set the default value is false.

Parameters:

comparable - comparable option

Returns:

stock graph

getCompareField

public java.lang.String getCompareField()

Returns:

field that is used to generate comparing the graph

setCompareField

@StudioProperty
public StockGraph setCompareField(java.lang.String compareField)

Sets the field to be used to generate comparing the graph. Note, this field is not the one used in your data provider, but toField from FieldMapping object.

Parameters:

compareField - compare field

Returns:

stock graph

getCompareFromStart

public java.lang.Boolean getCompareFromStart()

Returns:

true if compareFromStart is enabled

setCompareFromStart

@StudioProperty(defaultValue="false")
public StockGraph setCompareFromStart(java.lang.Boolean compareFromStart)

Set compareFromStart to true if the graphs should use first value as a base value instead of using the first value of selected period when data sets are compared. If not set the default value is false.

Parameters:

compareFromStart - compareFromStart option

Returns:

stock graph

getCompareGraph

public Graph getCompareGraph()

Returns:

config of compared graphs

setCompareGraph

public StockGraph setCompareGraph(Graph compareGraph)

Sets config of compared graphs. This allows you to set any of Graph properties on compared graphs instead of using old-style properties like compareGraphBulletBorderThickness.

Parameters:

compareGraph - graph

Returns:

stock graph

getCompareGraphBalloonColor

public Color getCompareGraphBalloonColor()

Returns:

balloon color of comparing graph

setCompareGraphBalloonColor

@StudioProperty(type=OPTIONS)
public StockGraph setCompareGraphBalloonColor(Color compareGraphBalloonColor)

Sets balloon color of comparing graph.

Parameters:

compareGraphBalloonColor - color

Returns:

stock graph

getCompareGraphBalloonFunction

public JsFunction getCompareGraphBalloonFunction()

Returns:

JS function

setCompareGraphBalloonFunction

public StockGraph setCompareGraphBalloonFunction(JsFunction compareGraphBalloonFunction)

Sets JS function. The graph will call it and pass GraphDataItem and AmGraph object to it. This function should return a string which will be displayed in a balloon. This will be used for graphs from compared data sets only. Use balloonFunction for main data set's graphs.

Parameters:

compareGraphBalloonFunction - JS function

Returns:

stock graph

getCompareGraphBalloonText

public java.lang.String getCompareGraphBalloonText()

Returns:

balloon text of comparing graph

setCompareGraphBalloonText

@StudioProperty
public StockGraph setCompareGraphBalloonText(java.lang.String compareGraphBalloonText)

Sets balloon text of comparing graph.

Parameters:

compareGraphBalloonText - text

Returns:

stock graph

getCompareGraphBullet

public java.lang.String getCompareGraphBullet()

Returns:

bullet of comparing graph

setCompareGraphBullet

@StudioProperty(type=OPTIONS,
                options={"round","square","diamond","triangleUp","triangleDown","triangleLeft","triangleRight","bubble"})
public StockGraph setCompareGraphBullet(java.lang.String compareGraphBullet)

Sets bullet of comparing graph. Possible values are: round, square, diamond, triangleUp, triangleDown, triangleLeft, triangleRight, bubble

Parameters:

compareGraphBullet - compare graph bullet string

Returns:

stock graph

getCompareGraphBulletBorderAlpha

public java.lang.Double getCompareGraphBulletBorderAlpha()

Returns:

opacity of bullet border of comparing graph

setCompareGraphBulletBorderAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) StockGraph setCompareGraphBulletBorderAlpha(java.lang.Double compareGraphBulletBorderAlpha)

Sets opacity of bullet border of comparing graph.

Parameters:

compareGraphBulletBorderAlpha - opacity

Returns:

stock graph

getCompareGraphBulletBorderColor

public Color getCompareGraphBulletBorderColor()

Returns:

color of bullet border of comparing graph

setCompareGraphBulletBorderColor

@StudioProperty(type=OPTIONS)
public StockGraph setCompareGraphBulletBorderColor(Color compareGraphBulletBorderColor)

Sets color of bullet border of comparing graph.

Parameters:

compareGraphBulletBorderColor - color

Returns:

stock graph

getCompareGraphBulletBorderThickness

public java.lang.Integer getCompareGraphBulletBorderThickness()

Returns:

thickness of bullet border of comparing graph

setCompareGraphBulletBorderThickness

@StudioProperty
public StockGraph setCompareGraphBulletBorderThickness(java.lang.Integer compareGraphBulletBorderThickness)

Sets thickness of bullet border of comparing graph.

Parameters:

compareGraphBulletBorderThickness - thickness

Returns:

stock graph

getCompareGraphBulletColor

public Color getCompareGraphBulletColor()

Returns:

color of compared graphs bullets

setCompareGraphBulletColor

@StudioProperty(type=OPTIONS)
public StockGraph setCompareGraphBulletColor(Color compareGraphBulletColor)

Sets color of compared graphs bullets.

Parameters:

compareGraphBulletColor - color

Returns:

stock graph

getCompareGraphBulletSize

public java.lang.Integer getCompareGraphBulletSize()

Returns:

bullet size of comparing graph

setCompareGraphBulletSize

@StudioProperty
public StockGraph setCompareGraphBulletSize(java.lang.Integer compareGraphBulletSize)

Sets bullet size of comparing graph.

Parameters:

compareGraphBulletSize - bullet size

Returns:

stock graph

getCompareGraphCornerRadiusTop

public java.lang.Integer getCompareGraphCornerRadiusTop()

Returns:

corner radius of comparing graph

setCompareGraphCornerRadiusTop

@StudioProperty
public StockGraph setCompareGraphCornerRadiusTop(java.lang.Integer compareGraphCornerRadiusTop)

Sets corner radius of comparing graph (if type is "column").

Parameters:

compareGraphCornerRadiusTop - corner radius

Returns:

stock graph

getCompareGraphDashLength

public java.lang.Integer getCompareGraphDashLength()

Returns:

dash length of compare graph

setCompareGraphDashLength

@StudioProperty
public StockGraph setCompareGraphDashLength(java.lang.Integer compareGraphDashLength)

Sets dash length of compare graph.

Parameters:

compareGraphDashLength - dash length

Returns:

stock graph

getCompareGraphFillAlphas

public java.lang.Double getCompareGraphFillAlphas()

Returns:

fill alpha of comparing graph

setCompareGraphFillAlphas

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) StockGraph setCompareGraphFillAlphas(java.lang.Double compareGraphFillAlphas)

Sets fill alpha of comparing graph.

Parameters:

compareGraphFillAlphas - fill alpha

Returns:

stock graph

getCompareGraphFillColors

public java.util.List<Color> getCompareGraphFillColors()

Returns:

list of fill colors of comparing graph

setCompareGraphFillColors

public StockGraph setCompareGraphFillColors(java.util.List<Color> compareGraphFillColors)

Sets list of fill colors of comparing graph.

Parameters:

compareGraphFillColors - list of fill colors

Returns:

stock graph

getCompareGraphLineAlpha

public java.lang.Double getCompareGraphLineAlpha()

Returns:

opacity of comparing graph line

setCompareGraphLineAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) StockGraph setCompareGraphLineAlpha(java.lang.Double compareGraphLineAlpha)

Sets opacity of comparing graph line.

Parameters:

compareGraphLineAlpha - opacity

Returns:

stock graph

getCompareGraphLineColor

public Color getCompareGraphLineColor()

Returns:

color of compare graph

setCompareGraphLineColor

@StudioProperty(type=OPTIONS)
public StockGraph setCompareGraphLineColor(Color compareGraphLineColor)

Sets color of compare graph (by default data set color is used).

Parameters:

compareGraphLineColor - color

Returns:

stock graph

getCompareGraphLineThickness

public java.lang.Integer getCompareGraphLineThickness()

Returns:

thickness of compare graph

setCompareGraphLineThickness

@StudioProperty
public StockGraph setCompareGraphLineThickness(java.lang.Integer compareGraphLineThickness)

Sets thickness of compare graph.

Parameters:

compareGraphLineThickness - thickness

Returns:

stock graph

getCompareGraphType

public GraphType getCompareGraphType()

Returns:

type of comparing graph

setCompareGraphType

@StudioProperty(type=ENUMERATION,
                defaultValue="LINE")
public StockGraph setCompareGraphType(GraphType compareGraphType)

Sets type of comparing graph. Possible values are: "line", "column", "step", "smoothedLine". If not set the default value is LINE.

Parameters:

compareGraphType - type

Returns:

stock graph

getCompareGraphVisibleInLegend

public java.lang.Boolean getCompareGraphVisibleInLegend()

Returns:

true if compare graph is visible in legend

setCompareGraphVisibleInLegend

@StudioProperty(defaultValue="true")
public StockGraph setCompareGraphVisibleInLegend(java.lang.Boolean compareGraphVisibleInLegend)

Set compareGraphVisibleInLegend to false if compare graph shouldn't be visible in legend. If not set the default value is true.

Parameters:

compareGraphVisibleInLegend - compareGraphVisibleInLegend option

Returns:

stock graph

getPeriodValue

public StockGraphValue getPeriodValue()

Returns:

period value

setPeriodValue

@StudioProperty(type=ENUMERATION)
public StockGraph setPeriodValue(StockGraphValue periodValue)

Sets period value. When data is grouped to periods, the graph must know which period value should be used.

Parameters:

periodValue - period value

Returns:

stock graph

getRecalculateValue

public StockGraphValue getRecalculateValue()

Returns:

recalculate value

setRecalculateValue

@StudioProperty(type=ENUMERATION)
public StockGraph setRecalculateValue(StockGraphValue recalculateValue)

Sets recalculate value. Possible values are "open", "close", "high", "low", "average" and "sum". There is no default value set – graph uses its periodValue when calculating changes. For example, the graph’s periodValue is "close". This means that when data is grouped to longer periods (months for example) when recalculating, the graph will use "close" value of the first period of the selection as base value and will compare each months "close" value to it. If you set recalculateValue to "open", the first value of a month will be used as base value.

Parameters:

recalculateValue - recalculate value

Returns:

stock graph

getShowEventsOnComparedGraphs

public java.lang.Boolean getShowEventsOnComparedGraphs()

Returns:

true if events of compared graphs is shown

setShowEventsOnComparedGraphs

@StudioProperty(defaultValue="false")
public StockGraph setShowEventsOnComparedGraphs(java.lang.Boolean showEventsOnComparedGraphs)

Set showEventsOnComparedGraphs to true if events of compared graphs should be shown. If not set the default value is false.

Parameters:

showEventsOnComparedGraphs - showEventsOnComparedGraphs option

Returns:

stock graph

getUseDataSetColors

public java.lang.Boolean getUseDataSetColors()

Returns:

true if data set color is used as this graph's lineColor

setUseDataSetColors

@StudioProperty(defaultValue="true")
public StockGraph setUseDataSetColors(java.lang.Boolean useDataSetColors)

Specifies whether data set color should be used as this graph's lineColor. By default all graphs from the same data set will have a color from its relative DataSet (either auto-assigned by chart or set by color parameter). The graph's color properties will be ignored. To disable this behavior, set useDataSetColors to false. This way the chart will use graph's own color settings, such as "lineColor" or auto-assign the color if those are not set. If not set the default value is true.

Parameters:

useDataSetColors - useDataSetColors option

Returns:

stock graph

getWiredFields

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

Overrides:

getWiredFields in class AbstractGraph<StockGraph>

Returns:

fields of the DataItem that are bound to the graph