generate_heatmap_chart

Visualize intensity or density patterns between two discrete variables using a heatmap chart. Generate clear insights into association and distribution characteristics of data points with customizable dimensions, measures, and chart themes.

Instructions

Generates a heatmap chart based on a Cartesian coordinate system. It is used to visualize the intensity or density of values at the intersection of two discrete variables, suitable for revealing association patterns and distribution characteristics between variables.

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	Heatmap data array, e.g., [{ gender: 'male', age: '20-30', size: 30 }].
`height`	No	Chart height. Optional, defaults to 500.
`output`	No	Chart output type. Defaults to 'image'.	image
`sizeField`	Yes	Measure field. Must be numeric and exist in the data.
`subTitle`	No	Chart subtitle text.
`title`	No	Chart title text.
`titleOrient`	No	Title position in the chart.
`transpose`	No
`width`	No	Chart width. Optional, defaults to 500.
`xAxisHasGrid`	No	Show vertical grid lines for the X-axis.
`xAxisHasLabel`	No	Show X-axis labels.
`xAxisHasTick`	No	Show X-axis ticks.
`xAxisOrient`	No	X-axis position in the chart.
`xAxisTitle`	No	X-axis title.
`xAxisType`	No	X-axis type: categorical ('band') or continuous ('linear').
`xField`	Yes	Dimension field. Must exist in the data.
`yAxisHasGrid`	No	Show horizontal grid lines for the Y-axis.
`yAxisHasLabel`	No	Show Y-axis labels.
`yAxisHasTick`	No	Show Y-axis ticks.
`yAxisOrient`	No	Y-axis position in the chart.
`yAxisTitle`	No	Y-axis title.
`yAxisType`	No	Y-axis type: categorical ('band') or continuous ('linear').
`yField`	Yes

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": "Heatmap data array, e.g., [{ gender: 'male', age: '20-30', size: 30 }].",
      "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"
    },
    "sizeField": {
      "description": "Measure field. Must be numeric and exist in the data.",
      "minLength": 1,
      "type": "string"
    },
    "subTitle": {
      "description": "Chart subtitle text.",
      "type": "string"
    },
    "title": {
      "description": "Chart title text.",
      "type": "string"
    },
    "titleOrient": {
      "description": "Title position in the chart.",
      "enum": [
        "top",
        "left",
        "right",
        "bottom"
      ],
      "type": "string"
    },
    "transpose": {
      "type": "boolean"
    },
    "width": {
      "description": "Chart width. Optional, defaults to 500.",
      "type": "number"
    },
    "xAxisHasGrid": {
      "description": "Show vertical grid lines for the X-axis.",
      "type": "boolean"
    },
    "xAxisHasLabel": {
      "description": "Show X-axis labels.",
      "type": "boolean"
    },
    "xAxisHasTick": {
      "description": "Show X-axis ticks.",
      "type": "boolean"
    },
    "xAxisOrient": {
      "description": "X-axis position in the chart.",
      "enum": [
        "bottom",
        "top"
      ],
      "type": "string"
    },
    "xAxisTitle": {
      "description": "X-axis title.",
      "type": "string"
    },
    "xAxisType": {
      "description": "X-axis type: categorical ('band') or continuous ('linear').",
      "enum": [
        "band",
        "linear"
      ],
      "type": "string"
    },
    "xField": {
      "description": "Dimension field. Must exist in the data.",
      "minLength": 1,
      "type": "string"
    },
    "yAxisHasGrid": {
      "description": "Show horizontal grid lines for the Y-axis.",
      "type": "boolean"
    },
    "yAxisHasLabel": {
      "description": "Show Y-axis labels.",
      "type": "boolean"
    },
    "yAxisHasTick": {
      "description": "Show Y-axis ticks.",
      "type": "boolean"
    },
    "yAxisOrient": {
      "description": "Y-axis position in the chart.",
      "enum": [
        "left",
        "right"
      ],
      "type": "string"
    },
    "yAxisTitle": {
      "description": "Y-axis title.",
      "type": "string"
    },
    "yAxisType": {
      "description": "Y-axis type: categorical ('band') or continuous ('linear').",
      "enum": [
        "band",
        "linear"
      ],
      "type": "string"
    },
    "yField": {
      "$ref": "#/properties/xField"
    }
  },
  "required": [
    "dataTable",
    "xField",
    "yField",
    "sizeField"
  ],
  "type": "object"
}

vchart-mcp-server