TRUECALC
MCP

chart:update

Updates a chart.

Parameters

NameTypeRequiredDescription
chartIdstringyesThe chart to patch.
chartTypestring or nullnoThe new chart form, or omitted to leave it unchanged. Defaults to null.
optionsobject or nullnoReplaces the chart's options wholesale, or omitted to leave them unchanged. Defaults to null.

Returns

NameTypeRequiredDescription
chartIdstringyes
chartTypestringyesThe EFFECTIVE, post-patch chart form, the patch's own value if it supplied one, else the chart's unchanged existing type.

Schema

Request payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Payload",
  "type": "object",
  "properties": {
    "chartId": {
      "description": "The chart to patch.",
      "type": "string"
    },
    "chartType": {
      "description": "The new chart form, or omitted to leave it unchanged.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "options": {
      "description": "Replaces the chart's options wholesale, or omitted to leave them unchanged.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": true,
      "default": null
    }
  },
  "required": [
    "chartId"
  ]
}

Response payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Output",
  "type": "object",
  "properties": {
    "chartId": {
      "type": "string"
    },
    "chartType": {
      "description": "The EFFECTIVE, post-patch chart form, the patch's own value if it supplied one, else the chart's unchanged existing type.",
      "type": "string"
    }
  },
  "required": [
    "chartId",
    "chartType"
  ]
}

On this page