addChart

This function creates a chart of the specified type from the given range or the selected range.

Prompts

• Create a bar chart from the current selection
• Create a normal line chart from the current selection
• Create a pie chart from range A1:B10
• Create a chart with title "Sales Overview"

Function registration

let func = new RegisteredFunction({
  name: "addChart",
  description:
    "Creates charts from data ranges to visualize data. Supports multiple chart types including bar charts, line charts, pie charts, scatter plots, and area charts. Each chart type has variants like stacked, 3D, and percentage views. Charts are automatically positioned below the source data range with configurable dimensions. Optional chart titles can be added for better context.",
  parameters: {
    type: "object",
    properties: {
      range: {
        type: "string",
        description:
          "Cell range with data for chart (e.g., 'A1:D10'). If omitted, uses current selection.",
      },
      chartType: {
        type: "string",
        description: "Type of chart to create.",
        enum: [
          "bar",
          "barStacked",
          "barStackedPercent",
          "bar3D",
          "barStacked3D",
          "barStackedPercent3D",
          "barStackedPercent3DPerspective",
          "horizontalBar",
          "horizontalBarStacked",
          "horizontalBarStackedPercent",
          "horizontalBar3D",
          "horizontalBarStacked3D",
          "horizontalBarStackedPercent3D",
          "lineNormal",
          "lineStacked",
          "lineStackedPercent",
          "line3D",
          "pie",
          "pie3D",
          "doughnut",
          "scatter",
          "stock",
          "area",
          "areaStacked",
          "areaStackedPercent",
        ],
        default: "bar",
      },
      title: {
        type: "string",
        description: "Chart title text.",
      },
    },
    required: [],
  },
  examples: [
    {
      prompt: "Create a bar chart from current selection",
      arguments: {},
    },
    {
      prompt: "Create a line chart from current selection",
      arguments: { chartType: "lineNormal" },
    },
    {
      prompt: "Create a pie chart from specific range",
      arguments: { range: "A1:B10", chartType: "pie" },
    },
    {
      prompt: "Create a chart with title",
      arguments: { title: "Sales Overview" },
    },
  ],
});

Parameters

Name	Type	Example	Description
range	string	"A1:D10"	The cell range containing the data for the chart. If omitted, the selected range is used.
chartType	string	"bar3D"	The chart type can be "bar", "barStacked", "barStackedPercent", "bar3D", "barStacked3D", "barStackedPercent3D", "barStackedPercent3DPerspective", "horizontalBar", "horizontalBarStacked", "horizontalBarStackedPercent", "horizontalBar3D", "horizontalBarStacked3D", "horizontalBarStackedPercent3D", "lineNormal", "lineStacked", "lineStackedPercent", "line3D", "pie", "pie3D", "doughnut", "scatter", "stock", "area", "areaStacked", "areaStackedPercent". The default value is "bar".
title	string	"Sales Overview"	The chart title.

Function execution

func.call = async function (params) {
  Asc.scope.range = params.range;
  Asc.scope.chartType = params.chartType || "bar";
  Asc.scope.title = params.title;

  await Asc.Editor.callCommand(function () {
    let ws = Api.GetActiveSheet();
    let chartRange;

    if (Asc.scope.range) {
      chartRange = Asc.scope.range;
    } else {
      let selection = Api.GetSelection();
      chartRange = selection.GetAddress(true, true, "xlA1", false);
    }

    let range = ws.GetRange(chartRange);
    let fromRow = range.GetRow() + 3;
    let fromCol = range.GetCol();

    let widthEMU = 130 * 36000;
    let heightEMU = 80 * 36000;

    let chart = ws.AddChart(
      chartRange,
      true,
      Asc.scope.chartType,
      2,
      widthEMU,
      heightEMU,
      fromCol,
      0,
      fromRow,
      0
    );
    if (chart && Asc.scope.title) {
      chart.SetTitle(Asc.scope.title, 14);
    }
  });
};

return func;

Methods used: GetActiveSheet, GetSelection, GetRange, GetAddress, AddChart, SetTitle, GetRow, GetCol, Asc.scope object

Result