How to create clustered pyramid chart in Word document using C#?

3 mins read

Syncfusion Essential DocIO is a .NET Core Word library used to create, read, and edit Word documents programmatically without Microsoft Word or Interop dependencies. Using this library, you can create clustered pyramid chart in Word document in C#.

What is clustered pyramid chart?

A variation on a column/bar chart that uses pyramid shapes instead of rectangular columns/bars is called a Pyramid chart. A clustered pyramid chart plots the data in discrete vertical pyramids.

Clustered pyramid chart in ASP.NET Core DocIO

Clustered Pyramid chart in Word document

Steps to create clustered pyramid chart in Word document:

Step 1: Initialize chart

Create a chart object by calling the paragraph.AppendChart(446,270) method and specify the chart type to the OfficeChartType.Pyramid_Clustered enum value.

//Create and append the chart to the paragraph.
WChart chart = paragraph.AppendChart(446, 270);
//Set chart type.
chart.ChartType = OfficeChartType.Pyramid_Clustered;

Step 2: Assign data and chart elements

Add the basic elements like the chart title, data labels and legend.

Assign data.
ChartTitle of the chart object.
Set DataLabels using the DefaultDataPoint.
Set TRUE to the chart’s HasLegend property to show the legend, else False.

//Set region of Chart data.
chart.DataRange = chart.ChartData[1, 1, 6, 4];
 
//Apply the chart elements.
//Set a chart title.
chart.ChartTitle = "Clustered Pyramid Chart";
 
//Set Datalabels.
IOfficeChartSerie series1 = chart.Series[0];
series1.DataPoints.DefaultDataPoint.DataLabels.IsValue = true;
 
//Set legend.
chart.HasLegend = true;
chart.Legend.Position = OfficeLegendPosition.Bottom;

Step 3: Apply 3D chart elements

Add the 3D charts elements like Rotation and Elevation.

Rotation of the chart object.
Elevation of the chart object.

//Set rotation and elevation.
Chart.Rotation = 50;
chart.Elevation = 20;

Applicable properties for clustered pyramid chart

Below is a list of other common properties applicable for clustered pyramid chart.

GapWidth
GapDepth
BarShapeBase and BarShapeTop (to change the shape of the column / bar)
Note:
Applying the properties apart from the mentioned list might throw an exception, or the changes will not be reflected in the output document because those properties are not related to the clustered pyramid chart.

The following C# code sample shows the creation of clustered pyramid chart using the Word library.

//Create a new Word document.
using (WordDocument document = new WordDocument())
{
    //Add a section to the document.
    IWSection section = document.AddSection();
    //Add a paragraph to the section.
    IWParagraph paragraph = section.AddParagraph();
    //Create and append the chart to the paragraph.
    WChart chart = paragraph.AppendChart(446, 270);
    //Set chart data.
    chart.ChartData.SetValue(1, 1, "Fruits");
    chart.ChartData.SetValue(2, 1, "Apples");
    chart.ChartData.SetValue(3, 1, "Grapes");
    chart.ChartData.SetValue(4, 1, "Bananas");
    chart.ChartData.SetValue(5, 1, "Oranges");
    chart.ChartData.SetValue(6, 1, "Melons");
    chart.ChartData.SetValue(1, 2, "Joey");
    chart.ChartData.SetValue(2, 2, 5);
    chart.ChartData.SetValue(3, 2, 4);
    chart.ChartData.SetValue(4, 2, 4);
    chart.ChartData.SetValue(5, 2, 2);
    chart.ChartData.SetValue(6, 2, 2);
    chart.ChartData.SetValue(1, 3, "Matthew");
    chart.ChartData.SetValue(2, 3, 3);
    chart.ChartData.SetValue(3, 3, 5);
    chart.ChartData.SetValue(4, 3, 4);
    chart.ChartData.SetValue(5, 3, 1);
    chart.ChartData.SetValue(6, 3, 7);
    chart.ChartData.SetValue(1, 4, "Peter");
    chart.ChartData.SetValue(2, 4, 2);
    chart.ChartData.SetValue(3, 4, 2);
    chart.ChartData.SetValue(4, 4, 3);
    chart.ChartData.SetValue(5, 4, 5);
    chart.ChartData.SetValue(6, 4, 6);
    //Set region of Chart data.
    chart.DataRange = chart.ChartData[1, 1, 6, 4];
    //Set chart series in the column for assigned data region.
    chart.IsSeriesInRows = false;
    //Set a Chart Title.
    chart.ChartTitle = "Clustered Pyramid Chart";
    //Set Datalabels.
    IOfficeChartSerie series1 = chart.Series[0];
    IOfficeChartSerie series2 = chart.Series[1];
    IOfficeChartSerie series3 = chart.Series[2];
 
    series1.DataPoints.DefaultDataPoint.DataLabels.IsValue = true;
    series2.DataPoints.DefaultDataPoint.DataLabels.IsValue = true;
    series3.DataPoints.DefaultDataPoint.DataLabels.IsValue = true;
    //Set legend.
    chart.HasLegend = true;
    chart.Legend.Position = OfficeLegendPosition.Bottom;
    //Set chart type.
    chart.ChartType = OfficeChartType.Pyramid_Clustered;
    //Set rotation and elevation.
    chart.Rotation = 50;
    chart.Elevation = 20;
    //Create a file stream.
    using (FileStream outputFileStream = new FileStream(Path.GetFullPath(@"../../../Sample.docx"), FileMode.Create, FileAccess.ReadWrite))
    {
        //Save the Word document to the file stream.
        document.Save(outputFileStream, FormatType.Docx);
    }
}

A complete working sample of how to create clustered pyramid chart in Word document in C# can be downloaded from GitHub.

Take a moment to peruse the documentation, where you can find basic Word document processing options along with the features like mail merge, merge and split documents, find and replace text in the Word document, protect the Word documents, and most importantly, the PDF and Image conversions with code examples.

Explore more about the rich set of Syncfusion Word Framework features and an online example to create a chart in a Word document.