Package com.jbstrap.ui.components.charts

Interface SupportLasso<T extends BaseChart<?>>

Type Parameters:
T - Chart type
All Known Implementing Classes:
AreaChart, BarChart, BubbleChart, DotChart, HorizontalBarChart, HorizontalStackedBarChart, LineChart, PopulationPyramidChart, StackedAreaChart, StackedBarChart
public interface SupportLasso<T extends BaseChart<?>>
Charts that implement this interface can use the lasso feature. The lasso feature enables the user to select one or more data points at the same time.
Since:
4.0
Author:
JBStrap

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    LASSO
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    addLassoHandler(ChartLassoEventHandler handler)
    Adds a lasso event to the chart.
    default boolean
    isLassoEnabled()
    Checks if the lasso feature is enabled on the chart.
    default T
    setLassoEnabled(boolean enabled)
    Enables/disables the lasso feature.

  • Field Details

  • Method Details

    • addLassoHandler

      default T addLassoHandler(ChartLassoEventHandler handler)

      Adds a lasso event to the chart.

      The lasso event is triggered if the user selects one or more data points on the chart at the same time.

      Parameters:
      handler - Click event handler
      Returns:
      Chart
      See Also:

    • setLassoEnabled

      default T setLassoEnabled(boolean enabled)
      Enables/disables the lasso feature. Enabling the lasso feature allows the user to select one or more data points at the same time. Selecting a data points triggers an event that can be handled on the server side. The default setting for the lasso feature is disabled.
      Parameters:
      enabled - If true is set, the lasso feature is enabled, otherwise it is disabled
      Returns:
      Chart

    • isLassoEnabled

      default boolean isLassoEnabled()
      Checks if the lasso feature is enabled on the chart.
      Returns:
      If true, the lasso feature is enabled on the chart, that is, the user is allowed to select one or more data points at the same time If false, the lasso function is disabled.