Class ExcelChart
Base class for Chart object.
Implements
Inherited Members
Namespace: OfficeOpenXml.Drawing.Chart
Assembly: EPPlus.dll
Syntax
public abstract class ExcelChart : ExcelDrawing, IDisposable
Fields
_chartNode
The chart element
Declaration
protected XmlNode _chartNode
Field Value
| Type | Description |
|---|---|
| XmlNode |
_chartXmlHelper
The Xml helper for the chart xml
Declaration
protected XmlHelper _chartXmlHelper
Field Value
| Type | Description |
|---|---|
| XmlHelper |
Properties
AutoTitleDeleted
Indicates if auto title is used. Set to false if auto title is used. Auto title is used on for example pivot charts to map to the data fields to the title and series. Also see SetAutoTitle()
Declaration
public bool AutoTitleDeleted { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Axis
An array containg all axis of all Charttypes
Declaration
public virtual ExcelChartAxis[] Axis { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartAxis[] |
BackWall
Formatting for the backwall of a 3D chart.
note
This property is null for non 3D charts
Declaration
public ExcelChartSurface BackWall { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartSurface |
Border
Border
Declaration
public abstract ExcelDrawingBorder Border { get; }
Property Value
| Type | Description |
|---|---|
| ExcelDrawingBorder |
ChartType
Type of chart
Declaration
public eChartType ChartType { get; }
Property Value
| Type | Description |
|---|---|
| eChartType |
ChartXml
The chart xml document
Declaration
public XmlDocument ChartXml { get; }
Property Value
| Type | Description |
|---|---|
| XmlDocument |
DisplayBlanksAs
Specifies the possible ways to display blanks
Declaration
public abstract eDisplayBlanksAs DisplayBlanksAs { get; set; }
Property Value
| Type | Description |
|---|---|
| eDisplayBlanksAs |
DrawingType
The type of drawing
Declaration
public override eDrawingType DrawingType { get; }
Property Value
| Type | Description |
|---|---|
| eDrawingType |
Overrides
Effect
Effects
Declaration
public abstract ExcelDrawingEffectStyle Effect { get; }
Property Value
| Type | Description |
|---|---|
| ExcelDrawingEffectStyle |
Fill
Access to Fill properties
Declaration
public abstract ExcelDrawingFill Fill { get; }
Property Value
| Type | Description |
|---|---|
| ExcelDrawingFill |
Floor
Formatting for the floor of a 3D chart.
note
This property is null for non 3D charts
Declaration
public ExcelChartSurface Floor { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartSurface |
Font
Access to font properties
Declaration
public abstract ExcelTextFont Font { get; }
Property Value
| Type | Description |
|---|---|
| ExcelTextFont |
HasLegend
If the chart has a legend
Declaration
public abstract bool HasLegend { get; }
Property Value
| Type | Description |
|---|---|
| bool |
HasTitle
True if the chart has a title
Declaration
public abstract bool HasTitle { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Legend
Legend
Declaration
public virtual ExcelChartLegend Legend { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartLegend |
PivotTableSource
If the chart is a pivochart this is the pivotable used as source.
Declaration
public ExcelPivotTable PivotTableSource { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelPivotTable |
PlotArea
Plotarea
Declaration
public abstract ExcelChartPlotArea PlotArea { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartPlotArea |
RoundedCorners
Border rounded corners
Declaration
public abstract bool RoundedCorners { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Series
Chart series
Declaration
public virtual ExcelChartSeries<ExcelChartSerie> Series { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartSeries<ExcelChartSerie> |
ShowDataLabelsOverMaximum
Specifies data labels over the maximum of the chart shall be shown
Declaration
public abstract bool ShowDataLabelsOverMaximum { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
ShowHiddenData
Show data in hidden rows and columns
Declaration
public abstract bool ShowHiddenData { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
SideWall
Formatting for the sidewall of a 3D chart.
note
This property is null for non 3D charts
Declaration
public ExcelChartSurface SideWall { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartSurface |
Style
The build-in chart styles. Use StyleManager for the more modern styling.
Declaration
public abstract eChartStyle Style { get; set; }
Property Value
| Type | Description |
|---|---|
| eChartStyle |
StyleManager
Manage style settings for the chart
Declaration
public ExcelChartStyleManager StyleManager { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartStyleManager |
TextBody
Access to text body properties
Declaration
public abstract ExcelTextBody TextBody { get; }
Property Value
| Type | Description |
|---|---|
| ExcelTextBody |
ThreeD
3D properties
Declaration
public abstract ExcelDrawing3D ThreeD { get; }
Property Value
| Type | Description |
|---|---|
| ExcelDrawing3D |
Title
The titel of the chart
Declaration
public virtual ExcelChartTitle Title { get; }
Property Value
| Type | Description |
|---|---|
| ExcelChartTitle |
UseSecondaryAxis
If true the charttype will use the secondary axis. The chart must contain a least one other charttype that uses the primary axis.
Declaration
public bool UseSecondaryAxis { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
VaryColors
If the chart has only one serie this varies the colors for each point. This property does not apply to extention charts.
Declaration
public abstract bool VaryColors { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
View3D
3D-settings
Declaration
public abstract ExcelView3D View3D { get; }
Property Value
| Type | Description |
|---|---|
| ExcelView3D |
WorkSheet
Reference to the worksheet
Declaration
public ExcelWorksheet WorkSheet { get; }
Property Value
| Type | Description |
|---|---|
| ExcelWorksheet |
XAxis
The X Axis
Declaration
public virtual ExcelChartAxis XAxis { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartAxis |
YAxis
The Y Axis
Declaration
public virtual ExcelChartAxis YAxis { get; protected set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartAxis |
Methods
DeleteTitle()
Remove the title from the chart
Declaration
public abstract void DeleteTitle()
HasThirdAxis()
Returns true if the chart is a sureface chart
Declaration
protected bool HasThirdAxis()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a sureface chart |
IsType3D()
Returns true if the chart is a 3D chart
Declaration
protected bool IsType3D()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a 3D chart |
IsTypeArea()
Returns true if the chart is a scatter chart
Declaration
protected bool IsTypeArea()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a scatter chart |
IsTypeBubble()
Returns true if the chart is a bubble chart
Declaration
protected bool IsTypeBubble()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a bubble chart |
IsTypeClustered()
Returns true if the chart is of type clustered
Declaration
protected bool IsTypeClustered()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is of type clustered |
IsTypeDoughnut()
Returns true if the chart is a Doughnut chart
Declaration
protected bool IsTypeDoughnut()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a Doughnut chart |
IsTypeLine()
Returns true if the chart is a line chart
Declaration
protected bool IsTypeLine()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a line chart |
IsTypePercentStacked()
Returns true if the chart is of type stacked percentage
Declaration
protected bool IsTypePercentStacked()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is of type stacked percentage |
IsTypePie()
Returns true if the chart is a pie chart
Declaration
protected bool IsTypePie()
Returns
| Type | Description |
|---|---|
| bool | true if the chart is a pie chart |
IsTypePieDoughnut()
Returns true if the chart is a pie or Doughnut chart
Declaration
protected bool IsTypePieDoughnut()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a pie or Doughnut chart |
IsTypeRadar()
Returns true if the chart is a radar chart
Declaration
protected bool IsTypeRadar()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a radar chart |
IsTypeScatter()
Returns true if the chart is a scatter chart
Declaration
protected bool IsTypeScatter()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a scatter chart |
IsTypeShape()
Returns true if the chart has shapes, like bars and columns
Declaration
protected bool IsTypeShape()
Returns
| Type | Description |
|---|---|
| bool | True if the chart has shapes |
IsTypeStacked()
Returns true if the chart is of type stacked
Declaration
protected bool IsTypeStacked()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is of type stacked |
IsTypeStock()
Return true if the chart is a stock chart.
Declaration
protected bool IsTypeStock()
Returns
| Type | Description |
|---|---|
| bool | true if the chart is a stock chart. |
IsTypeSurface()
Returns true if the chart is a sureface chart
Declaration
protected bool IsTypeSurface()
Returns
| Type | Description |
|---|---|
| bool | True if the chart is a sureface chart |