Package io.deephaven.multiviewwidget.builder

Interface LeafViewBuilder

All Superinterfaces:

ViewFactory

All Known Implementing Classes:

LeafViewBuilderImpl

public interface LeafViewBuilder
extends ViewFactory

A builder to define a Leaf View. See ViewFactory.addLeafView(String, Table).

Method Summary

Modifier and Type	Method	Description
default @NotNull LeafViewBuilder	leafColumnOrder(@NotNull String... leafFrontCols)	Identifies columns which should be displayed toward the beginning of the resultant columns
@NotNull LeafViewBuilder	leafColumnOrder(@NotNull Collection<String> leafFrontCols)	Identifies columns which should be displayed toward the beginning of the resultant columns
default @NotNull LeafViewBuilder	leafFormatColumns(@NotNull String... leafFormats)	Defines a number of column-level formats which will be applied to the resultant table.
@NotNull LeafViewBuilder	leafFormatColumns(@NotNull Collection<String> leafFormats)	Defines a number of column-level formats which will be applied to the resultant table.
@NotNull LeafViewBuilder	leafFormatColumnWhere(@NotNull String leafFormatCol, @NotNull String leafFormatCondition, @NotNull String leafFormatColor)	Defines a conditional columnar format.
default @NotNull LeafViewBuilder	leafSortAscending(@NotNull String... leafSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull LeafViewBuilder	leafSortAscending(@NotNull Collection<String> leafSortCols)	Identifies columns used for sort-ordering of the resultant table
default @NotNull LeafViewBuilder	leafSortDescending(@NotNull String... leafSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull LeafViewBuilder	leafSortDescending(@NotNull Collection<String> leafSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull LeafViewBuilder	withTotals(boolean includeTotals)	Identifies if the view should include a totals row.

Methods inherited from interface io.deephaven.multiviewwidget.builder.ViewFactory

addAggView, addAggView, addGlobalFilter, addGlobalFilter, addLeafView, addLeafView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPlotView, addPlotView, addPlotView, addPlotView, addRollupView, addRollupView, addStaticFilter, build, collapseGlobalFilter, collapseGlobalFilter, getBuilder, globalFilterBucket, globalFilterBucket

Method Details

withTotals

@NotNull
@ScriptApi
@NotNull LeafViewBuilder withTotals(boolean includeTotals)

Identifies if the view should include a totals row. This is 'true' by default.

Parameters:

includeTotals - if the view should include totals.

Returns:

this PivotViewBuilder

leafColumnOrder

@NotNull
@ScriptApi
@NotNull LeafViewBuilder leafColumnOrder(@NotNull
 @NotNull Collection<String> leafFrontCols)

Identifies columns which should be displayed toward the beginning of the resultant columns

Parameters:

leafFrontCols - column name(s) which should be shown near the beginning of the resultant columns

Returns:

this LeafViewBuilder

leafColumnOrder

@NotNull
@ScriptApi
default @NotNull LeafViewBuilder leafColumnOrder(@NotNull
 @NotNull String... leafFrontCols)

Identifies columns which should be displayed toward the beginning of the resultant columns

Parameters:

leafFrontCols - column name(s) which should be shown near the beginning of the resultant columns

Returns:

this LeafViewBuilder

leafSortAscending

@NotNull
@ScriptApi
@NotNull LeafViewBuilder leafSortAscending(@NotNull
 @NotNull Collection<String> leafSortCols)

Identifies columns used for sort-ordering of the resultant table

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafSortAscending

@NotNull
@ScriptApi
default @NotNull LeafViewBuilder leafSortAscending(@NotNull
 @NotNull String... leafSortCols)

Identifies columns used for sort-ordering of the resultant table

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafSortDescending

@NotNull
@ScriptApi
@NotNull LeafViewBuilder leafSortDescending(@NotNull
 @NotNull Collection<String> leafSortCols)

Identifies columns used for sort-ordering of the resultant table

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafSortDescending

@NotNull
@ScriptApi
default @NotNull LeafViewBuilder leafSortDescending(@NotNull
 @NotNull String... leafSortCols)

Identifies columns used for sort-ordering of the resultant table

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafFormatColumns

@NotNull
@ScriptApi
@NotNull LeafViewBuilder leafFormatColumns(@NotNull
 @NotNull Collection<String> leafFormats)

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:

leafFormats - Columnar formatting to be applied to the resultant table

Returns:

this LeafViewBuilder

leafFormatColumns

@NotNull
@ScriptApi
default @NotNull LeafViewBuilder leafFormatColumns(@NotNull
 @NotNull String... leafFormats)

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:

leafFormats - Columnar formatting to be applied to the resultant table

Returns:

this LeafViewBuilder

leafFormatColumnWhere

@NotNull
@ScriptApi
@NotNull LeafViewBuilder leafFormatColumnWhere(@NotNull
 @NotNull String leafFormatCol,
 @NotNull
 @NotNull String leafFormatCondition,
 @NotNull
 @NotNull String leafFormatColor)

Defines a conditional columnar format. See Table.formatColumnWhere(String, String, String)

Parameters:

leafFormatCol - the columns which will have conditional formatting applied

leafFormatCondition - the condition used to identify if the color should be applied

leafFormatColor - the color to conditionally apply

Returns:

this LeafViewBuilder