Package io.deephaven.multiviewwidget.builder

Interface RollupViewBuilder

All Superinterfaces:
ViewFactory
All Known Implementing Classes:
RollupViewBuilderImpl
public interface RollupViewBuilder extends ViewFactory

  • Method Details

    • groupingColumns

      @NotNull @ScriptApi @NotNull RollupViewBuilder groupingColumns(@NotNull @NotNull Collection<String> groupingCols)
      Set the allowable set of grouping columns. These will be displayed to the user for customization.
      Parameters:
      groupingCols - the allowable grouping columns.
      Returns:
      this RollupViewBuilder

    • groupingColumns

      @NotNull @ScriptApi default @NotNull RollupViewBuilder groupingColumns(@NotNull @NotNull String... groupingCols)
      Set the allowable set of grouping columns. These will be displayed to the user for customization.
      Parameters:
      groupingCols - the allowable grouping columns.
      Returns:
      this RollupViewBuilder

    • defaultRollup

      @NotNull @ScriptApi @NotNull RollupViewBuilder defaultRollup(@NotNull @NotNull RollupDefinition rollup)
      Set the default rollup that will be applied when the widget is opened.
      Parameters:
      rollup - the rollup
      Returns:
      this RollupViewBuilder

    • agg

      @NotNull @ScriptApi @NotNull RollupViewBuilder agg(@NotNull @NotNull Class<?> type, @NotNull @NotNull AggType agg)
      Set the default aggregation to apply for the specified type if the user does not choose a different one.
      Parameters:
      type - the type
      agg - the default agg for this type
      Returns:
      this RollupViewBuilder

    • agg

      @NotNull @ScriptApi default @NotNull RollupViewBuilder agg(@NotNull @NotNull String column, @NotNull @NotNull AggType... aggs)
      Set the default aggregations to apply for a specific column. This takes precedence over default type aggs.
      Parameters:
      column - the column name
      aggs - the default aggs for this column.
      Returns:
      this RollupViewBuilder

    • agg

      @NotNull @ScriptApi @NotNull RollupViewBuilder agg(@NotNull @NotNull String column, @NotNull @NotNull Collection<AggType> aggs)
      Set the default aggregations to apply for a specific column. This takes precedence over default type aggs.
      Parameters:
      column - the column name
      aggs - the default aggs for this column.
      Returns:
      this RollupViewBuilder

    • sortAscending

      @NotNull @ScriptApi default @NotNull RollupViewBuilder sortAscending(@NotNull @NotNull String column, @Nullable @Nullable AggType... aggs)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      column - column name which will identify the resultant sorting
      aggs - the aggregation to be sorted. No parameter indicates sort the grouping column if available.
      Returns:
      this RollupViewBuilder

    • sortAscending

      @NotNull @ScriptApi @NotNull RollupViewBuilder sortAscending(@NotNull @NotNull String column, @NotNull @NotNull Collection<AggType> aggs)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      column - column name which will identify the resultant sorting * @param aggs the aggregation to be sorted. No parameter indicates sort the grouping column if available.
      Returns:
      this RollupViewBuilder

    • sortDescending

      @NotNull @ScriptApi default @NotNull RollupViewBuilder sortDescending(@NotNull @NotNull String column, @Nullable @Nullable AggType... aggs)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      column - column name which will identify the resultant sorting
      aggs - the aggregation to be sorted. No parameter indicates sort the grouping column if available.
      Returns:
      this RollupViewBuilder

    • sortDescending

      @NotNull @ScriptApi @NotNull RollupViewBuilder sortDescending(@NotNull @NotNull String column, @NotNull @NotNull Collection<AggType> aggs)
      Identifies columns used for sort-ordering of the resultant table
      Parameters:
      column - column name which will identify the resultant sorting
      aggs - the aggregation to be sorted. No parameter indicates sort the grouping column if available.
      Returns:
      this RollupViewBuilder

    • columnOrder

      @NotNull @ScriptApi @NotNull RollupViewBuilder columnOrder(@NotNull @NotNull Collection<String> columnOrder)

    • columnOrder

      @NotNull @ScriptApi default @NotNull RollupViewBuilder columnOrder(@NotNull @NotNull String... columnOrder)

    • formatColumns

      @NotNull @ScriptApi @NotNull RollupViewBuilder formatColumns(@NotNull @NotNull Collection<String> formatCols)
      Defines a number of column-level formats which will be applied to the resultant table. The formatting is identical to that defined by Table.formatColumns(String...)
      Parameters:
      formatCols - Columnar formatting to be applied to the resultant table
      Returns:
      this RollupViewBuilder

    • formatColumns

      @NotNull @ScriptApi default @NotNull RollupViewBuilder formatColumns(@NotNull @NotNull String... formatCols)
      Defines a number of column-level formats which will be applied to the resultant table. The formatting is identical to that defined by Table.formatColumns(String...)
      Parameters:
      formatCols - Columnar formatting to be applied to the resultant table
      Returns:
      this RollupViewBuilder

    • formatColumnWhere

      @NotNull @ScriptApi @NotNull RollupViewBuilder formatColumnWhere(@NotNull @NotNull String formatCol, @NotNull @NotNull String formatCondition, @Nullable @Nullable String formatColor)
      Defines a conditional columnar format. See Table.formatColumnWhere(String, String, String)
      Parameters:
      formatCol - the columns which will have conditional formatting applied
      formatCondition - the condition used to identify if the color should be applied
      formatColor - the color to conditionally apply
      Returns:
      this RollupViewBuilder

    • collapseSideView

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

    • collapseSideView

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

    • linkTo

      @NotNull @ScriptApi @NotNull RollupViewBuilder linkTo(@NotNull @NotNull String linkTarget)
      Defines a directional link to another view-tab. By default, current "Group-By" column(s) on the current view will be used as filters on the linked view
      Parameters:
      linkTarget - a view-tab to which this table is linked
      Returns:
      this RollupViewBuilder

    • linkFilterColumn

      @NotNull @ScriptApi @NotNull RollupViewBuilder linkFilterColumn(@NotNull @NotNull Collection<String> linkColumns)
      Identifies column(s) used to filter on the linked view. When following a link from the specified column(s), then the default "Group-By" column(s) will not be used as filters on the linked view
      Parameters:
      linkColumns - a column in the existing view, which will be used as a filter on the linked view
      Returns:
      this RollupViewBuilder

    • linkFilterColumn

      @NotNull @ScriptApi default @NotNull RollupViewBuilder linkFilterColumn(@NotNull @NotNull String... linkColumns)
      Identifies column(s) used to filter on the linked view. When following a link from the specified column(s), then the default "Group-By" column(s) will not be used as filters on the linked view
      Parameters:
      linkColumns - a column in the existing view, which will be used as a filter on the linked view
      Returns:
      this RollupViewBuilder