Class ChartSelection

All Implemented Interfaces:
HasHandlers

public class ChartSelection extends DataClass
The complete state of a FacetChart's value selection, as returned by FacetChart.getChartSelection() and accepted by FacetChart.setChartSelection().

The three lists are kept apart because a group selection and the values it happens to cover are different statements of intent, and only the distinction survives a pivot or a data change intact.

  • Constructor Details

    • ChartSelection

      public ChartSelection()
    • ChartSelection

      public ChartSelection(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static ChartSelection getOrCreateRef(JavaScriptObject jsObj)
    • setExclusions

      public ChartSelection setExclusions(FacetValueMap... exclusions)
      Individual values deselected from within a selected group - holes punched in a group selection rather than a dissolution of it. An exclusion outranks the group that covers it.
      Parameters:
      exclusions - New exclusions value. Default value is null
      Returns:
      ChartSelection instance, for chaining setter calls
    • getExclusions

      public FacetValueMap[] getExclusions()
      Individual values deselected from within a selected group - holes punched in a group selection rather than a dissolution of it. An exclusion outranks the group that covers it.
      Returns:
      Current exclusions value. Default value is null
    • setFacetValues

      public ChartSelection setFacetValues(FacetValueMap... facetValues)
      Facet values selected as groups, each naming one facet value or, for a nested data-label selection, the combination identifying it. Partial coordinates: the facets not named are the ones the group spans.
      Parameters:
      facetValues - New facetValues value. Default value is null
      Returns:
      ChartSelection instance, for chaining setter calls
    • getFacetValues

      public FacetValueMap[] getFacetValues()
      Facet values selected as groups, each naming one facet value or, for a nested data-label selection, the combination identifying it. Partial coordinates: the facets not named are the ones the group spans.
      Returns:
      Current facetValues value. Default value is null
    • setValues

      public ChartSelection setValues(FacetValueMap... values)
      Individually selected data values, as complete coordinates over the chart's dimension facets.
      Parameters:
      values - New values value. Default value is null
      Returns:
      ChartSelection instance, for chaining setter calls
    • getValues

      public FacetValueMap[] getValues()
      Individually selected data values, as complete coordinates over the chart's dimension facets.
      Returns:
      Current values value. Default value is null