TableRow Object (JavaScript API for Excel)
Represents a row in a table.
Properties
| Property | Type | Description | Req. Set |
|---|---|---|---|
| index | int | Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. | 1.1 |
| values | object[][] | Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. | 1.1 |
See property access examples.
Relationships
None
Methods
| Method | Return Type | Description | Req. Set |
|---|---|---|---|
| delete() | void | Deletes the row from the table. | 1.1 |
| getRange() | Range | Returns the range object associated with the entire row. | 1.1 |
Method Details
delete()
Deletes the row from the table.
Syntax
tableRowObject.delete();
Parameters
None
Returns
void
Examples
Excel.run(function (ctx) {
var tableName = 'Table1';
var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2);
row.delete();
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
getRange()
Returns the range object associated with the entire row.
Syntax
tableRowObject.getRange();
Parameters
None
Returns
Examples
Excel.run(function (ctx) {
var tableName = 'Table1';
var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(0);
var rowRange = row.getRange();
rowRange.load('address');
return ctx.sync().then(function() {
console.log(rowRange.address);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Property access examples
Excel.run(function (ctx) {
var tableName = 'Table1';
var row = ctx.workbook.tables.getItem(tableName).rows.getItem(0);
row.load('index');
return ctx.sync().then(function() {
console.log(row.index);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Excel.run(function (ctx) {
var tables = ctx.workbook.tables;
var newValues = [["New", "Values", "For", "New", "Row"]];
var tableName = 'Table1';
var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2);
row.values = newValues;
row.load('values');
return ctx.sync().then(function() {
console.log(row.values);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});