io.jmix.charts.component

Interface Chart<T extends Chart>

Type Parameters:

T - type of builder methods

All Superinterfaces:

ChartModel<T>, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon

All Known Subinterfaces:

AngularGaugeChart, CoordinateChart<T>, FunnelChart, GanttChart, PieChart, RadarChart, RectangularChart<T>, SerialChart, SeriesBasedChart<T>, SlicedChart<T>, XYChart

All Known Implementing Classes:

AngularGaugeChartImpl, ChartImpl, CoordinateChartImpl, FunnelChartImpl, GanttChartImpl, PieChartImpl, RadarChartImpl, RectangularChartImpl, SerialChartImpl, SeriesBasedChartImpl, SlicedChartImpl, XYChartImpl

public interface Chart<T extends Chart>
extends Component, ChartModel<T>, Component.BelongToFrame, Component.HasIcon, Component.HasCaption

Base interface for all *Chart components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Chart.AbstractChartClickEvent
static class	Chart.AbstractChartEvent
static class	Chart.AbstractClickEvent
static class	Chart.AbstractCursorEvent
static class	Chart.AbstractGraphItemClickEvent
static class	Chart.AbstractItemEvent
static class	Chart.AbstractSliceClickEvent
static class	Chart.AxisZoomEvent Describes axis zoom event.
static class	Chart.ChartClickEvent Describes chart click event.
static class	Chart.ChartRightClickEvent Describes chart click event.
static class	Chart.CursorPeriodSelectEvent Describes cursor period select event.
static class	Chart.CursorZoomEvent Describes cursor zoom event.
static class	Chart.GraphClickEvent Describes graph click event.
static class	Chart.GraphItemClickEvent Describes graph item click event.
static class	Chart.GraphItemRightClickEvent Describes graph item click event.
static class	Chart.LegendItemClickEvent Describes legend item click event.
static class	Chart.LegendItemEvent Describes legend item click event.
static class	Chart.LegendItemHideEvent Describes legend item hide event.
static class	Chart.LegendItemShowEvent Describes legend item show event.
static class	Chart.LegendMarkerClickEvent Describes legend marker click event.
static class	Chart.RollOutGraphEvent Describes the graph roll-out event.
static class	Chart.RollOutGraphItemEvent Describes the data item roll-out event.
static class	Chart.RollOverGraphEvent Describes the graph roll-over event.
static class	Chart.RollOverGraphItemEvent Describes the data item roll-over event.
static class	Chart.SliceClickEvent Describes slice click event.
static class	Chart.SlicePullInEvent Describes slice pull-in event.
static class	Chart.SlicePullOutEvent Describes slice pull-out event.
static class	Chart.SliceRightClickEvent Describes slice click event.
static class	Chart.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 inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addClickListener(java.util.function.Consumer<Chart.ChartClickEvent> listener) Adds a listener for a chart.
io.jmix.core.common.event.Subscription	addLegendItemHideListener(java.util.function.Consumer<Chart.LegendItemHideEvent> listener) Adds a listener for a chart.
io.jmix.core.common.event.Subscription	addLegendItemShowListener(java.util.function.Consumer<Chart.LegendItemShowEvent> listener) Adds a listener for a chart.
io.jmix.core.common.event.Subscription	addLegendLabelClickListener(java.util.function.Consumer<Chart.LegendItemClickEvent> listener) Adds a listener for a chart.
io.jmix.core.common.event.Subscription	addLegendMarkerClickListener(java.util.function.Consumer<Chart.LegendMarkerClickEvent> listener) Adds a listener for a chart.
io.jmix.core.common.event.Subscription	addRightClickListener(java.util.function.Consumer<Chart.ChartRightClickEvent> listener) Adds a listener for a chart.
DataProvider	getDataProvider()
java.lang.String	getNativeJson()
void	repaint() Resend all items and properties to client and repaint chart.
T	setDataProvider(DataProvider dataProvider) Sets data provider that contains data set.
void	setNativeJson(java.lang.String json) Set additional JSON configuration as a string.

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

addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleDescription, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

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

getFrame, setFrame

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.HasIcon

getIcon, setIcon, setIconFromSet

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

getCaption, setCaption

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

getDescription, setDescription

Method Detail

getDataProvider

DataProvider getDataProvider()

Specified by:

getDataProvider in interface ChartModel<T extends Chart>

Returns:

the data provider

setDataProvider

T setDataProvider(DataProvider dataProvider)

Description copied from interface: ChartModel

Sets data provider that contains data set.

Specified by:

setDataProvider in interface ChartModel<T extends Chart>

Parameters:

dataProvider - the data provider

Returns:

chart

See Also:

ContainerDataProvider, ListDataProvider

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

io.jmix.core.common.event.Subscription addClickListener(java.util.function.Consumer<Chart.ChartClickEvent> listener)

Adds a listener for a chart. Called when user clicks on the chart.

Parameters:

listener - a listener to add

Returns:

subscription

addRightClickListener

io.jmix.core.common.event.Subscription addRightClickListener(java.util.function.Consumer<Chart.ChartRightClickEvent> listener)

Adds a listener for a chart. Called when user clicks on the chart.

Parameters:

listener - a listener to add

Returns:

subscription

addLegendItemHideListener

io.jmix.core.common.event.Subscription addLegendItemHideListener(java.util.function.Consumer<Chart.LegendItemHideEvent> listener)

Adds a listener for a chart. Called when the legend item hided.

Parameters:

listener - a listener to add

Returns:

subscription

addLegendItemShowListener

io.jmix.core.common.event.Subscription addLegendItemShowListener(java.util.function.Consumer<Chart.LegendItemShowEvent> listener)

Adds a listener for a chart. Called when the legend item showed.

Parameters:

listener - a listener to add

Returns:

subscription

addLegendLabelClickListener

io.jmix.core.common.event.Subscription addLegendLabelClickListener(java.util.function.Consumer<Chart.LegendItemClickEvent> listener)

Adds a listener for a chart. Called when user clicks on the legend item.

Parameters:

listener - a listener to add

Returns:

subscription

addLegendMarkerClickListener

io.jmix.core.common.event.Subscription addLegendMarkerClickListener(java.util.function.Consumer<Chart.LegendMarkerClickEvent> listener)

Adds a listener for a chart. Called when user clicks on the legend marker.

Parameters:

listener - a listener to add

Returns:

subscription

setNativeJson

void setNativeJson(java.lang.String json)

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

Parameters:

json - JSON configuration

getNativeJson

java.lang.String getNativeJson()

Returns:

additional JSON configuration as a string.