Package com.vaadin.flow.component.charts

Class Chart

  • All Implemented Interfaces:
    AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, HasTheme, Serializable
    @Tag("vaadin-chart")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.3.30") @NpmPackage(value="@vaadin/charts",version="23.3.30") @NpmPackage(value="@vaadin/vaadin-charts",version="23.3.30")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/charts/src/vaadin-chart.js")
public class Chart
extends Component
implements HasStyle, HasSize, HasTheme
    Vaadin Charts is a feature-rich interactive charting library for Vaadin. It provides multiple different chart types for visualizing one- or two-dimensional tabular data, or scatter data with free X and Y values. You can configure all the chart elements with a powerful API as well as the visual style using CSS. The built-in functionalities allow the user to interact with the chart elements in various ways, and you can define custom interaction with events.

    The Chart is a regular Vaadin component, which you can add to any Vaadin layout.

    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Constructor Detail

      • Chart

        public Chart()
        Creates a new chart with default configuration

      • Chart

        public Chart​(ChartType type)
        Creates a new chart with the given type
        Parameters:
        type -
        See Also:
        Chart()

    • Method Detail

      • onAttach

        protected void onAttach​(AttachEvent attachEvent)
        Description copied from class: Component
        Called when the component is attached to a UI.

        The default implementation does nothing.

        This method is invoked before the AttachEvent is fired for the component.

        Overrides:
        onAttach in class Component
        Parameters:
        attachEvent - the attach event

      • drawChart

        public void drawChart()
        Draws a chart using the current configuration.
        See Also:
        drawChart(boolean)

      • 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:
        getConfiguration()

      • setTimeline

        public void setTimeline​(Boolean timeline)
        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
        Enabling timeline mode in these unsupported chart types results in an IllegalArgumentException

        Note: for Timeline chart type see ChartType.TIMELINE and PlotOptionsTimeline.

        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

        public Configuration getConfiguration()
        Returns:
        the chart configuration that is used for this chart

      • setConfiguration

        public void setConfiguration​(Configuration configuration)
        Parameters:
        configuration - new configuration for this chart.

      • setDrilldownCallback

        public void setDrilldownCallback​(DrilldownCallback drilldownCallback)

      • 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 -

      • addChartSelectionListener

        public Registration addChartSelectionListener​(ComponentEventListener<ChartSelectionEvent> listener)
        Adds a chart selection listener

        Note 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 Series

        Note 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:
        setVisibilityTogglingDisabled(boolean)

      • 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 Point

        Note 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:
        setVisibilityTogglingDisabled(boolean)

      • addPointClickListener

        public Registration addPointClickListener​(ComponentEventListener<PointClickEvent> listener)
        Adds a point click listener, which will be notified of clicks on the points, bars or columns in the chart
        Parameters:
        listener -

      • addPointMouseOutListener

        public Registration addPointMouseOutListener​(ComponentEventListener<PointMouseOutEvent> listener)
        Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a data point
        Parameters:
        listener -

      • addPointMouseOverListener

        public Registration addPointMouseOverListener​(ComponentEventListener<PointMouseOverEvent> listener)
        Adds a point mouse over listener, which will be notified when the mouse enters the neighborhood of a data point
        Parameters:
        listener -

      • addThemeVariants

        public void addThemeVariants​(ChartVariant... variants)
        Adds theme variants to the component.
        Parameters:
        variants - theme variants to add

      • removeThemeVariants

        public void removeThemeVariants​(ChartVariant... variants)
        Removes theme variants from the component.
        Parameters:
        variants - theme variants to remove