Package com.vaadin.flow.component.charts.model

Interface Series

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractSeries, DataProviderSeries, DataSeries, HeatSeries, ListSeries, NodeSeries, RangeSeries, TreeSeries
public interface Series extends Serializable
Series interface for all kinds of Series

  • Method Details

    • getName

      String getName()
      Returns:
      The name of the series.
      See Also:

    • setName

      void setName(String name)
      Sets the name of the series as shown in the legend, tooltip etc. Defaults to "".
      Parameters:
      name -

    • setConfiguration

      void setConfiguration(Configuration configuration)
      Sets the configuration to which this series is linked.
      Parameters:
      configuration -

    • getPlotOptions

      AbstractPlotOptions getPlotOptions()
      Gets the plot options related to this specific series. This is needed e.g. in combined charts.
      Returns:

    • setPlotOptions

      void setPlotOptions(AbstractPlotOptions plotOptions)
      Sets the plot options for this specific series. The type of the plot options also explicitly sets the chart type used when rendering this particular series. If plot options is null, the component wide chart type is used.

      Options that are not defined at this level will be inherited from the chart and theme levels.

      Parameters:
      plotOptions -

    • getId

      String getId()
      Returns:
      the series ID

    • setId

      void setId(String id)
      Sets an id for the series
      Parameters:
      id - new ID to set