Package io.deephaven.multiviewwidget.builder

Interface PivotViewBuilder

All Superinterfaces:
ViewFactory
All Known Implementing Classes:
PivotViewBuilderImpl
public interface PivotViewBuilder extends ViewFactory
A builder to create Pivot views. See ViewFactory.addPivotView(String, Table, Color, String, String, String, AggType)

  • Method Details

    • groupingColumns

      @ScriptApi @NotNull @NotNull PivotViewBuilder groupingColumns(@NotNull @NotNull Collection<String> pivotGroupingCols)
      Adds additional column(s) whose distinct values may be used to define the rows in the resultant pivot-table. These column names will be shown under the "Grouping Columns" selection table
      Parameters:
      pivotGroupingCols - additional grouping-column/rowCol names to list
      Returns:
      this PivotViewBuilder

    • groupingColumns

      @ScriptApi @NotNull default @NotNull PivotViewBuilder groupingColumns(@NotNull @NotNull String... pivotGroupingCols)
      Adds additional column(s) whose distinct values may be used to define the rows in the resultant pivot-table. These column names will be shown under the "Grouping Columns" selection table
      Parameters:
      pivotGroupingCols - additional grouping-column/rowCol names to list
      Returns:
      this PivotViewBuilder

    • pivotColumns

      @ScriptApi @NotNull @NotNull PivotViewBuilder pivotColumns(@NotNull @NotNull Collection<String> pivotCols)
      Adds additional column(s) whose distinct values may be used to define the columns in the resultant pivot-table. These column names will be shown under the "Pivot Column" selection table
      Parameters:
      pivotCols - additional grouping-column/rowCol names to list
      Returns:
      this PivotViewBuilder

    • pivotColumns

      @ScriptApi @NotNull default @NotNull PivotViewBuilder pivotColumns(@NotNull @NotNull String... pivotCols)
      Adds additional column(s) whose distinct values may be used to define the columns in the resultant pivot-table. These column names will be shown under the "Pivot Column" selection table
      Parameters:
      pivotCols - additional grouping-column/rowCol names to list
      Returns:
      this PivotViewBuilder

    • pivot

      @ScriptApi @NotNull @NotNull PivotViewBuilder pivot(@Nullable @Nullable AggType aggType, @Nullable @Nullable Collection<String> pivotTypeCols)
      Adds additional pivot aggregation column(s) whose values may be aggregated in the resultant pivot-table. These column names will be shown under the "Aggregation Type" selection menu, along with the aggregation-name
      Parameters:
      aggType - the aggregation-type that may be applied to each of the pivotTypeCols
      pivotTypeCols - column-name(s) which may have the aggType applied
      Returns:
      this PivotViewBuilder

    • pivot

      @ScriptApi @NotNull default @NotNull PivotViewBuilder pivot(@Nullable @Nullable AggType aggType, @NotNull @NotNull String... pivotTypeCols)
      Adds additional pivot aggregation column(s) whose values may be aggregated in the resultant pivot-table. These column names will be shown under the "Aggregation Type" selection menu, along with the aggregation-name
      Parameters:
      aggType - the aggregation-type that may be applied to each of the pivotTypeCols
      pivotTypeCols - column-name(s) which may have the aggType applied
      Returns:
      this PivotViewBuilder

    • pivot

      @ScriptApi @NotNull default @NotNull PivotViewBuilder pivot(@NotNull @NotNull Collection<String> pivotTypeCols)
      Adds additional pivot aggregation column(s) whose values may be aggregated in the resultant pivot-table. These column names will be shown under the "Aggregation Type" selection menu
      Parameters:
      pivotTypeCols - column-name(s) which may have the type-specific default aggregation applied
      Returns:
      this PivotViewBuilder

    • pivot

      @ScriptApi @NotNull default @NotNull PivotViewBuilder pivot(@NotNull @NotNull String... pivotTypeCols)
      Adds additional pivot aggregation column(s) whose values may be aggregated in the resultant pivot-table. These column names will be shown under the "Aggregation Type" selection menu
      Parameters:
      pivotTypeCols - column-name(s) which may have the type-specific default aggregation applied
      Returns:
      this PivotViewBuilder

    • withTotals

      @NotNull @ScriptApi @NotNull PivotViewBuilder withTotals(boolean includeTotals)
      Identifies if the view should include totals calculations.
      Parameters:
      includeTotals - if the view should include totals column and row.
      Returns:
      this PivotViewBuilder

    • withTotalsDown

      @NotNull @ScriptApi @NotNull PivotViewBuilder withTotalsDown(boolean includeTotals)
      Identifies if the view should include a totals row. This is 'true' by default.
      Parameters:
      includeTotals - if the view should include totals row.
      Returns:
      this PivotViewBuilder

    • withTotalsAcross

      @NotNull @ScriptApi @NotNull PivotViewBuilder withTotalsAcross(boolean includeTotals)
      Identifies if the view should include a totals column. This is 'false' by default.
      Parameters:
      includeTotals - if the view should include totals column.
      Returns:
      this PivotViewBuilder

    • pivotSortAscending

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSortAscending(@NotNull @NotNull Collection<String> pivotSortCols)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant sorting
      Returns:
      this PivotViewBuilder

    • pivotSortAscending

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotSortAscending(@NotNull @NotNull String... pivotSortCols)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant sorting
      Returns:
      this PivotViewBuilder

    • pivotSortDescending

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSortDescending(@NotNull @NotNull Collection<String> pivotSortCols)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant sorting
      Returns:
      this PivotViewBuilder

    • pivotSortDescending

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotSortDescending(@NotNull @NotNull String... pivotSortCols)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant sorting
      Returns:
      this PivotViewBuilder

    • pivotSortColumnAscending

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSortColumnAscending(@NotNull @NotNull Collection<String> pivotSortCols)
      Identifies columns used for sort-ordering the columns of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant column sorting
      Returns:
      this PivotViewBuilder

    • pivotSortColumnAscending

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotSortColumnAscending(@NotNull @NotNull String... pivotSortCols)
      Identifies columns used for sort-ordering the columns of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant column sorting
      Returns:
      this PivotViewBuilder

    • pivotSortColumnDescending

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSortColumnDescending(@NotNull @NotNull Collection<String> pivotSortCols)
      Identifies columns used for sort-ordering the columns of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant column sorting
      Returns:
      this PivotViewBuilder

    • pivotSortColumnDescending

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotSortColumnDescending(@NotNull @NotNull String... pivotSortCols)
      Identifies columns used for sort-ordering the columns of the resultant table
      Parameters:
      pivotSortCols - column name(s) which will identify the resultant column sorting
      Returns:
      this PivotViewBuilder

    • pivotSetRowDecimalFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetRowDecimalFormat(@NotNull @NotNull String decimalFormat)
      Defines display format for "Grouping Column(s)" when the column-type is non-whole numeric
      Parameters:
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotSetRowIntegerFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetRowIntegerFormat(@NotNull @NotNull String decimalFormat)
      Defines display format for "Grouping Column(s)" when the column-type is a whole number
      Parameters:
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotSetMainDecimalFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetMainDecimalFormat(@NotNull @NotNull String decimalFormat)
      Defines display format for aggregated values when the aggregation results in a non-whole number type
      Parameters:
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotSetMainIntegerFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetMainIntegerFormat(@NotNull @NotNull String decimalFormat)
      Defines display format for aggregated values when the aggregation results in a whole number type
      Parameters:
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotSetDecimalFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetDecimalFormat(@NotNull @NotNull String pivotColumn, @NotNull @NotNull PivotRole pivotRole, @NotNull @NotNull String decimalFormat)
      Defines display format for a specific source-table column and its role in the current view. Formats defined by this method will supersede those defined by pivotSetMainDecimalFormat(String) and pivotSetRowDecimalFormat(String), but only for the defined pivotColumn in the defined pivotRole
      Parameters:
      pivotColumn - a numeric column which will have this format applied in the context defined by pivotRole
      pivotRole - either PivotRole.MainColumns or PivotRole.RowColumns
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotSetIntegerFormat

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotSetIntegerFormat(@NotNull @NotNull String pivotColumn, @NotNull @NotNull PivotRole pivotRole, @NotNull @NotNull String decimalFormat)
      Defines display format for a specific source-table column and its role in the current view. Formats defined by this method will supersede those defined by pivotSetMainIntegerFormat(String) and pivotSetRowIntegerFormat(String), but only for the defined pivotColumn in the defined pivotRole
      Parameters:
      pivotColumn - a numeric column which will have this format applied in the context defined by pivotRole
      pivotRole - either PivotRole.MainColumns or PivotRole.RowColumns
      decimalFormat - a valid numeric format
      Returns:
      this PivotViewBuilder

    • pivotHeatMap

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotHeatMap(@Nullable @Nullable Color minColor, @Nullable @Nullable Color maxColor, boolean centerZero)
      Used to enable heatmap coloration of numeric values in the resultant pivot-table. Min/Max values are calculated on a live basis to determine appropriate gradient scaling
      Parameters:
      minColor - the color to use for the calculated Min value
      maxColor - the color to use for the calculated Max value
      centerZero - identifies if the center of the heatmap should be forced to zero
      Returns:
      this PivotViewBuilder

    • pivotHeatMap

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotHeatMap(@NotNull @NotNull PivotHeatMapBuilder builder, @Nullable @Nullable AggType aggType, @Nullable @Nullable String... aggCols)

    • pivotHeatMap

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotHeatMap(@NotNull @NotNull PivotHeatMapBuilder builder, @Nullable @Nullable AggType aggType)

    • pivotHeatMap

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotHeatMap(@NotNull @NotNull PivotHeatMapBuilder builder)

    • pivotHeatMap

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotHeatMap(@NotNull @NotNull Color minColor, @NotNull @NotNull Color maxColor)
      Used to enable heatmap coloration of numeric values in the resultant pivot-table. Min/Max values are calculated on a live basis to determine appropriate gradient scaling, and will not be centered around zero
      Parameters:
      minColor - the color to use for the calculated Min value
      maxColor - the color to use for the calculated Max value
      Returns:
      this PivotViewBuilder

    • pivotHeatMap

      @NotNull @ScriptApi default @NotNull PivotViewBuilder pivotHeatMap(boolean centerZero)
      Used to enable heatmap coloration of numeric values in the resultant pivot-table. Min/Max values are calculated on a live basis to determine appropriate gradient scaling. MinColor and MaxColor will be defaulted
      Parameters:
      centerZero - identifies if the center of the heatmap should be forced to zero
      Returns:
      this PivotViewBuilder

    • pivotMaxStaticCols

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotMaxStaticCols(int maxCols)
      Defines the maximum number of columns allowed in a resultant pivot-table derived from a non-live source. In the case that the table will have more columns than are permitted, the build-request will throw an exception
      Parameters:
      maxCols - maximum number of pivoted-columns in a static table
      Returns:
      this PivotViewBuilder

    • pivotMaxTickingCols

      @NotNull @ScriptApi @NotNull PivotViewBuilder pivotMaxTickingCols(int maxCols)
      Defines the maximum number of columns allowed in a resultant pivot-table derived from a live source. In the case that the table will have more columns than are permitted, the build-request will throw an exception. If the table grows to be larger than permitted, the table will stop receiving updates
      Parameters:
      maxCols - maximum number of pivoted-columns in a ticking table
      Returns:
      this PivotViewBuilder

    • collapseSideView

      @NotNull @ScriptApi default @NotNull PivotViewBuilder collapseSideView()
      Identifies that the side-panel for this view should start collapsed
      Returns:
      this PivotViewBuilder

    • collapseSideView

      @NotNull @ScriptApi @NotNull PivotViewBuilder collapseSideView(boolean startCollapsed)
      Identifies if the side-panel for this view should start collapsed
      Returns:
      this PivotViewBuilder

    • linkTo

      @NotNull @ScriptApi @NotNull PivotViewBuilder linkTo(@NotNull @NotNull String linkTarget)
      Defines a directional link to another view-tab. The cell-defined "Grouping Column(s)" and "Pivot Column" will be used as filters on the linked view
      Parameters:
      linkTarget - a view-tab to which this table is linked
      Returns:
      this PivotViewBuilder