Click or drag to resize

XlsChartSerieDataFormat Class

Represents the data format settings for a series in an Excel chart.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Charts XlsChartSerieDataFormat
Spire.Xls.Charts ChartSerieDataFormat

Namespace: Spire.Xls.Core.Spreadsheet.Charts
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class XlsChartSerieDataFormat : XlsObject, 
	IChartSerieDataFormat, IChartFillBorder

The XlsChartSerieDataFormat type exposes the following members.

Properties
Name Description
Public property AreaProperties
Returns object, that represents aera properties. Read only.
Public property BackGroundColor
Represents background color.
Public property BackGroundColorObject
Represents background color.
Public property BackGroundKnownColor
Represents background excel color.
Public property BarTopType
Represents the top data format.
Public property BarType
Represents the base data format.
Public property Fill
Represents XlsFill options. Read-only.
Public property ForeGroundColor
Represents foreground color.
Public property ForeGroundColorObject
Represents foreground color object.
Public property ForeGroundKnownColor
Represents foreground color.
Public property Format3D
Gets the chart3 D properties.
Public property Has_dPtPieExplosion
Indicates whether dataformat has PieExplosion.
Public property HasBorder
Indicates whether chart has border.
Public property HasBorderLine
Indicates whethers chart has border line.
Public property HasFormat3D
Gets a value indicating whether [has3d properties].
Public property HasInterior
This property indicates whether interior object was created. Read-only.
Public property HasLineProperties
This property indicates whether line formatting object was created. Read-only.
Public property HasShadow
Gets a value indicating whether this instance has shadow properties.
Public property Interior
Returns object, that represents area properties. Read-only.
Public property Is3DBubbles
True to draw bubbles with 3D effects.
Public property IsAutoMarker
Automatic color.
Public property IsAutomaticFormat
Indicates, if automatic format is used.
Public property IsBorderSupported
Indicates whether border object is supported. Read-only.
Public property IsFormatted
Indicate if data format is formatted.
Public property IsInteriorSupported
Indicates whether interior object is supported. Read-only.
Public property IsMarker
If true - format has marker; otherwise false. Read-only.
Public property IsMarkerSupported
Indicates whether marker is supported by this chart/series.
Public property IsShadow Obsolete.
True if this series has a shadow.
Public property IsShowBackground
True = "background = none".
Public property IsShowForeground
True = "foreground = none".
Public property IsSmoothed
If true - format has smothed line; otherwise false. Read-only.
Public property IsSmoothedLine
True if the line series has a smoothed line.
Public property IsSupportFill
Indicats whether chart supports transparency.
Public property LineProperties
Returns object, that represents line properties. Read-only.
Public property MarkerBackColorObject
Gets object that holds marker background color.
Public property MarkerBackgroundColor
Foreground color: RGB value (high byte = 0).
Public property MarkerBackgroundKnownColor
Index to color of marker XlsFill.
Public property MarkerBorderWidth
Marker border weight(unit pt).
Public property Code example MarkerFill
Get fill object of the marker.
Examples

The following code illustrates how to fill a marker .

<para>var markerFill = chart.Series[0].Format.MarkerFill;</para><para>//fill by defined Texture</para><para>markerFill.Texture = GradientTextureType.GreenMarble;</para><para></para><para>//fill by defined Pattern</para><para>markerFill.Pattern = GradientPatternType.PatLargeCheckerBoard;</para><para>//Pattern need set fore/background color</para><para>markerFill.ForeColor = Color.Blue;</para><para>markerFill.BackColor = Color.Red;</para><para>//fill by a picture</para><para>markerFill.CustomPicture("type1.png")</para><para>//set transparency: value from 0.0 (Clear) through 1.0(Opaque)</para><para>markerFill.Transparency = 0.5;</para>
Public property MarkerForeColorObject
Gets object that holds marker foreground color.
Public property MarkerForegroundColor
Background color: RGB value (high byte = 0).
Public property MarkerForegroundKnownColor
Index to color of marker border.
Public property MarkerSize
Size of line markers.
Public property MarkerStyle
Type of marker.
Public property MarkerTransparencyValue
Gets or sets the transparency of the line marker.
Public property Options
Gets common serie options. Read-only.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property ParentSerie
Returns parent serie. Read-only.
Public property Pattern
Represents pattern.
Public property Percent
Distance of pie slice from center of pie.
Public property QuartileCalculationType
Gets / Sets whether the Quartile calculation is Exclusive or Inclusive
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property SeriesNumber Obsolete.
Gets or sets serie number.
Public property Shadow
Gets the shadow properties.
Public property ShowActiveValue Obsolete.
Indicates whether chart show active value.
Public property ShowBubble Obsolete.
Show bubble sizes.
Public property ShowCategoryLabel Obsolete.
Show category label.
Public property ShowConnectorLines
Gets or sets a boolean value indicating whether to display Connector Lines between data points
Public property ShowInnerPoints
Gets or sets a boolean value indicating whether to display Inner Points in Box and Whisker chart
Public property ShowMeanLine
Gets or sets a boolean value indicating whether to display Mean Line in Box and Whisker chart
Public property ShowMeanMarkers
Gets or sets a boolean value indicating whether to display Mean Marker in Box and Whisker chart
Public property ShowOutlierPoints
Gets or sets a boolean value indicating whether to display Outlier Points in Box and Whisker chart
Public property ShowPieCategoryLabel Obsolete.
Show category label and value as a percentage (pie charts only).
Public property ShowPieInPercents Obsolete.
Show value as a percent of the total.(pie charts only).
Public property SmoothLine Obsolete.
Show smoothed line.
Public property TreeMapLabelOption
Gets / Sets the Display label position in Tree map chart
Public property Visible
Represents visiblity.
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 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