TRUECALC
MCP

format:setNumberFormat

Sets the number format.

Parameters

NameTypeRequiredDescription
sheetstringyesThe sheet name.
range{ from: string; to: string }yesThe target range, e.g. {"from": "A1", "to": "B3"}. May legitimately arrive "backwards", from below/right of to, normalized before use.
value"number", "percent", "currency", "date", "datetime" or nullno

Returns

Nothing beyond the standard MCP success envelope.

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"
    },
    "range": {
      "description": "The target range, e.g. `{\"from\": \"A1\", \"to\": \"B3\"}`. May legitimately arrive \"backwards\", `from` below/right of `to`, normalized before use.",
      "$ref": "#/$defs/CellRange"
    },
    "value": {
      "anyOf": [
        {
          "$ref": "#/$defs/NumberFormat"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "sheet",
    "range"
  ],
  "$defs": {
    "CellRange": {
      "description": "An inclusive rectangle. `from`/`to` may be equal, a single cell.",
      "type": "object",
      "properties": {
        "from": {
          "description": "Top-left cell, e.g. `\"A1\"`.",
          "type": "string"
        },
        "to": {
          "description": "Bottom-right cell, e.g. `\"B3\"`.",
          "type": "string"
        }
      },
      "required": [
        "from",
        "to"
      ]
    },
    "NumberFormat": {
      "description": "A number-display category, studio#10.",
      "oneOf": [
        {
          "description": "Grouped fixed-point: `1,234.57`.",
          "type": "string",
          "const": "number"
        },
        {
          "description": "The value times 100, with a `%` suffix.",
          "type": "string",
          "const": "percent"
        },
        {
          "description": "Grouped fixed-point with a currency symbol.",
          "type": "string",
          "const": "currency"
        },
        {
          "description": "The value read as a date serial. **Implies date typing**.",
          "type": "string",
          "const": "date"
        },
        {
          "description": "The value read as a date-time serial.",
          "type": "string",
          "const": "datetime"
        }
      ]
    }
  }
}

On this page