AgGrid.AgGridBuilder

public static class AgGridBuilder

Fields

isVirtualized

boolean isVirtualized

Methods

build

public AgGrid build()

Create an AgGrid definition

Returns:AgGrid instance

containedIn

public AgGridBuilder containedIn(Path container)

optional - define the container of the grid

Parameters:
  • container – the Path of the container of the grid
Returns:

AgGridBuilder

isStrict

public AgGridBuilder isStrict()

The assertions will be strict - if there are extra rows, it will fail.

Returns:AgGridBuilder

withHeaders

public AgGridBuilder withHeaders(List<String> headers)

The headers of the columns

Parameters:
  • headers –
    • the headers of the columns. In case you prefer to use a column ID, wrap it with {}. For example, “{the-id}” will refer to a header with a column ID of “the-id”. This is useful when a column has no textual header.
Returns:

AgGridBuilder

withRowsAsElementProperties

public AgGridBuilder withRowsAsElementProperties(List<Map<String, ElementProperty>> rows)

Define the rows in the table, in order.

Parameters:
  • rows –
    • A list of rows, where each row is a map of the column name(or column ID) to the property that describes the expected content. To use a column Id as a key, wrap it with curly braces.
Returns:

AgGridBuilder

withRowsAsElementPropertiesInOrder

public AgGridBuilder withRowsAsElementPropertiesInOrder(List<List<Map.Entry<String, ElementProperty>>> rows)

Define the rows in the table, in order. This version can be faster, in case the columns are ordered as they appear in the table, and the table is virtualized

Parameters:
  • rows –
    • A list of rows, where each row is a map of the column name to the property that describes the expected content
Returns:

AgGridBuilder

withRowsAsStrings

public AgGridBuilder withRowsAsStrings(List<Map<String, String>> rows)

Define the rows in the table, in order.

Parameters:
  • rows –
    • A list of rows, where each row is a map of the column name(or column ID) to the text. To use a column Id as a key, wrap it with curly braces.
Returns:

AgGridBuilder

withRowsAsStringsInOrder

public AgGridBuilder withRowsAsStringsInOrder(List<List<Map.Entry<String, String>>> rows)

Define the rows in the table, in order. This version can be faster, in case the columns

Parameters:
  • rows –
    • A list of rows, where each row is a map of the column name(or column ID) to the text. To use a column Id as a key, wrap it with curly braces.
Returns:

AgGridBuilder

withoutVirtualization

public AgGridBuilder withoutVirtualization()

without virtualization. The default is with virtualization.

Returns:AgGridBuilder