generate_sankey_chart

Visualize flow relationships in complex networks by creating a Sankey diagram. Input source, target, and value fields to display distribution and paths, with customizable themes, dimensions, and output formats.

Instructions

Generate a Sankey diagram to visualize the flow relationships between nodes in complex networks, suitable for displaying the distribution and flow paths of source and target data.

Input Schema

Name	Required	Description	Default
`background`	No	Chart background color (hex). Optional, defaults to white.
`chartTheme`	No	Chart theme. Optional, defaults to 'light'.
`colors`	No	Color palette for chart elements.
`dataTable`	Yes	Data for the Sankey diagram, e.g., [{ category: 'category 01', value: 10 }].
`height`	No	Chart height. Optional, defaults to 500.
`output`	No	Chart output type. Defaults to 'image'.	image
`sourceField`	Yes	The source field in the Sankey diagram; must exist in the data.
`subTitle`	No	Chart subtitle text.
`targetField`	Yes	The target field in the Sankey diagram; must exist in the data.
`title`	No	Chart title text.
`titleOrient`	No	Title position in the chart.
`valueField`	Yes	Measure field. Must be numeric and exist in the data.
`width`	No	Chart width. Optional, defaults to 500.

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "background": {
      "description": "Chart background color (hex). Optional, defaults to white.",
      "type": "string"
    },
    "chartTheme": {
      "description": "Chart theme. Optional, defaults to 'light'.",
      "enum": [
        "light",
        "dark"
      ],
      "type": "string"
    },
    "colors": {
      "anyOf": [
        {
          "items": {
            "description": "Color value",
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Color palette for chart elements."
    },
    "dataTable": {
      "description": "Data for the Sankey diagram, e.g., [{ category: 'category 01', value: 10 }].",
      "minItems": 1,
      "type": "array"
    },
    "height": {
      "description": "Chart height. Optional, defaults to 500.",
      "type": "number"
    },
    "output": {
      "default": "image",
      "description": "Chart output type. Defaults to 'image'.",
      "enum": [
        "spec",
        "image",
        "html"
      ],
      "type": "string"
    },
    "sourceField": {
      "description": "The source field in the Sankey diagram; must exist in the data.",
      "minLength": 1,
      "type": "string"
    },
    "subTitle": {
      "description": "Chart subtitle text.",
      "type": "string"
    },
    "targetField": {
      "description": "The target field in the Sankey diagram; must exist in the data.",
      "minLength": 1,
      "type": "string"
    },
    "title": {
      "description": "Chart title text.",
      "type": "string"
    },
    "titleOrient": {
      "description": "Title position in the chart.",
      "enum": [
        "top",
        "left",
        "right",
        "bottom"
      ],
      "type": "string"
    },
    "valueField": {
      "description": "Measure field. Must be numeric and exist in the data.",
      "minLength": 1,
      "type": "string"
    },
    "width": {
      "description": "Chart width. Optional, defaults to 500.",
      "type": "number"
    }
  },
  "required": [
    "dataTable",
    "sourceField",
    "targetField",
    "valueField"
  ],
  "type": "object"
}

vchart-mcp-server

generate_sankey_chart

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from vchart-mcp-server

Related Tools

MCP directory API