Click or drag to resize

ChartFormat Class

Represents the formatting options for a chart, including settings for appearance, labels, and data presentation.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Charts XlsChartFormat
Spire.Xls.Charts ChartFormat

Namespace: Spire.Xls.Charts
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class ChartFormat : XlsChartFormat

The ChartFormat type exposes the following members.

Properties
Name Description
Public property AutoScaling
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart..
(Inherited from XlsChartFormat .)
Public property BubbleScale
Percent of largest bubble compared to chart in general. ( 0 - 300 )
(Inherited from XlsChartFormat .)
Public property DataFormatOrNull
Returns dataformat or null; Read-only.
Public property Delimiter Obsolete.
Gets or sets the delimiter used to separate elements.
(Inherited from XlsChartFormat .)
Public property DelimiterLength Obsolete.
Gets the length of the delimiter.
(Inherited from XlsChartFormat .)
Public property DepthPercent
Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
(Inherited from XlsChartFormat .)
Public property DoughnutHoleSize
Size of center hole in a doughnut chart (as a percentage).( 10 - 90 )
(Inherited from XlsChartFormat .)
Public property DrawingZOrder
Drawing order (0 = bottom of the z-order).
(Inherited from XlsChartFormat .)
Public property Elevation
Gets or sets the elevation of the 3-D chart view, in degrees (0 to +90 degrees).
(Inherited from XlsChartFormat .)
Public property FirstDropBar
Gets first drop bar.
Public property FirstSliceAngle
Angle of the first pie slice expressed in degrees. ( 0 - 360 )
(Inherited from XlsChartFormat .)
Public property Gap Obsolete.
Space between the first pie and the second.
(Inherited from XlsChartFormat .)
Public property GapDepth
Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )
(Inherited from XlsChartFormat .)
Public property GapWidth
Space between categories (percent of bar width), default = 50.
(Inherited from XlsChartFormat .)
Public property HasRadarAxisLabels
True if a radar chart has axis labels. Applies only to radar charts.
(Inherited from XlsChartFormat .)
Public property HasShadowBar
Indicates whether bar has a shadow.
(Inherited from XlsChartFormat .)
Public property HasShadowBoppop
Indicates whether bar has a shadow.
(Inherited from XlsChartFormat .)
Public property HasShadowLine
True if this line has a shadow.
(Inherited from XlsChartFormat .)
Public property HasShadowPie
True if this pie has a shadow.
(Inherited from XlsChartFormat .)
Public property HasShadowRadar
True if this radar series has a shadow.
(Inherited from XlsChartFormat .)
Public property HasShadowScatter
True if bubble series has a shadow.
(Inherited from XlsChartFormat .)
Public property HasValue Obsolete.
If true has value.
(Inherited from XlsChartFormat .)
Public property HasWedgeCallout Obsolete.
Gets or sets a value indicating whether the wedge callout is present.
(Inherited from XlsChartFormat .)
Public property HeightPercent
Returns or sets the height of a 3-D chart as a percentage of the chart width
(Inherited from XlsChartFormat .)
Public property Is3D
If true - serie 3D; otherwise serie 2D. Read-only.
(Inherited from XlsChartFormat .)
Public property Is3DPhongShade
True if this surface chart has shading.
(Inherited from XlsChartFormat .)
Public property IsAreaShadowed
This area has a shadow.
(Inherited from XlsChartFormat .)
Public property IsBubbles Obsolete.
True if this a bubble series.
(Inherited from XlsChartFormat .)
Public property IsBubbleSize Obsolete.
If true buble has size.
(Inherited from XlsChartFormat .)
Public property IsCategoryBrokenDown Obsolete.
Each category is broken down as a percentage.
(Inherited from XlsChartFormat .)
Public property IsCategoryName Obsolete.
If true category has name.
(Inherited from XlsChartFormat .)
Public property IsChartChartLine Obsolete.
If true - format contains chart chart line record. Read-only.
(Inherited from XlsChartFormat .)
Public property IsChartLineFormat
If true - format contains series line. Read-only.
(Inherited from XlsChartFormat .)
Public property IsClustered Obsolete.
3D columns are clustered or stacked.
(Inherited from XlsChartFormat .)
Public property IsDefaultElevation
Indicates whether elevation has default value.
(Inherited from XlsChartFormat .)
Public property IsDefaultRotation
Indicates whether rotation has default value.
(Inherited from XlsChartFormat .)
Public property IsDropBar
If true - format contains drop bar record. Read-only.
(Inherited from XlsChartFormat .)
Public property IsFillSurface Obsolete.
True if chart contains color XlsFill for surface.
(Inherited from XlsChartFormat .)
Public property IsHorizontalBar Obsolete.
True for horizontal bars (bar chart). False for vertical bars (column chart).
(Inherited from XlsChartFormat .)
Public property IsLine Obsolete.
If true - format has line; otherwise false. Read-only.
(Inherited from XlsChartFormat .)
Public property IsMarker
If true - format has marker; otherwise false. Read-only.
(Inherited from XlsChartFormat .)
Public property IsPercentage Obsolete.
If true has percentage.
(Inherited from XlsChartFormat .)
Public property IsPrimaryAxis
If true then belong to primary axis; otherwise to secondary axis.
(Inherited from XlsChartFormat .)
Public property IsSeriesName Obsolete.
If true serie has name.
(Inherited from XlsChartFormat .)
Public property IsShowLeaderLines Obsolete.
True to show leader lines to data labels.
(Inherited from XlsChartFormat .)
Public property IsSmoothed
If true - format has smothed line; otherwise false. Read-only.
(Inherited from XlsChartFormat .)
Public property IsStacked Obsolete.
Series in this group are stacked.
(Inherited from XlsChartFormat .)
Public property IsVaryColor
Vary color for each data point.
(Inherited from XlsChartFormat .)
Public property IsVeryColor
Vary color for each data point.
(Inherited from XlsChartFormat .)
Public property LineStyle Obsolete.
Drop lines / hi-lo lines: 0 = drop lines 1 = hi-lo lines 2 = series lines (the lines that connect the columns in a stacked column chart)
(Inherited from XlsChartFormat .)
Public property NumSplitValue Obsolete.
For split = 1, what values should go to the other pie / bar.
(Inherited from XlsChartFormat .)
Public property Overlap
Space between bars ( -100 : 100 ).
(Inherited from XlsChartFormat .)
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property Perspective
Returns or sets the perspective for the 3-D chart view.( 0 - 100 )
(Inherited from XlsChartFormat .)
Public property PieChartType Obsolete.
Chart pie type.
(Inherited from XlsChartFormat .)
Public property PieSecondSize
Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. ( 5 - 200 )
(Inherited from XlsChartFormat .)
Public property PieSeriesLine
Represents series line properties. ( For pie of pie or pie of bar chart types only. ) Read only.
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RightAngleAxes
True if the chart axes are at right angles, independent of chart rotation or elevation.
(Inherited from XlsChartFormat .)
Public property Rotation
Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).
(Inherited from XlsChartFormat .)
Public property SecondDropBar
Returns object that represents second drop bar.
Public property ShowAsPercentsBar Obsolete.
Each category is displayed as a percentage.
(Inherited from XlsChartFormat .)
Public property ShowAsPercentsLine Obsolete.
Each category is broken down as a percentage.
(Inherited from XlsChartFormat .)
Public property ShowNegativeBubbles
True to show negative bubbles.
(Inherited from XlsChartFormat .)
Public property SizeRepresents
Returns or sets what the bubble size represents on a bubble chart.
(Inherited from XlsChartFormat .)
Public property SplitPercent Obsolete.
For split = 2, what percentage should go to the other pie / bar.
(Inherited from XlsChartFormat .)
Public property SplitType
Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.
(Inherited from XlsChartFormat .)
Public property SplitValue
Returns or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
(Inherited from XlsChartFormat .)
Public property StackValuesBar Obsolete.
Stack the displayed values.
(Inherited from XlsChartFormat .)
Public property StackValuesLine Obsolete.
Stack the displayed values.
(Inherited from XlsChartFormat .)
Public property UseDefaultSplitValue Obsolete.
True to use default split value; otherwise False.
(Inherited from XlsChartFormat .)
Public property WallsAndGridlines2D Obsolete.
True if gridlines are drawn two-dimensionally on a 3-D chart.
(Inherited from XlsChartFormat .)
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clone
Clones current object.
(Inherited from XlsChartFormat .)
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also