Skip to content

CellArrayLocation

type CellArrayLocation = {
bottom?: number;
dataBottom?: number;
dataRight?: number;
emptyBottom?: number;
emptyRight?: number;
left?: number;
right?: number;
sheetName?: string | null;
top?: number;
workbookName?: string | null;
};

Represents the location of a cell array within a sheet and workbook, as well as the dimensions of the array and any empty rows or columns around it.

This is used to provide additional context when reading a cell array from the model, such as when evaluating a formula that returns an array of cells.

  • emptyRight and emptyBottom indicate how many empty columns or rows are to the right or bottom of the data array.
  • dataRight and dataBottom indicate the number of columns and rows in the data array.
  • top, left, bottom, and right indicate the overall bounds of the cell array, including any empty rows or columns.
  • sheetName and workbookName provide context about where the cell array is located within the model.
PropertyType
bottom?number
dataBottom?number
dataRight?number
emptyBottom?number
emptyRight?number
left?number
right?number
sheetName?string | null
top?number
workbookName?string | null