ListObject
ListObject class
Represents a table in a worksheet.
class ListObject;
Example
const { Workbook, CellsHelper, TotalsCalculation, SaveFormat } = AsposeCells;
var workbook = new Workbook();
var cells = workbook.worksheets.get(0).cells;
for (var i = 0; i < 5; i++) {
cells.get(0, i).putValue(CellsHelper.columnIndexToName(i));
}
for (var row = 1; row < 10; row++) {
for (var column = 0; column < 5; column++) {
cells.get(row, column).putValue(row * column);
}
}
var tables = workbook.worksheets.get(0).getListObjects();
var index = tables.add(0, 0, 9, 4, true);
var table = tables.get(0);
table.showTotals = true;
table.listColumns.get(4).totalsCalculation = TotalsCalculation.Sum;
var uint8Array = workbook.save(SaveFormat.Xlsx);
Properties
| Property | Type | Description |
|---|---|---|
| startRow | number | Readonly. Gets the start row of the range. |
| startColumn | number | Readonly. Gets the start column of the range. |
| endRow | number | Readonly. Gets the end row of the range. |
| endColumn | number | Readonly. Gets the end column of the range. |
| listColumns | ListColumnCollection | Readonly. Gets the ListColumn list of this table. |
| showHeaderRow | boolean | Gets and sets whether this Table shows header row. |
| showTotals | boolean | Gets and sets whether this TAble shows total row. |
| dataRange | Range | Readonly. Gets the data range of the Table. |
| queryTable | QueryTable | Readonly. Gets the linked QueryTable. |
| dataSourceType | TableDataSourceType | Readonly. Gets the data source type of the table. |
| hasAutoFilter | boolean | Indicates whether auto filter is applied to this table. |
| autoFilter | AutoFilter | Readonly. Gets auto filter of this table. |
| displayName | string | Gets and sets the display name of the table. |
| comment | string | Gets and sets the comment of the table. |
| showTableStyleFirstColumn | boolean | Indicates whether the first column in the table is the style applied to. |
| showTableStyleLastColumn | boolean | Indicates whether the last column in the table is the style applied to. |
| showTableStyleRowStripes | boolean | Indicates whether row stripe formatting is applied to. |
| showTableStyleColumnStripes | boolean | Indicates whether column stripe formatting is applied to. |
| tableStyleType | TableStyleType | Gets and the built-in table style. |
| tableStyleName | string | Gets and sets the table style name. |
| xmlMap | XmlMap | Readonly. Gets an XmlMap used for this list. |
| alternativeText | string | Gets and sets the alternative text. |
| alternativeDescription | string | Gets and sets the alternative description. |
Methods
| Method | Description |
|---|---|
| resize(number, number, number, number, boolean) | Resize the range of the list object. |
| putCellValue(number, number, VObject) | Put the value to the cell. |
| putCellValue(number, number, VObject, boolean) | Put the value to the cell. |
| putCellFormula(number, number, string) | Put the formula to the cell in the table. |
| putCellFormula(number, number, string, boolean) | Put the formula to the cell in the table. |
| updateColumnName() | Updates all list columns’ name to cells in the table. |
| removeAutoFilter() | Removes auto filter which is applied to this table. |
| filter() | Filter the table. |
| applyStyleToRange() | Apply the table style to the range. |
| convertToRange() | Convert the table to range. |
| convertToRange(TableToRangeOptions) | Convert the table to range. |
startRow
Readonly. Gets the start row of the range.
startRow : number;
startColumn
Readonly. Gets the start column of the range.
startColumn : number;
endRow
Readonly. Gets the end row of the range.
endRow : number;
endColumn
Readonly. Gets the end column of the range.
endColumn : number;
listColumns
Readonly. Gets the ListColumn list of this table.
listColumns : ListColumnCollection;
showHeaderRow
Gets and sets whether this Table shows header row.
showHeaderRow : boolean;
showTotals
Gets and sets whether this TAble shows total row.
showTotals : boolean;
dataRange
Readonly. Gets the data range of the Table.
dataRange : Range;
queryTable
Readonly. Gets the linked QueryTable.
queryTable : QueryTable;
dataSourceType
Readonly. Gets the data source type of the table.
dataSourceType : TableDataSourceType;
hasAutoFilter
Indicates whether auto filter is applied to this table.
hasAutoFilter : boolean;
autoFilter
Readonly. Gets auto filter of this table.
autoFilter : AutoFilter;
Remarks
It works only when HasAutoFilter is false.
displayName
Gets and sets the display name of the table.
displayName : string;
comment
Gets and sets the comment of the table.
comment : string;
showTableStyleFirstColumn
Indicates whether the first column in the table is the style applied to.
showTableStyleFirstColumn : boolean;
showTableStyleLastColumn
Indicates whether the last column in the table is the style applied to.
showTableStyleLastColumn : boolean;
showTableStyleRowStripes
Indicates whether row stripe formatting is applied to.
showTableStyleRowStripes : boolean;
showTableStyleColumnStripes
Indicates whether column stripe formatting is applied to.
showTableStyleColumnStripes : boolean;
tableStyleType
Gets and the built-in table style.
tableStyleType : TableStyleType;
tableStyleName
Gets and sets the table style name.
tableStyleName : string;
xmlMap
Readonly. Gets an XmlMap used for this list.
xmlMap : XmlMap;
alternativeText
Gets and sets the alternative text.
alternativeText : string;
alternativeDescription
Gets and sets the alternative description.
alternativeDescription : string;
resize(number, number, number, number, boolean)
Resize the range of the list object.
resize(startRow: number, startColumn: number, endRow: number, endColumn: number, hasHeaders: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | number | The start row index of the new range. |
| startColumn | number | The start column index of the new range. |
| endRow | number | The end row index of the new range. |
| endColumn | number | The end column index of the new range. |
| hasHeaders | boolean | Whether this table has headers. |
putCellValue(number, number, VObject)
Put the value to the cell.
putCellValue(rowOffset: number, columnOffset: number, value: VObject) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | number | The row offset in the table. |
| columnOffset | number | The column offset in the table. |
| value | VObject | The cell value. |
putCellValue(number, number, VObject, boolean)
Put the value to the cell.
putCellValue(rowOffset: number, columnOffset: number, value: VObject, isTotalsRowLabel: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | number | The row offset in the table. |
| columnOffset | number | The column offset in the table. |
| value | VObject | The cell value. |
| isTotalsRowLabel | boolean | Indicates whether it is a label for total row,only works for total row. /// If False and this row is total row, a new row will be inserted. |
putCellFormula(number, number, string)
Put the formula to the cell in the table.
putCellFormula(rowOffset: number, columnOffset: number, formula: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | number | The row offset in the table. |
| columnOffset | number | The column offset in the table. |
| formula | string | The formula of the cell. |
putCellFormula(number, number, string, boolean)
Put the formula to the cell in the table.
putCellFormula(rowOffset: number, columnOffset: number, formula: string, isTotalsRowFormula: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | number | The row offset in the table. |
| columnOffset | number | The column offset in the table. |
| formula | string | The formula of the cell. |
| isTotalsRowFormula | boolean |
updateColumnName()
Updates all list columns’ name to cells in the table.
updateColumnName() : void;
Remarks
The value of the cells in the header row of the table must be same as the name of the ListColumn; Cell.PutValue do not auto modify the name of the ListColumn for performance.
removeAutoFilter()
Removes auto filter which is applied to this table.
removeAutoFilter() : void;
filter()
Filter the table.
filter() : AutoFilter;
Returns
Remarks
NOTE: This member is now obsolete. Instead,please set ListObject.HasAutoFilter property. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
applyStyleToRange()
Apply the table style to the range.
applyStyleToRange() : void;
convertToRange()
Convert the table to range.
convertToRange() : void;
convertToRange(TableToRangeOptions)
Convert the table to range.
convertToRange(options: TableToRangeOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | TableToRangeOptions | the options when converting table to range. |