Table

// How to add a column at an index 3
table.addColumn({text: "Customer Name", header_align:"center"}, 3);

table.addRow(["John Dow", 45, true, "Charlotte, NC", "[View|Remove]"]);

// disables resizing of other columns when one column is resized
table.autoResizeColumns(Table.AutoResize.None);

// last column will be resize to accommodate room for a column being resized
table.autoResizeColumns(Table.AutoResize.LastColumn);

// Using case insensitive regular expression
table.filter(`column(1) regex "(?i)^Jim.*"`);

// Filtering by numeric value
table.filter("column(1) < 50");

// Filtering by date
table.filter(`column(3) > "2023-04-01 00:00:00" && column(3) < "2024-05-30 00:00:00"`);

// Filtering by a boolean for checkbox
table.filter("column(4) != false");

// Set the grid line color
table.gridColor("#000000");

// Get the current grid line color
alert(table.gridColor());

// Example event object:
const e = {
  target: Table,       // The Table component that triggered the event.
  type: string,        // "insert", "remove", "move", "resize".
  index: number        // Only when type is "insert", "remove", or "resize". Index of the column.
  fromIndex: number,   // Only when type is "move". Indicates the previous index of the column.
  toIndex: number,     // Only when type is "move". Indicates the new index of the column.
  fromSize: number,    // Only when type is "resize". Indicates the previous size of the column.
  toSize: number,      // Only when type is "resize". Indicates the new size of the column.
  interactive: boolean // `true` when column was moved by the user interacting with the GUI. `false` when it was made programmatically.
};

// Example event object:
const e = {
  target: object,        // The Table component that triggered the event.
  type: string,          // "insert", "remove", "update".
  row: number,           // Only when one row was effected. Index of the row.
  column: number         // Only when type is "update". Column index of effected cell. Value of -1 means that all columns were effected.
  fromRow: number        // Only when multiple rows were effected. Indicates beginning index within the range of effected rows.
  toRow: number          // Only when multiple rows were effected. Indicates the last index within the range of effected rows.
  interactive: boolean   // Only when type is "update". `true` when update was made by the user interacting with the GUI. `false` when update was made programmatically.
};

// Example event object:
const e = {
  target: Table,         // The Table component that triggered the event.
  type: Table.SortOrder, // Table.SortOrder.None, Table.SortOrder.Ascending, or Table.SortOrder.Descending.
  column: number         // Only when type is not Table.SortOrder.None. Column index.
  newOrderColumn: number // Only when type is not Table.SortOrder.None. New column index, taking into account that columns may be re-ordered.
  interactive: boolean   // `true` when sorting was made by the user interacting with the GUI. `false` when it was made programmatically.
};

// To update values of an existing row at index 5
table.row(5, false, ["Jane Dow", 40, false, "Charlotte, NC", "[View|Remove]"]);

// To get height of all rows
let h = table.rowSize();

// To get a height of a specific row at index 5
let h = table.rowSize(undefined, 5);

// To set height to all rows
table.rowSize(40);

// To set height to row at index 5
table.rowSize(40, 5);

// To reset height of all rows to default height
table.rowSize(null);

// To reset height of row at index 5 to default height
table.rowSize(null, 5);

// how to set style for a row index 5
table.rowStyle(5, false, {background:"#FF0000", color:"#FFAAAA", size: 40}});

// how to reset one style a row at index 5
table.rowStyle(5, false, {color:"#FFAAAA"}});

// how to remove all styles from a row at index 5
table.rowStyle(5, false, null});

// How to get style of a row at index 5
let style = table.rowStyle(5);
console.log(style);

// Example of clearing current selection
table.selection(null);

// Examples of setting selection using a single index:
table.selection(5) - Selects a single row.
table.selection(5, true) - Selects a single row based on new sort order.
table.selection(5, false, true) - Selects an additional single row (if it wasn't selected yet) based on original order.

// Examples of selecting a range of rows using an index range object:
table.selection({from:5, to:9}) - Selects only a range of rows from index 5 to 9 (Only possible when selection mode is set to SelectionMode.Range or SelectionMode.Multiple).
table.selection({from:5, to:9}, true) - Selects only a range of rows from index 5 to 9 based on new sort order (Only possible when selection mode is set to SelectionMode.Range or SelectionMode.Multiple).
table.selection({from:5, to:9}, true, true) - Selects a range of rows from index 5 to 9 based on new sort order in addition to previously selected rows (Only possible when selection mode is set to SelectionMode.Range or SelectionMode.Multiple).

// Examples of selecting/deselecting multiple rows using an array of indexes:
table.selection([6, 7, 4, 1]) - Selects only indexes specified in the array (Multiple intervals (ranges) are only possible when selection mode is set to SelectionMode.Multiple).
table.selection([6, 7, 4, 1], true) - Selects only indexes specified in the array  based on new sort order (Multiple intervals (ranges) are only possible when selection mode is set to SelectionMode.Multiple).
table.selection([6, 7], true, false) - Deselects rows at indexes specified in the array based on new sort order from previously selected rows.

<h2>Setting a sort column and order:</h2>
// Sorts rows by column 2 in descending order
table.sortOrder(2, false, Table.SortOrder.Descending);

// Resets sorting by column 2 while still sorting by previously sorted columns (if any)
table.sortOrder(2, false, Table.SortOrder.None);

// Resets row sorting for all columns. Rows become unsorted.
table.sortOrder(null);

<h2>Getting current sort state:</h2>
let sorting = table.sortOrder();
// returns `null` if there was no sorting applied to the table
// or object like {column: 2, order: Table.SortOrder.Descending} if column 2 is currently sorted.
// Returned `column` index is the original column index (remain same even after after columns were reordered).