Class TableFactory

Static method that helps to build a table model object. It takes in tabular data and options and constructs a suitable model for rendering as a table. This method is capable of handling both 'Flat' and 'Tree' data structures.

Typeparam

T - The type of the data in the rows.

Usage Notes

Here is an example of using this static method to build a table model:

const tableModel = TableFactory.buildByTypedRows<User>(users, [{ property: 'name', headerLabel: 'Name' }, { property: 'email', headerLabel: 'Email' }]);
Copy

This will build a table with two columns 'Name' and 'Email', each row representing a 'User' object from the 'users' array.

Warning: This function assumes that the first columnDef provided represents a checkbox column if the property of the first columnDef is "CheckboxColumn". If the first column is not a checkbox column, ensure that the first columnDef does not have "CheckboxColumn" as its property.

Constructs a table model (an instance of TableModelIf) by using provided parameters.

Static

Method

This public static factory method creates a TableModel instance using the provided parameters. Each parameter has a default value allowing for great flexibility in creating table models. The main parameters are the AreaModel instances for different table sections:

TableFactory.createByAreaModelsParam is a static method in the TableFactory class that creates a table model by area models and other optional parameters. This method allows more flexibility and control over table building by providing the option to decide the visibility and nature of the header, body, footer, columns, and rows in the table.

Example

const tableModel = TableFactory.createByAreaModelsParam({
   headerAreaModel: myHeaderModel,
   bodyAreaModel: myBodyModel,
   footerAreaModel: myFooterModel,
   fixedLeftColumnCount: 2,
   fixedRightColumnCount: 1,
   rowCheckboxVisible: true,
   defaultRowHeights: myDefaultHeights,
   columnDefs: myColumnDefs,
   columnSizes: [100, 100, 200],
   overridingColumnWidth: 150,
   columnCount: 3
});
Copy

Class method createByObjectArray of the TableFactory class.

This public, static method is intended to create a table model by an array of objects. This method is particularly useful when you are aiming to build a table from a set of data rows, header and footer information. The table can include both fixed and flexible columns and optional checkboxes for each row. The table layout can further be customized using the default row heights, column definitions, and column sizes parameters.

Generic

T - The generic type parameter for data rows.

Example

const rows = [{ field1: "data11", field2: "data12" }, { field1: "data21", field2: "data22" }];
const columnDefs: ColumnDefIf[] = [new ColumnDef("field1", "Field 1"), new ColumnDef("field2", "Field 2")];
const tableModel = TableFactory.createByObjectArray(rows, undefined, undefined, 0, 0, false, new DefaultRowHeights(), columnDefs);
Copy

The createByObjectArrayParam static method is used to create a TableFactory object with the data contained in the param object. This method would call the createByObjectArray static method, which actually constructs the TableModel object with the provided data.

Example

let param = {
  rows: [{name: 'John', age: 30}, {name: 'Doe', age: 40}],
  header: [['Name', 'Age']],
  footer: [['Avg', '35']],
  fixedLeftColumnCount: 1,
  fixedRightColumnCount: 0,
  rowCheckboxVisible: true,
  defaultRowHeights: new DefaultRowHeights(40, 50, 40),
  columnDefs: [
    new ColumnDef('name', 'Name', px100),
    new ColumnDef('age', 'Age', px50)
  ],
  columnSizes: [100, 50]
};
const tableModel = TableFactory.createByObjectArrayParam(param);
Copy

Creates a table model from any subset of CreateTableModelPara. Missing parts are derived (see CreateTableModelPara).

Example

const tableModel = TableFactory.createTableModel({
  rows: orders,
  columnDefs,
  fixedLeftColumnCount: 1,
  footerAreaModel: new OrderTotalsFooterModel(() => tableModel.getBodyModel())
});
Copy