Skip to content

Grid

With the 'Grid' section you will be able to register all information needed to render the grid-component. Also the grid section properties are used to build a custom-made OData query at UiStructure service which will be used to retrieve data from backend OData controllers.

Fields

A grid contains the following fields to be defined:

Fields

The list of the properties from UiStructure entity which will be displayed in grid.

Requirements Rules:

  • Is Required;
  • Each item must follows rules as specified in Grid-Field

Example:

1
2
3
4
Grid:
  Fields:
  - Property: My_Property_1
    ...


QueryOrderFields

The list of the properties from UiStructure entity which will be used to sort source for grid.

Requirements Rules:

Example:

1
2
3
4
5
6
7
Grid:
  Fields:
  - Property: My_Property_1
    ...
  QueryOrderFields:
  - Property: My_Property_1
    ...


QueryRegistersLimit

The limit of registers that should be retrieved for grid. Defaults to '100' if not informed.

Note

This value will be rendered at OData query method to limit the number of registers. Keep in mind that an accurate value, that fit your users needs, will always be the best option.

Requirements Rules:

  • Any value between 1 and 100

Example:

1
2
3
4
5
6
7
8
Grid:
  Fields:
  - Property: My_Property_1
    ...
  QueryOrderFields:
  - Property: My_Property_1
    ...
  QueryRegistersLimit: 50


PageSizes

The options that should be included at grid-component page-sizes, these options allows the user to choose the amount of registers he would like to see at each grid page. Defaults to '10, 20, 30' if not informed.

Requirements Rules:

  • Each value must be between 1 and 100

Example:

1
2
3
4
5
6
7
8
9
Grid:
  Fields:
  - Property: My_Property_1
    ...
  QueryOrderFields:
  - Property: My_Property_1
    ...
  QueryRegistersLimit: 50
  PageSizes: [10, 30, 60] # With these options the user can choose to view a grid-page with 10 registers or 30 registers or 60 registers.


Back to top