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

  • Method Details

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

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

      Subscription addRightClickListener(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

      Subscription addLegendItemHideListener(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

      Subscription addLegendItemShowListener(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

      Subscription addLegendLabelClickListener(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

      Subscription addLegendMarkerClickListener(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(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

      String getNativeJson()
      Returns:
      additional JSON configuration as a string.