TRUECALC
MCP

read:getCharts

Gets the charts.

Parameters

NameTypeRequiredDescription
sheetstringyesThe sheet name.

Returns

NameTypeRequiredDescription
chartsarray of { chartId: string; range: object; chartType: string; options: any }yes

Schema

Request payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Payload",
  "description": "No `commandId`/OCC field modeled.",
  "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",
  "type": "object",
  "properties": {
    "charts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ChartInfo"
      }
    }
  },
  "required": [
    "charts"
  ],
  "$defs": {
    "ChartInfo": {
      "description": "One chart's identity, placement, form, and renderer options.",
      "type": "object",
      "properties": {
        "chartId": {
          "type": "string"
        },
        "range": {
          "description": "The chart's target rectangle, A1-rendered.",
          "$ref": "#/$defs/CellRange"
        },
        "chartType": {
          "description": "Which chart form to draw, e.g. `\"column\"`, `\"box-plot\"`.",
          "type": "string"
        },
        "options": {
          "description": "Renderer-specific knobs, opaque, unvalidated by this read, matches the TS source's own `options: c.options` passthrough."
        }
      },
      "required": [
        "chartId",
        "range",
        "chartType",
        "options"
      ]
    },
    "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"
      ]
    }
  }
}

On this page