Skip to main content

GetIndex

Returns the 1-based index of the row within the data body of the table.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.GetIndex();

expression - A variable that represents a ApiListRow class.

Parameters​

This method doesn't have any parameters.

Returns​

number

Example​

Find the position number of a row within a table in a spreadsheet.

// How do I check which row number a particular row occupies inside a table in a spreadsheet?

// Read the row's index to know its place in the data body, counted from the first data row in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Product");
worksheet.GetRange("B1").SetValue("Price");
worksheet.GetRange("A2").SetValue("Apples");
worksheet.GetRange("B2").SetValue(100);
worksheet.GetRange("A3").SetValue("Oranges");
worksheet.GetRange("B3").SetValue(150);
let table = worksheet.AddListObject("xlSrcRange", "A1:B3");

let row = table.GetListRows()[1];

worksheet.GetRange("D1").SetValue("Row index:");
worksheet.GetRange("E1").SetValue(row.GetIndex());