Click or drag to resize

IChartSerieDataFormat Interface

Represents formatting options for the series data.

Namespace: Spire.Xls.Core
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public interface IChartSerieDataFormat : IChartFillBorder

The IChartSerieDataFormat type exposes the following members.

Properties
Name Description
Public property Code example AreaProperties
Returns object, that represents aera properties. Read only.
Examples
The following code illustrates how to access AreaProperties properties and set color to IChartInterior.ForegroundColorIndex property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set interior</para><para>IChartInterior interior = chart.Series[0].Format.AreaProperties;</para><para>//Set color</para><para>interior.ForegroundColor = Color.Red;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example BarTopType
Represents the top data format.
Examples
The following code illustrates how to set ExcelTopFormat.Sharp to BarShapeTop property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Bar3DStacked;</para><para>//Set Bar shape base</para><para>chart.Series[0].Format.BarTopType = TopFormatType.Sharp;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example BarType
Represents the base data format.
Examples
The following code illustrates how to set BaseFormatType.Circle to BarShapeBase:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Bar3DStacked;</para><para>//Set Bar shape base</para><para>chart.Series[0].Format.BarType = BaseFormatType.Circle;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Fill
Represents XlsFill options. Read-only.
Examples
The following code illustrates the use of Fill property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets fill options for the chart element</para><para>IShapeFill fillChart = chart.ChartArea.Fill;</para><para>fillChart.FillType = ShapeFillType.Gradient;</para><para>fillChart.BackColor = Color.FromArgb(205, 217, 234);</para><para>fillChart.ForeColor = Color.White;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example Format3D
Gets the chart3 D properties.
Examples
The following code illustrates the use of Format3D property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets 3D-effect properties for the chart element</para><para>Format3D threeDFromat = chart.ChartArea.Format3D;</para><para>threeDFromat.BevelTopType = XLSXChartBevelType.Slope;</para><para>threeDFromat.BevelTopHeight = 16;</para><para>threeDFromat.BevelTopWidth = 7;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example HasFormat3D
Gets a value indicating whether [has3d properties].
Examples
The following code illustrates the use of HasFormat3D property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Create a fill border and set 3D formatting value</para><para>IChartFillBorder fillBorder = chart.ChartArea;</para><para>chart.ChartArea.Format3D.BevelTopType = XLSXChartBevelType.Slope;</para><para>//True if the chart element has 3D formatting</para><para>if (fillBorder.HasFormat3D){//Your Code Here}</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example HasInterior
This property indicates whether interior object was created. Read-only.
Examples
The following code illustrates the use of HasInterior property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Create a fill border and set interior value</para><para>IChartFillBorder fillBorder = chart.ChartArea;</para><para>chart.ChartArea.Interior.ForegroundColor = Color.Yellow;</para><para>//True if the chart element has interior formatting</para><para>if (fillBorder.HasInterior){//Your Code Here}</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example HasLineProperties
This property indicates whether line formatting object was created. Read-only.
Examples
The following code illustrates the use of HasLineProperties property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Create a fill border and set line border value</para><para>IChartFillBorder fillBorder = chart.ChartArea;</para><para>chart.ChartArea.Border.Color = Color.Yellow;</para><para>//True if the chart element has line formatting</para><para>if (fillBorder.HasLineProperties){//Your Code Here}</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example HasShadow
Gets a value indicating whether this instance has shadow properties.
Examples
The following code illustrates the use of HasShadowProperties property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Create a fill border and set line border value</para><para>IChartFillBorder fillBorder = chart.ChartArea;</para><para>chart.ChartArea.Shadow.ShadowOuterType = XLSXChartShadowOuterType.OffsetBottom;</para><para>//True if the chart element has 3D formatting</para><para>if (fillBorder.HasShadow){//Your Code Here}</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example Interior
Returns object, that represents area properties. Read-only.
Examples
The following code illustrates the use of Interior property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets interior formatting properties for the chart element</para><para>IChartInterior chartInterior = chart.ChartArea.Interior;</para><para>chartInterior.BackgroundColor = Color.Beige;</para><para>chartInterior.Pattern = ExcelPatternType.DarkDownwardDiagonal;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example Is3DBubbles
True to draw bubbles with 3D effects.
Examples
The following code illustrates how Is3DBubbles property can be used:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Bubble3D;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Check type</para><para>Console.WriteLine(format.Is3DBubbles);</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example IsAutoMarker
Automatic color.
Examples
The following code illustrates how IsAutoMarker property can be used:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:F2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.LineMarkers;</para><para>//Set serie data format</para><para>IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat;</para><para>//Check auto marker</para><para>Console.Write(format.IsAutoMarker);</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example IsMarkerSupported
Indicates whether marker is supported by this chart/series.
Examples
The following code illustrates how set ExcelTreeMapLabelOption.Banner to TreeMapLabelOption:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Pie;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Check marker support</para><para>Console.WriteLine(format.IsMarkerSupported);</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example LineProperties
Returns object, that represents line properties. Read-only.
Examples
The following code illustrates the use of LineProperties:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets line formatting properties for the chart element</para><para>IChartBorder border = chart.PlotArea.Border;</para><para>border.Pattern = ChartLinePatternType.DashDotDot;</para><para>border.Color = Color.Orange;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Public property Code example MarkerBackgroundColor
Foreground color: RGB value (high byte = 0).
Examples
The following code illustrates how to set color to markers in charts:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Circle;</para><para>//Set color</para><para>format.MarkerBackgroundColor = Color.Red;</para><para>format.MarkerForegroundColor = Color.Black;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example MarkerBackgroundKnownColor
Index to color of marker XlsFill.
Examples
The following code illustrates how to set a color from ExcelColors enumeration to marker applied:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Circle;</para><para>//Set color</para><para>format.MarkerBackgroundKnownColor = ExcelColors.Red;</para><para>format.MarkerForegroundKnownColor = ExcelColors.Black;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example MarkerForegroundColor
Background color: RGB value (high byte = 0).
Examples
The following code illustrates how to set color for markers in charts:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Circle;</para><para>//Set color</para><para>format.MarkerBackgroundColor = Color.Red;</para><para>format.MarkerForegroundColor = Color.Black;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example MarkerForegroundKnownColor
Index to color of marker border.
Examples
The following code illustrates how to set a color from ExcelColors enumeration to marker applied:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Circle;</para><para>//Set color</para><para>format.MarkerBackgroundKnownColor = ExcelColors.Red;</para><para>format.MarkerForegroundKnownColor = ExcelColors.Black;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example MarkerSize
Size of line markers.
Examples
The following code illustrates how to set MarkerSize for applied markers in charts:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Circle;</para><para>//Set marker size</para><para>format.MarkerSize = 10;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example MarkerStyle
Type of marker.
Examples
The following code illustrates how marker style can be applied to charts:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Line;</para><para>//Set serie format</para><para>IChartSerieDataFormat format = chart.Series[0].Format;</para><para>//Set marker style</para><para>format.MarkerStyle = ChartMarkerType.Star;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Options
Gets common serie options. Read-only.
Examples
The following code illustrates how IChartFormat.GapWidth can be set by accessing CommonSerieOptions property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DStacked;</para><para>//Set options</para><para>IChartFormat options = chart.Series[0].Format.Options;</para><para>//Set Gap width</para><para>options.GapWidth = 400;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Percent
Distance of pie slice from center of pie.
Examples
The following code illustrates how to set Percent property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Set range</para><para>chart.DataRange = worksheet.Range["A1:C2"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Pie;</para><para>//Set percent</para><para>chart.Series[0].Format.Percent = 30;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Shadow
Gets the shadow properties.
Examples
The following code illustrates the use of Shadow property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets shadow formatting properties for the chart element</para><para>ChartShadow shadowChart = chart.ChartArea.Shadow;</para><para>shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below;</para><para>shadowChart.Color = Color.Aqua;</para><para>shadowChart.Blur = 22;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
(Inherited from IChartFillBorder .)
Top
See Also