ListObjectCollection

ListObjectCollection class

Represents a collection of ListObject objects in the worksheet.

class ListObjectCollection implements Iterable<ListObject>;

Method	Description
get(number)	Gets the ListObject by index.
get(string)	Gets the ListObject by specified name.
add(number, number, number, number, boolean)	Adds a ListObject to the worksheet.
add(string, string, boolean)	Adds a ListObject to the worksheet.
removeAt(number)	Remove ListObject by index.
updateColumnName()	Update all column name of the tables.
getCount()	@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
isNull()	Checks whether the implementation object is null.

Returns an iterator over the items in the collection. Enables use of for...of, spread syntax, and Array.from().

Gets the ListObject by index.

get(index: number) : ListObject;

Parameters:

Parameter	Type	Description
index	number	The index.

Returns

The ListObject

Gets the ListObject by specified name.

get(tableName: string) : ListObject;

Parameters:

Parameter	Type	Description
tableName	string	ListObject name.

Returns

The ListObject

Adds a ListObject to the worksheet.

add(startRow: number, startColumn: number, endRow: number, endColumn: number, hasHeaders: boolean) : number;

Parameters:

Parameter	Type	Description
startRow	number	The start row of the list range.
startColumn	number	The start row of the list range.
endRow	number	The start row of the list range.
endColumn	number	The start row of the list range.
hasHeaders	boolean	Whether the range has headers.

Returns

The index of the new ListObject

Adds a ListObject to the worksheet.

add(startCell: string, endCell: string, hasHeaders: boolean) : number;

Parameters:

Parameter	Type	Description
startCell	string	The start cell of the list range.
endCell	string	The end cell of the list range.
hasHeaders	boolean	Whether the range has headers.

Returns

The index of the new ListObject

Remove ListObject by index.

removeAt(index: number) : void;

Parameters:

Parameter	Type	Description
index	number	The index.

Update all column name of the tables.

updateColumnName() : void;

@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.

getCount() : number;

Checks whether the implementation object is null.

isNull() : boolean;