Customizing Chart Area

30 Aug 20249 minutes to read

Chart area refers to the space that contains the chart or graph you’ve inserted into a document. It includes the entire chart and all its elements, such as data points, labels, axes, and the plot area. Using DocIO, you can customize the chart area in the chart.

Customization of Border

The following code snippet illustrates how to modify the border of the chart area.

NOTE

Refer to the appropriate tabs in the code snippets section: C# [Cross-platform] for ASP.NET Core, Blazor, Xamarin, UWP, .NET MAUI, and WinUI; C# [Windows-specific] for WinForms and WPF; VB.NET [Windows-specific] for VB.NET applications.

C# [Cross-platform]

//Format the chart area.
IOfficeChartFrameFormat chartArea = chart.ChartArea;
//Set border line pattern, color, line weight.
chartArea.Border.LinePattern = OfficeChartLinePattern.Solid;
chartArea.Border.LineColor = Syncfusion.Drawing.Color.Blue;
chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline;

C# [Windows-specific]

//Format the chart area.
IOfficeChartFrameFormat chartArea = chart.ChartArea;
//Set border line pattern, color, line weight.
chartArea.Border.LinePattern = OfficeChartLinePattern.Solid;
chartArea.Border.LineColor = Color.Blue;
chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline;

VB.NET [Windows-specific]

' Format the chart area.
Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea
' Set border line pattern, color, line weight.
chartArea.Border.LinePattern = OfficeChartLinePattern.Solid
chartArea.Border.LineColor = Color.Blue
chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline

Customization of Color

The following code snippet illustrates how to fill the color in chart area.

C# [Cross-platform]

//Set fill type and fill colors.
chartArea.Fill.FillType = OfficeFillType.Gradient;
chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor;
chartArea.Fill.BackColor = Syncfusion.Drawing.Color.FromArgb(205, 217, 234);
chartArea.Fill.ForeColor = Syncfusion.Drawing.Color.White;

C# [Windows-specific]

//Set fill type and fill colors.
chartArea.Fill.FillType = OfficeFillType.Gradient;
chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor;
chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234);
chartArea.Fill.ForeColor = Color.White;

VB.NET [Windows-specific]

' Set fill type and fill colors.
chartArea.Fill.FillType = OfficeFillType.Gradient
chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor
chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234)
chartArea.Fill.ForeColor = Color.White

The complete code snippet illustrating the above options is shown below.

C# [Cross-platform]

FileStream fileStreamPath = new FileStream("Data/Template.docx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
 //Open an existing document from file system through constructor of WordDocument class.
 using (WordDocument document = new WordDocument(fileStreamPath, FormatType.Docx))
 {
     //Get the paragraph.
     WParagraph paragraph = document.LastParagraph;
     //Get the chart entity.
     WChart chart = paragraph.ChildEntities[0] as WChart;
     //Modify the chart height and width.
     chart.Height = 300;
     chart.Width = 500;

     //Format the chart area.
     IOfficeChartFrameFormat chartArea = chart.ChartArea;

     //Set border line pattern, color, line weight.
     chartArea.Border.LinePattern = OfficeChartLinePattern.Solid;
     chartArea.Border.LineColor = Syncfusion.Drawing.Color.Blue;
     chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline;

     //Set fill type and fill colors.
     chartArea.Fill.FillType = OfficeFillType.Gradient;
     chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor;
     chartArea.Fill.BackColor = Syncfusion.Drawing.Color.FromArgb(205, 217, 234);
     chartArea.Fill.ForeColor = Syncfusion.Drawing.Color.White;

     using (FileStream outputStream = new FileStream("Sample.docx", FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite))
     {
         //Save the Word file.
         document.Save(outputStream, FormatType.Docx);
     }
 }

C# [Windows-specific]

using (WordDocument document = new WordDocument("Template.docx", FormatType.Docx))
{
    //Get the paragraph.
    WParagraph paragraph = document.LastParagraph;
    //Get the chart entity.
    WChart chart = paragraph.ChildEntities[0] as WChart;
    //Modify the chart height and width.
    chart.Height = 300;
    chart.Width = 500;

    //Format the chart area.
    IOfficeChartFrameFormat chartArea = chart.ChartArea;

    //Set border line pattern, color, line weight.
    chartArea.Border.LinePattern = OfficeChartLinePattern.Solid;
    chartArea.Border.LineColor = Color.Blue;
    chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline;

    //Set fill type and fill colors.
    chartArea.Fill.FillType = OfficeFillType.Gradient;
    chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor;
    chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234);
    chartArea.Fill.ForeColor = Color.White;

    //Save the Word file.
    document.Save("Sample.docx");
}

VB.NET [Windows-specific]

Using document As New WordDocument("Template.docx", FormatType.Docx)
    ' Get the paragraph.
    Dim paragraph As WParagraph = document.LastParagraph

    ' Get the chart entity.
    Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart)

    ' Modify the chart height and width.
    chart.Height = 300
    chart.Width = 500

    ' Format the chart area.
    Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea

    ' Set border line pattern, color, and line weight.
    chartArea.Border.LinePattern = OfficeChartLinePattern.Solid
    chartArea.Border.LineColor = Color.Blue
    chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline

    ' Set fill type and fill colors.
    chartArea.Fill.FillType = OfficeFillType.Gradient
    chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor
    chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234)
    chartArea.Fill.ForeColor = Color.White

    ' Save the Word file.
    document.Save("Sample.docx")
End Using

You can download a complete working sample from GitHub.

Add Image in Chart Area

The following code snippet illustrates how to fill the image in chart area.

C# [Cross-platform]

//Append image in chart area.
FileStream imageStream = new FileStream("Data/Image.png", FileMode.Open, FileAccess.Read);
Image image = Image.FromStream(imageStream);
chartArea.Fill.UserPicture(image, "image");

C# [Windows-specific]

//Append image in chart area.
chartArea.Fill.UserPicture("Image.png");

VB.NET [Windows-specific]

' Append an image to the chart area.
chartArea.Fill.UserPicture("Image.png")

Set the Transparency level

The following code snippet illustrates how to make transparency in chart area.

C# [Cross-platform]

// Set the transparency of the chart area.
chartArea.Fill.Transparency = 0.5;

C# [Windows-specific]

// Set the transparency of the chart area.
chartArea.Fill.Transparency = 0.5;

VB.NET [Windows-specific]

' Set the transparency of the chart area.
chartArea.Fill.Transparency = 0.5

NOTE

Transparency is only applicable when FillType is set as SolidColor. Color-shaded fill is represented as a floating-point value ranging from 0.0 (Clear) to 1.0 (Opaque).