Skip to content

Latest commit

 

History

History
154 lines (116 loc) · 3.99 KB

tablecolumncollection.md

File metadata and controls

154 lines (116 loc) · 3.99 KB
Raw

TableColumnCollection

Represents a collection of all the columns that are part of the table.

Properties

Property Type Description
count int Returns the number of columns in the table. Read-only.
items TableColumn[] A collection of tableColumn objects. Read-only.

Relationships

None

Methods

Method Return Type Description
add(index: number, values: object[][]) TableColumn Adds a new column to the table.
getItem(id: object) TableColumn Gets a column object by Name or ID.
getItemAt(index: number) TableColumn Gets a column based on its position in the collection.
load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

API Specification

add(index: number, values: object[][])

Adds a new column to the table.

Syntax

tableColumnCollectionObject.add(index, values);

Parameters

Parameter Type Description
index number Specifies the relative position of the new column. The previous column at this position is shifted to the right. The index value should be equal to or less than the last column's index value, so it cannot be used to append a column at the end of the table. Zero-indexed.
values object[][] Optional. A 2-dimensional array of unformatted values of the table column.

Returns

TableColumn

Examples

var ctx = new Excel.RequestContext();
var tables = ctx.workbook.tables;
var values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
var column = tables.getItem("Table1").columns.add(null, values);
ctx.load(column);
ctx.executeAsync().then(function () {
	Console.log(column.name);
});

Back

getItem(id: object)

Gets a column object by Name or ID.

Syntax

tableColumnCollectionObject.getItem(id);

Parameters

Parameter Type Description
id object Column Name or ID.

Returns

TableColumn

Examples

var ctx = new Excel.RequestContext();
var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItem(0);
ctx.load(tablecolumn)
ctx.executeAsync().then(function () {
		Console.log(tablecolumn.name);
});

Back

getItemAt(index: number)

Gets a column based on its position in the collection.

Syntax

tableColumnCollectionObject.getItemAt(index);

Parameters

Parameter Type Description
index number Index value of the object to be retrieved. Zero-indexed.

Returns

TableColumn

Examples

var ctx = new Excel.RequestContext();
var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0);
ctx.load(tablecolumn)
ctx.executeAsync().then(function () {
		Console.log(tablecolumn.name);
});

Back

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void

Examples



Back


Getter Examples


var ctx = new Excel.RequestContext();
var tablecolumns = ctx.workbook.tables.getItem['Table1'].columns;
ctx.load(tablecolumns);
ctx.executeAsync().then(function () {
	Console.log("tablecolumns Count: " + tablecolumns.count);
	for (var i = 0; i < tablecolumns.items.length; i++)
	{
		Console.log(tablecolumns.items[i].name);
	}
});


Back