TRUECALC
MCP

read:getExtent

Gets the extent.

Parameters

NameTypeRequiredDescription
sheetstringyesThe sheet name.

Returns

NameTypeRequiredDescription
rowsintegeryesThe highest populated row, 1-based, or 0 if the sheet is empty.
colsintegeryesThe highest populated column, 1-based, or 0 if the sheet is empty.

Schema

Request payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Payload",
  "type": "object",
  "properties": {
    "sheet": {
      "description": "The sheet name.",
      "type": "string"
    }
  },
  "required": [
    "sheet"
  ]
}

Response payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Output",
  "description": "The USED extent, not a capacity.",
  "type": "object",
  "properties": {
    "rows": {
      "description": "The highest populated row, 1-based, or `0` if the sheet is empty.",
      "type": "integer",
      "format": "uint32",
      "minimum": 0
    },
    "cols": {
      "description": "The highest populated column, 1-based, or `0` if the sheet is empty.",
      "type": "integer",
      "format": "uint32",
      "minimum": 0
    }
  },
  "required": [
    "rows",
    "cols"
  ]
}

On this page