Class Chart

Represents a chart element within the document.

Inheritance
System.Object
ContentElement
Chart
Implements
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
Inherited Members
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Chart : ContentElement

When a Word document needs to present figures visually, Chart is the content element that draws them. It represents one chart, such as a bar, line, or pie chart, that a developer builds in code and adds to the document alongside paragraphs, tables, and images.

A chart is created with new Chart() for a blank chart, or with new Chart(ChartType, string) to set the chart kind and an optional title in one step. From there it is added to the document the same way as any other content element, so it sits inside a section or container with the rest of the content. The chart's kind can also be changed afterward through the Type property, which takes a ChartType value.

The values a chart plots come from its DataSource, a ChartDataSource assigned to the chart, while Style (a ChartStyle) controls themes and colors and AxisConfig (an AxisConfiguration) tunes the axes. Set Title for a heading above the plot, and toggle the boolean HasLegend to show or hide the legend that labels each series. Because data, styling, and axis configuration each live on their own property, a developer can prepare them independently and attach them as the chart is assembled, then adjust one without disturbing the others. A blank chart created with new Chart() can have its Type and these properties filled in step by step, which suits code that decides the chart kind at runtime, while the two-argument constructor is the shorter path when the kind and title are known up front.

var chart = new Chart(ChartType.Bar, "Quarterly Revenue");
chart.HasLegend = true;

The document element tutorial shows how content elements assemble into a document, the add table how-to handles structured data nearby, and the add image how-to covers other visual content.

Constructors

Chart()

Initializes a new instance of the Chart class.

Declaration
public Chart()

Chart(ChartType, String)

Initializes a new instance of the Chart class with the specified type and optional title.

Declaration
public Chart(ChartType chartType, string title = null)
Parameters
Type Name Description
ChartType chartType

The type of the chart (e.g., Bar, Line, Pie).
System.String title

The title of the chart (optional).

Properties

AxisConfig

Gets or sets the chart's axis configuration.

Declaration
public AxisConfiguration AxisConfig { get; set; }
Property Value
Type Description
AxisConfiguration

DataSource

Gets or sets the data source for the chart.

Declaration
public ChartDataSource DataSource { get; set; }
Property Value
Type Description
ChartDataSource

HasLegend

Gets or sets a value indicating whether the chart has a legend.

Declaration
public bool HasLegend { get; set; }
Property Value
Type Description
System.Boolean

Style

Gets or sets the chart's visual style and themes.

Declaration
public ChartStyle Style { get; set; }
Property Value
Type Description
ChartStyle

Title

Gets or sets the title of the chart.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

Type

Gets or sets the type of the chart (e.g., Bar, Line, Pie).

Declaration
public ChartType Type { get; set; }
Property Value
Type Description
ChartType

Implements

IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable

Inherited members

Replace(IWordDocumentObject)
Remove()
GetIndex<T>()
Clone()
CloneObject()
Parent
Status