Class Chart
- All Implemented Interfaces:
AttachNotifier
,DetachNotifier
,HasElement
,HasSize
,HasStyle
,HasTheme
,Serializable
The Chart is a regular Vaadin component, which you can add to any Vaadin layout.
- Author:
- Vaadin Ltd
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdds a chart add series listener, which will be notified after a new series is added to the chartAdds a chart after print listener, which will be notified after the chart is printed using the print menuAdds a chart before print listener, which will be notified before the chart is printed using the print menuAdds chart click listener, which will be notified of clicks on the chart areaAdds chart drillupall listener, which will be notified after all the series have been drilled up in a chart with multiple drilldown series.Adds chart drillup listener, which will be notified of clicks on the 'Back to previous series' button.Adds a chart load listener, which will be notified after a chart is loadedAdds a chart redraw listener, which will be notified after a chart is redrawnAdds a chart selection listenerAdds checkbox click listener, which will be notified when user has clicked a checkbox in the legendSets the Chart drilldown handler that's responsible for returning the drilldown series for each drilldown callback when doing async drilldownAdds a point click listener, which will be notified of clicks on the points, bars or columns in the chartAdds a point legend item click listener, which will be notified of clicks on the legend's items corresponding to a PointAdds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a data pointAdds a point mouse over listener, which will be notified when the mouse enters the neighborhood of a data pointAdds a point remove listener, which will be notified when a data point is removed.Adds a point select listener, which will be notified when a data point is selected.Adds a point unselect listener, which will be notified when a data point is unselected.Adds a point update listener, which will be notified when a data point is updated.Adds a series after animate listener, which will be notified after a series is animatedAdds a series click listener, which will be notified of clicks on the series in the chartAdds a series hide listener, which will be notified when a series is hiddenAdds a series legend item click listener, which will be notified of clicks on the legend's items corresponding to a SeriesAdds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a seriesAdds a point mouse out listener, which will be notified when the mouse enters the neighborhood of a seriesAdds a series show listener, which will be notified when a series is shownvoid
addThemeVariants
(ChartVariant... variants) Adds theme variants to the component.Adds a x axes extremes set listener, which will be notified when an x axis extremes are setAdds a y axes extremes set listener, which will be notified when an y axis extremes are setvoid
Draws a chart using the current configuration.void
drawChart
(boolean resetConfiguration) Draws a chart using the current configuration.protected void
onAttach
(AttachEvent attachEvent) Called when the component is attached to a UI.void
removeThemeVariants
(ChartVariant... variants) Removes theme variants from the component.void
setConfiguration
(Configuration configuration) void
setDrilldownCallback
(DrilldownCallback drilldownCallback) void
setTimeline
(Boolean timeline) Determines if the chart is in timeline mode or in normal mode.void
setVisibilityTogglingDisabled
(boolean disabled) The series or point visibility is toggled by default if user clicks the legend item that corresponds to the series or point.Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
Constructor Details
-
Chart
public Chart()Creates a new chart with default configuration -
Chart
Creates a new chart with the given type- Parameters:
type
-- See Also:
-
-
Method Details
-
onAttach
Description copied from class:Component
Called when the component is attached to a UI.This method is invoked before the
Make sure to callAttachEvent
is fired for the component.super.onAttach
when overriding this method. -
drawChart
public void drawChart()Draws a chart using the current configuration.- See Also:
-
drawChart
public void drawChart(boolean resetConfiguration) Draws a chart using the current configuration.The chart takes the current configuration from
getConfiguration()
.Note that if you modify the underlying
Series
directly, the chart will automatically be updated.Note that you don't need to call this method if
Configuration
is ready before element is attached.- Parameters:
resetConfiguration
- defines whether the chart should be redrawn or not- See Also:
-
setTimeline
Determines if the chart is in timeline mode or in normal mode. The following chart types do not support timeline mode:- ChartType.PIE
- ChartType.GAUGE
- ChartType.SOLIDGAUGE
- ChartType.PYRAMID
- ChartType.FUNNEL
- ChartType.ORGANIZATION
IllegalArgumentException
Note: for Timeline chart type see
ChartType.TIMELINE
andPlotOptionsTimeline
.- Parameters:
timeline
- true for timeline chart
-
setVisibilityTogglingDisabled
public void setVisibilityTogglingDisabled(boolean disabled) The series or point visibility is toggled by default if user clicks the legend item that corresponds to the series or point. Calling setVisibilityTogglingDisabled(true
) will disable this behavior.- Parameters:
disabled
-
-
getConfiguration
- Returns:
- the chart configuration that is used for this chart
-
setConfiguration
- Parameters:
configuration
- new configuration for this chart.
-
getDrilldownCallback
-
setDrilldownCallback
-
addChartAddSeriesListener
Adds a chart add series listener, which will be notified after a new series is added to the chart- Parameters:
listener
-
-
addChartAfterPrintListener
public Registration addChartAfterPrintListener(ComponentEventListener<ChartAfterPrintEvent> listener) Adds a chart after print listener, which will be notified after the chart is printed using the print menu- Parameters:
listener
-
-
addChartBeforePrintListener
public Registration addChartBeforePrintListener(ComponentEventListener<ChartBeforePrintEvent> listener) Adds a chart before print listener, which will be notified before the chart is printed using the print menu- Parameters:
listener
-
-
addChartClickListener
Adds chart click listener, which will be notified of clicks on the chart area- Parameters:
listener
-
-
addChartDrillupListener
Adds chart drillup listener, which will be notified of clicks on the 'Back to previous series' button.- Parameters:
listener
-
-
addChartDrillupAllListener
public Registration addChartDrillupAllListener(ComponentEventListener<ChartDrillupAllEvent> listener) Adds chart drillupall listener, which will be notified after all the series have been drilled up in a chart with multiple drilldown series.- Parameters:
listener
-
-
addChartLoadListener
Adds a chart load listener, which will be notified after a chart is loaded- Parameters:
listener
-
-
addChartRedrawListener
Adds a chart redraw listener, which will be notified after a chart is redrawn- Parameters:
listener
-
-
addCheckBoxClickListener
public Registration addCheckBoxClickListener(ComponentEventListener<SeriesCheckboxClickEvent> listener) Adds checkbox click listener, which will be notified when user has clicked a checkbox in the legend- Parameters:
listener
-
-
addDrilldownListener
Sets the Chart drilldown handler that's responsible for returning the drilldown series for each drilldown callback when doing async drilldown- Parameters:
listener
-- See Also:
-
addChartSelectionListener
Adds a chart selection listenerNote that if a chart selection listener is set, default action for selection is prevented. Most commonly this means that client side zoom doesn't work and you are responsible for setting the zoom, etc in the listener implementation.
- Parameters:
listener
-
-
addSeriesLegendItemClickListener
public Registration addSeriesLegendItemClickListener(ComponentEventListener<SeriesLegendItemClickEvent> listener) Adds a series legend item click listener, which will be notified of clicks on the legend's items corresponding to a SeriesNote that by default, clicking on a legend item toggles the visibility of its associated series. To disable this behavior call setVisibilityTogglingDisabled(
true
)- Parameters:
listener
-- See Also:
-
addPointLegendItemClickListener
public Registration addPointLegendItemClickListener(ComponentEventListener<PointLegendItemClickEvent> listener) Adds a point legend item click listener, which will be notified of clicks on the legend's items corresponding to a PointNote that by default, clicking on a legend item toggles the visibility of its associated point. To disable this behavior call setVisibilityTogglingDisabled(
true
)- Parameters:
listener
-- See Also:
-
addSeriesAfterAnimateListener
public Registration addSeriesAfterAnimateListener(ComponentEventListener<SeriesAfterAnimateEvent> listener) Adds a series after animate listener, which will be notified after a series is animated- Parameters:
listener
-
-
addSeriesClickListener
Adds a series click listener, which will be notified of clicks on the series in the chart- Parameters:
listener
-
-
addSeriesHideListener
Adds a series hide listener, which will be notified when a series is hidden- Parameters:
listener
-
-
addSeriesMouseOutListener
Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a series- Parameters:
listener
-
-
addSeriesMouseOverListener
public Registration addSeriesMouseOverListener(ComponentEventListener<SeriesMouseOverEvent> listener) Adds a point mouse out listener, which will be notified when the mouse enters the neighborhood of a series- Parameters:
listener
-
-
addSeriesShowListener
Adds a series show listener, which will be notified when a series is shown- Parameters:
listener
-
-
addPointClickListener
Adds a point click listener, which will be notified of clicks on the points, bars or columns in the chart- Parameters:
listener
-
-
addPointMouseOutListener
Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a data point- Parameters:
listener
-
-
addPointMouseOverListener
Adds a point mouse over listener, which will be notified when the mouse enters the neighborhood of a data point- Parameters:
listener
-
-
addPointRemoveListener
Adds a point remove listener, which will be notified when a data point is removed.- Parameters:
listener
-
-
addPointSelectListener
Adds a point select listener, which will be notified when a data point is selected.- Parameters:
listener
-
-
addPointUnselectListener
Adds a point unselect listener, which will be notified when a data point is unselected.- Parameters:
listener
-
-
addPointUpdateListener
Adds a point update listener, which will be notified when a data point is updated.- Parameters:
listener
-
-
addXAxesExtremesSetListener
public Registration addXAxesExtremesSetListener(ComponentEventListener<XAxesExtremesSetEvent> listener) Adds a x axes extremes set listener, which will be notified when an x axis extremes are set- Parameters:
listener
-
-
addYAxesExtremesSetListener
public Registration addYAxesExtremesSetListener(ComponentEventListener<YAxesExtremesSetEvent> listener) Adds a y axes extremes set listener, which will be notified when an y axis extremes are set- Parameters:
listener
-
-
addThemeVariants
Adds theme variants to the component.- Parameters:
variants
- theme variants to add
-
removeThemeVariants
Removes theme variants from the component.- Parameters:
variants
- theme variants to remove
-