Package io.jmix.charts.component

Interface StockChart

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasColors<StockChart>, StockChartModel<StockChart>

All Known Implementing Classes:

StockChartImpl

@StudioComponent(caption="StockChart",
                 category="Charts",
                 xmlElement="stockChart",
                 xmlns="http://jmix.io/schema/ui/charts",
                 xmlnsAlias="chart",
                 icon="io/jmix/charts/icon/component/stockChart.svg",
                 canvasIcon="io/jmix/charts/icon/component/stockChart.svg",
                 canvasIconSize=LARGE)
public interface StockChart
extends Component, StockChartModel<StockChart>, Component.BelongToFrame, Component.HasIcon, Component.HasCaption

Stock chart component.
See documentation for properties of AmStockChart JS object.
http://docs.amcharts.com/3/javascriptstockchart/AmStockChart

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StockChart.AbstractDataSetSelectorEvent	Describes dataset selector event.
static class	StockChart.AbstractStockChartClickEvent
static class	StockChart.AbstractStockChartEvent
static class	StockChart.AbstractStockEventEvent	Describes StockEvent event.
static class	StockChart.AbstractStockGraphEvent	Describes stock graph event.
static class	StockChart.AbstractStockGraphItemEvent	Describes stock graph item event.
static class	StockChart.DataSetSelectorCompareEvent	Describes dataset selector compare event.
static class	StockChart.DataSetSelectorSelectEvent	Describes dataset selector select event.
static class	StockChart.DataSetSelectorUnCompareEvent	Describes dataset selector uncompare event.
static class	StockChart.PeriodSelectorChangeEvent	Describes period selector change event.
static class	StockChart.StockChartClickEvent	Describes stock chart click event.
static class	StockChart.StockChartRightClickEvent	Describes stock chart right click event.
static class	StockChart.StockEventClickEvent	Describes StockEvent click event.
static class	StockChart.StockEventRollOutEvent	Describes StockEvent roll-out event.
static class	StockChart.StockEventRollOverEvent	Describes StockEvent roll-over event.
static class	StockChart.StockGraphClickEvent	Describes stock graph click event.
static class	StockChart.StockGraphItemClickEvent	Describes stock graph item click event.
static class	StockChart.StockGraphItemRightClickEvent	Describes stock graph item click event.
static class	StockChart.StockGraphItemRollOutEvent	Describes stock graph item roll-out event.
static class	StockChart.StockGraphItemRollOverEvent	Describes stock graph item roll-over event.
static class	StockChart.StockGraphRollOutEvent	Describes stock graph roll-out event.
static class	StockChart.StockGraphRollOverEvent	Describes stock graph roll over event.
static class	StockChart.ZoomEvent	Describes zoom event.

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
Subscription	addClickListener(Consumer<StockChart.StockChartClickEvent> clickListener)	Adds a listener to stock chart click events.
Subscription	addDataSetSelectorCompareListener(Consumer<StockChart.DataSetSelectorCompareEvent> compareListener)	Adds a listener to dataset selector compare events.
Subscription	addDataSetSelectorSelectListener(Consumer<StockChart.DataSetSelectorSelectEvent> selectListener)	Adds a listener to dataset selector select events.
Subscription	addDataSetSelectorUnCompareListener(Consumer<StockChart.DataSetSelectorUnCompareEvent> unCompareListener)	Adds a listener to dataset selector uncompare events.
Subscription	addPeriodSelectorChangeListener(Consumer<StockChart.PeriodSelectorChangeEvent> changeListener)	Adds a listener to period selector change events.
Subscription	addRightClickListener(Consumer<StockChart.StockChartRightClickEvent> clickListener)	Adds listener to stock chart right click events.
Subscription	addStockEventClickListener(Consumer<StockChart.StockEventClickEvent> clickListener)	Adds listener to stock event click events.
Subscription	addStockEventRollOutListener(Consumer<StockChart.StockEventRollOutEvent> rollOutListener)	Adds a listener to stock event roll-out events.
Subscription	addStockEventRollOverListener(Consumer<StockChart.StockEventRollOverEvent> rollOverListener)	Adds listener to stock event roll-over events.
Subscription	addStockGraphClickListener(Consumer<StockChart.StockGraphClickEvent> clickListener)	Adds a listener to stock graph click events.
Subscription	addStockGraphItemClickListener(Consumer<StockChart.StockGraphItemClickEvent> clickListener)	Adds a listener to stock graph item click events.
Subscription	addStockGraphItemRightClickListener(Consumer<StockChart.StockGraphItemRightClickEvent> clickListener)	Adds a listener to stock graph item right click events.
Subscription	addStockGraphItemRollOutListener(Consumer<StockChart.StockGraphItemRollOutEvent> rollOutListener)	Adds a listener to stock graph item roll-out events.
Subscription	addStockGraphItemRollOverListener(Consumer<StockChart.StockGraphItemRollOverEvent> rollOverListener)	Adds a listener to stock graph item roll-over events.
Subscription	addStockGraphRollOutListener(Consumer<StockChart.StockGraphRollOutEvent> rollOutListener)	Adds a listener to stock graph roll-out events.
Subscription	addStockGraphRollOverListener(Consumer<StockChart.StockGraphRollOverEvent> rollOverListener)	Adds a listener to stock graph roll-over events.
Subscription	addZoomListener(Consumer<StockChart.ZoomEvent> zoomListener)	Adds listener to stock chart zoom events.
String	getNativeJson()
void	repaint()	Resend all items and properties to client and repaint chart.
void	setNativeJson(String json)	Set additional JSON configuration as a string.

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.charts.model.HasColors

addColors, getColors, setColors

Methods inherited from interface io.jmix.charts.model.chart.StockChartModel

addComparedDataSets, addDataSets, addPanels, getAddClassNames, getAdditionalFields, getAnimationPlayed, getAutoResize, getBalloon, getCategoryAxesSettings, getChartCursorSettings, getChartScrollbarSettings, getClassNamePrefix, getComparedDataSets, getDataDateFormat, getDataSet, getDataSets, getDataSetSelector, getExport, getExtendToFullPeriod, getFirstDayOfWeek, getGlueToTheEnd, getLanguage, getLegendSettings, getMainDataSet, getMouseWheelScrollEnabled, getPanels, getPanelsSettings, getPath, getPathToImages, getPeriodSelector, getProcessTimeout, getStockEventsSettings, getTheme, getValueAxesSettings, getZoomOutOnDataSetChange, setAddClassNames, setAdditionalFields, setAnimationPlayed, setAutoResize, setBalloon, setCategoryAxesSettings, setChartCursorSettings, setChartScrollbarSettings, setClassNamePrefix, setComparedDataSets, setDataDateFormat, setDataSets, setDataSetSelector, setExport, setExtendToFullPeriod, setFirstDayOfWeek, setGlueToTheEnd, setLanguage, setLegendSettings, setMainDataSet, setMouseWheelScrollEnabled, setPanels, setPanelsSettings, setPath, setPathToImages, setPeriodSelector, setProcessTimeout, setStockEventsSettings, setTheme, setValueAxesSettings, setZoomOutOnDataSetChange

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

repaint

void repaint()

Resend all items and properties to client and repaint chart. Use this method if you change some property of already displayed chart.

addClickListener

Subscription addClickListener(Consumer<StockChart.StockChartClickEvent> clickListener)

Adds a listener to stock chart click events. Called when user clicks on the stock chart.

Parameters:

clickListener - a listener to add

Returns:

subscription

addRightClickListener

Subscription addRightClickListener(Consumer<StockChart.StockChartRightClickEvent> clickListener)

Adds listener to stock chart right click events. Called when user clicks on the stock chart.

Parameters:

clickListener - a listener to add

Returns:

subscription

addStockEventClickListener

Subscription addStockEventClickListener(Consumer<StockChart.StockEventClickEvent> clickListener)

Adds listener to stock event click events. Called when user clicks on the stock event.

Parameters:

clickListener - a listener to add

Returns:

subscription

addStockEventRollOutListener

Subscription addStockEventRollOutListener(Consumer<StockChart.StockEventRollOutEvent> rollOutListener)

Adds a listener to stock event roll-out events. Called when the stock event did roll-out.

Parameters:

rollOutListener - a listener to add

Returns:

subscription

addStockEventRollOverListener

Subscription addStockEventRollOverListener(Consumer<StockChart.StockEventRollOverEvent> rollOverListener)

Adds listener to stock event roll-over events. Called when the stock event did roll-over.

Parameters:

rollOverListener - a listener to add

Returns:

subscription

addZoomListener

Subscription addZoomListener(Consumer<StockChart.ZoomEvent> zoomListener)

Adds listener to stock chart zoom events.

Parameters:

zoomListener - a listener to add

Returns:

subscription

addPeriodSelectorChangeListener

Subscription addPeriodSelectorChangeListener(Consumer<StockChart.PeriodSelectorChangeEvent> changeListener)

Adds a listener to period selector change events. Called when the period selector changed.

Parameters:

changeListener - a listener

Returns:

subscription

addDataSetSelectorCompareListener

Subscription addDataSetSelectorCompareListener(Consumer<StockChart.DataSetSelectorCompareEvent> compareListener)

Adds a listener to dataset selector compare events. Called when the data set is selected for comparing.

Parameters:

compareListener - a listener to add

Returns:

subscription

addDataSetSelectorSelectListener

Subscription addDataSetSelectorSelectListener(Consumer<StockChart.DataSetSelectorSelectEvent> selectListener)

Adds a listener to dataset selector select events. Called when the dataset selector selected.

Parameters:

selectListener - a listener to add

Returns:

subscription

addDataSetSelectorUnCompareListener

Subscription addDataSetSelectorUnCompareListener(Consumer<StockChart.DataSetSelectorUnCompareEvent> unCompareListener)

Adds a listener to dataset selector uncompare events. Called when the dataset selector removed from comparison.

Parameters:

unCompareListener - a listener to add

Returns:

subscription

addStockGraphClickListener

Subscription addStockGraphClickListener(Consumer<StockChart.StockGraphClickEvent> clickListener)

Adds a listener to stock graph click events. Called when user clicks on the stock graph.

Parameters:

clickListener - a listener to add

Returns:

subscription

addStockGraphRollOutListener

Subscription addStockGraphRollOutListener(Consumer<StockChart.StockGraphRollOutEvent> rollOutListener)

Adds a listener to stock graph roll-out events. Called when the stock graph did roll-out.

Parameters:

rollOutListener - a listener to add

Returns:

subscription

addStockGraphRollOverListener

Subscription addStockGraphRollOverListener(Consumer<StockChart.StockGraphRollOverEvent> rollOverListener)

Adds a listener to stock graph roll-over events. Called when the stock graph did roll-over.

Parameters:

rollOverListener - a listener to add

Returns:

subscription

addStockGraphItemClickListener

Subscription addStockGraphItemClickListener(Consumer<StockChart.StockGraphItemClickEvent> clickListener)

Adds a listener to stock graph item click events. Called when user clicks on the stock graph item.

Parameters:

clickListener - a listener to add

Returns:

subscription

addStockGraphItemRightClickListener

Subscription addStockGraphItemRightClickListener(Consumer<StockChart.StockGraphItemRightClickEvent> clickListener)

Adds a listener to stock graph item right click events. Called when user clicks on the stock graph item.

Parameters:

clickListener - a listener to add

Returns:

subscription

addStockGraphItemRollOutListener

Subscription addStockGraphItemRollOutListener(Consumer<StockChart.StockGraphItemRollOutEvent> rollOutListener)

Adds a listener to stock graph item roll-out events. Called when the stock graph item did roll-out.

Parameters:

rollOutListener - a listener to add

Returns:

subscription

addStockGraphItemRollOverListener

Subscription addStockGraphItemRollOverListener(Consumer<StockChart.StockGraphItemRollOverEvent> rollOverListener)

Adds a listener to stock graph item roll-over events.

Parameters:

rollOverListener - a listener to add

Returns:

subscription

setNativeJson

void setNativeJson(String json)

Set additional JSON configuration as a string. This JSON can override configuration loaded from XML and from Component API.

Parameters:

json - additional JSON configuration

getNativeJson

String getNativeJson()

Returns:

additional JSON configuration as a string.