Class ChartSerieDataFormatImpl
ChartSerieDataFormatImpl class.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartSerieDataFormatImpl : CommonObject, IParentApplication, IDisposable, IChartSerieDataFormat, IChartFillBorder, IFillColor
Constructors
ChartSerieDataFormatImpl(IApplication, Object)
Creates series and set its Application and Parent properties to specified values.
Declaration
public ChartSerieDataFormatImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the chart. |
System.Object | parent | Parent object for the chart. |
Fields
DEF_LINE_START_TYPE
Represents start line type.
Declaration
public const string DEF_LINE_START_TYPE = "Line"
Field Value
Type |
---|
System.String |
DEF_MARKER_START_COLOR
Represents start color.
Declaration
public const int DEF_MARKER_START_COLOR = 24
Field Value
Type |
---|
System.Int32 |
DEF_SCATTER_START_TYPE
Represents start scatter type.
Declaration
public const string DEF_SCATTER_START_TYPE = "Scatter"
Field Value
Type |
---|
System.String |
DEF_SUPPORT_DATAFORMAT_PROPERTIES
Represents types of chart that support data format properties.
Declaration
public static ExcelChartType[] DEF_SUPPORT_DATAFORMAT_PROPERTIES
Field Value
Type |
---|
ExcelChartType[] |
Properties
AreaProperties
Returns object, that represents area properties. Read-only.
Declaration
public IChartInterior AreaProperties { get; }
Property Value
Type |
---|
IChartInterior |
AttachedLabel
Returns attached label record. Read-only.
Declaration
public ChartAttachedLabelRecord AttachedLabel { get; }
Property Value
Type |
---|
ChartAttachedLabelRecord |
AttachedLabelLayout
Return attached label layout record. Read-only
Declaration
public ChartAttachedLabelLayoutRecord AttachedLabelLayout { get; }
Property Value
Type |
---|
ChartAttachedLabelLayoutRecord |
BackGroundColorObject
Represents background color.
Declaration
public ColorObject BackGroundColorObject { get; }
Property Value
Type |
---|
ColorObject |
BarShapeBase
Represents the base data format.
Declaration
public ExcelBaseFormat BarShapeBase { get; set; }
Property Value
Type |
---|
ExcelBaseFormat |
BarShapeTop
Represents the top data format.
Declaration
public ExcelTopFormat BarShapeTop { get; set; }
Property Value
Type |
---|
ExcelTopFormat |
CommonSerieOptions
Gets common Series options. Read-only.
Declaration
public IChartFormat CommonSerieOptions { get; }
Property Value
Type |
---|
IChartFormat |
ContainsLineProperties
If line not null - returns true; otherwise - false. Read-only.
Declaration
public bool ContainsLineProperties { get; }
Property Value
Type |
---|
System.Boolean |
DataFormat
Returns data format main record.
Declaration
public ChartDataFormatRecord DataFormat { get; set; }
Property Value
Type |
---|
ChartDataFormatRecord |
Fill
Represents fill options. Read-only.
Declaration
public IFill Fill { get; }
Property Value
Type |
---|
IFill |
ForeGroundColorObject
Represents foreground color.
Declaration
public ColorObject ForeGroundColorObject { get; }
Property Value
Type |
---|
ColorObject |
Has3dProperties
This property Indicates whether the Shadow object has been created(which includes the 3D properties)
Declaration
public bool Has3dProperties { get; }
Property Value
Type |
---|
System.Boolean |
HasInterior
Gets/sets value indicating whether interior object was created.
Declaration
public bool HasInterior { get; }
Property Value
Type |
---|
System.Boolean |
HasLineProperties
Gets/sets value indicating whether line properties are created.
Declaration
public bool HasLineProperties { get; }
Property Value
Type |
---|
System.Boolean |
HasShadowProperties
Gets a value indicating whether this instance has shadow properties.
Declaration
public bool HasShadowProperties { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Interior
Returns object, that represents area properties. Read-only.
Declaration
public IChartInterior Interior { get; }
Property Value
Type |
---|
IChartInterior |
Is3DBubbles
True to draw bubbles with 3D effects.
Declaration
public bool Is3DBubbles { get; set; }
Property Value
Type |
---|
System.Boolean |
IsArShadow
True if this series has a shadow.
Declaration
public bool IsArShadow { get; set; }
Property Value
Type |
---|
System.Boolean |
IsAutoMarker
Automatic color.
Declaration
public bool IsAutoMarker { get; set; }
Property Value
Type |
---|
System.Boolean |
IsAutomaticFormat
Indicates, if automatic format is used for area.
Declaration
public bool IsAutomaticFormat { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBorderSupported
Indicates whether border object is supported. Read-only.
Declaration
public bool IsBorderSupported { get; }
Property Value
Type |
---|
System.Boolean |
IsFormatted
Indicate if data format is formatted.
Declaration
public bool IsFormatted { get; }
Property Value
Type |
---|
System.Boolean |
IsInteriorSupported
Indicates whether interior object is supported. Read-only.
Declaration
public bool IsInteriorSupported { get; }
Property Value
Type |
---|
System.Boolean |
IsLine
If true - format has line; otherwise false. Read-only.
Declaration
public bool IsLine { get; }
Property Value
Type |
---|
System.Boolean |
IsMarker
If true - format has marker; otherwise false. Read-only.
Declaration
public bool IsMarker { get; }
Property Value
Type |
---|
System.Boolean |
IsMarkerSupported
Indicates whether marker is supported by this chart/series.
Declaration
public bool IsMarkerSupported { get; }
Property Value
Type |
---|
System.Boolean |
IsNotShowBrd
True = "foreground = none".
Declaration
public bool IsNotShowBrd { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNotShowInt
True = "background = none".
Declaration
public bool IsNotShowInt { get; set; }
Property Value
Type |
---|
System.Boolean |
IsSmoothed
If true - format has smoothed line; otherwise false. Read-only.
Declaration
public bool IsSmoothed { get; }
Property Value
Type |
---|
System.Boolean |
IsSmoothedLine
True if the line series has a smoothed line.
Declaration
public bool IsSmoothedLine { get; set; }
Property Value
Type |
---|
System.Boolean |
IsSupportFill
Gets value indicating whether chart supports transparency.
Declaration
public bool IsSupportFill { get; }
Property Value
Type |
---|
System.Boolean |
LineProperties
Returns object, that represents line properties. Read-only.
Declaration
public IChartBorder LineProperties { get; }
Property Value
Type |
---|
IChartBorder |
MarkerBackColorObject
Gets object that holds marker background color.
Declaration
public ColorObject MarkerBackColorObject { get; }
Property Value
Type |
---|
ColorObject |
MarkerBackgroundColor
Foreground color: RGB value (high byte = 0).
Declaration
public Color MarkerBackgroundColor { get; set; }
Property Value
Type |
---|
Windows.UI.Color |
MarkerBackgroundColorIndex
Index to color of marker fill.
Declaration
public ExcelKnownColors MarkerBackgroundColorIndex { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
MarkerForeColorObject
Gets object that holds marker foreground color.
Declaration
public ColorObject MarkerForeColorObject { get; }
Property Value
Type |
---|
ColorObject |
MarkerForegroundColor
Background color: RGB value (high byte = 0).
Declaration
public Color MarkerForegroundColor { get; set; }
Property Value
Type |
---|
Windows.UI.Color |
MarkerForegroundColorIndex
Index to color of marker border.
Declaration
public ExcelKnownColors MarkerForegroundColorIndex { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
MarkerFormat
Returns marker format main record. Read-only.
Declaration
public ChartMarkerFormatRecord MarkerFormat { get; }
Property Value
Type |
---|
ChartMarkerFormatRecord |
MarkerFormatOrNull
If marker is not null returns marker format main record otherwise null. Read-only.
Declaration
public ChartMarkerFormatRecord MarkerFormatOrNull { get; }
Property Value
Type |
---|
ChartMarkerFormatRecord |
MarkerLineStream
Gets or sets the marker line stream.
Declaration
public Stream MarkerLineStream { get; set; }
Property Value
Type |
---|
System.IO.Stream |
MarkerSize
Size of markers.
Declaration
public int MarkerSize { get; set; }
Property Value
Type |
---|
System.Int32 |
MarkerStyle
Type of marker.
Declaration
public ExcelChartMarkerType MarkerStyle { get; set; }
Property Value
Type |
---|
ExcelChartMarkerType |
MarkerTransparency
Gets or sets the transparency of the line marker.
Declaration
public double MarkerTransparency { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The transparency. |
ParentChart
Represents parent chart. Read-only.
Declaration
public ChartImpl ParentChart { get; }
Property Value
Type |
---|
ChartImpl |
ParentSerie
Returns parent Series. Read-only.
Declaration
public ChartSerieImpl ParentSerie { get; }
Property Value
Type |
---|
ChartSerieImpl |
Pattern
Represents pattern.
Declaration
public ExcelPattern Pattern { get; set; }
Property Value
Type |
---|
ExcelPattern |
Percent
Distance of pie slice from center of pie.
Declaration
public int Percent { get; set; }
Property Value
Type |
---|
System.Int32 |
PieFormat
Returns pie format record. Read-only.
Declaration
public ChartPieFormatRecord PieFormat { get; }
Property Value
Type |
---|
ChartPieFormatRecord |
PieFormatOrNull
Returns pie format or null. Read-only.
Declaration
public ChartPieFormatRecord PieFormatOrNull { get; }
Property Value
Type |
---|
ChartPieFormatRecord |
QuartileCalculationType
Gets / Sets whether the Quartile calculation is Exclusive or Inclusive
Declaration
public ExcelQuartileCalculation QuartileCalculationType { get; set; }
Property Value
Type |
---|
ExcelQuartileCalculation |
Remarks
Applies only to Box and Whisker Charts
Serie3DDataFormat
Returns 3dData format main record. Read-only.
Declaration
public Chart3DDataFormatRecord Serie3DDataFormat { get; }
Property Value
Type |
---|
Chart3DDataFormatRecord |
Serie3DdDataFormatOrNull
If 3dData not Null returns 3DData format main record; otherwise - returns null. Read-only.
Declaration
public Chart3DDataFormatRecord Serie3DdDataFormatOrNull { get; }
Property Value
Type |
---|
Chart3DDataFormatRecord |
SerieFormat
Returns Series format main record. Read-only.
Declaration
public ChartSerFmtRecord SerieFormat { get; }
Property Value
Type |
---|
ChartSerFmtRecord |
SerieFormatOrNull
if SerieFormat not Null returns Series format main record; otherwise - returns null. Read-only.
Declaration
public ChartSerFmtRecord SerieFormatOrNull { get; }
Property Value
Type |
---|
ChartSerFmtRecord |
SeriesNumber
Gets or sets Series number.
Declaration
public int SeriesNumber { get; set; }
Property Value
Type |
---|
System.Int32 |
Shadow
Gets the shadow.
Declaration
public IShadow Shadow { get; }
Property Value
Type |
---|
IShadow |
ShowActiveValue
Gets or sets value indicating whether to show label active value.
Declaration
public bool ShowActiveValue { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowBubble
Show bubble sizes.
Declaration
public bool ShowBubble { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowCategoryLabel
Show category label.
Declaration
public bool ShowCategoryLabel { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowConnectorLines
Gets or sets a boolean value indicating whether to display Connector Lines between data points
Declaration
public bool ShowConnectorLines { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Applies only to Waterfall Charts
ShowInnerPoints
Gets or sets a boolean value indicating whether to display Inner Points in Box and Whisker chart
Declaration
public bool ShowInnerPoints { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowMeanLine
Gets or sets a boolean value indicating whether to display Mean Line in Box and Whisker chart
Declaration
public bool ShowMeanLine { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowMeanMarkers
Gets or sets a boolean value indicating whether to display Mean Marker in Box and Whisker chart
Declaration
public bool ShowMeanMarkers { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowOutlierPoints
Gets or sets a boolean value indicating whether to display Outlier Points in Box and Whisker chart
Declaration
public bool ShowOutlierPoints { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowPieCategoryLabel
Show category label and value as a percentage (pie charts only).
Declaration
public bool ShowPieCategoryLabel { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowPieInPercents
Show value as a percent of the total. This bit applies only to pie charts.
Declaration
public bool ShowPieInPercents { get; set; }
Property Value
Type |
---|
System.Boolean |
SmoothLine
Show smoothed line.
Declaration
public bool SmoothLine { get; set; }
Property Value
Type |
---|
System.Boolean |
ThreeD
Gets the chart3 D options.
Declaration
public IThreeDFormat ThreeD { get; }
Property Value
Type | Description |
---|---|
IThreeDFormat | The chart3 D options. |
TreeMapLabelOption
Gets / Sets the Display label position in Tree map chart
Declaration
public ExcelTreeMapLabelOption TreeMapLabelOption { get; set; }
Property Value
Type |
---|
ExcelTreeMapLabelOption |
Remarks
By Default the Label is overlapped
Visible
Represents visibility.
Declaration
public bool Visible { get; set; }
Property Value
Type |
---|
System.Boolean |
Methods
ChangeLineDataFormat(ExcelChartType)
Changes data format to create line chart.
Declaration
public void ChangeLineDataFormat(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to change. |
ChangeRadarDataFormat(ExcelChartType)
Changes data format to create radar chart.
Declaration
public void ChangeRadarDataFormat(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to change. |
ChangeScatterDataFormat(ExcelChartType)
Changes data format to create scatter chart.
Declaration
public void ChangeScatterDataFormat(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to change. |
ClearOnPropertyChange()
Clears sub data formats on property change.
Declaration
public void ClearOnPropertyChange()
Clone(Object)
Clone current instance.
Declaration
public ChartSerieDataFormatImpl Clone(object parent)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object. |
Returns
Type | Description |
---|---|
ChartSerieDataFormatImpl | Return cloned object. |
OnDispose()
Declaration
protected override void OnDispose()
Overrides
Parse(IList<BiffRecordRaw>, Int32)
Parses data format.
Declaration
public int Parse(IList<BiffRecordRaw> arrData, int iPos)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> | arrData | Array with data format records. |
System.Int32 | iPos | Position of the first data format record. |
Returns
Type | Description |
---|---|
System.Int32 | Position after the last data format record. |
Serialize(OffsetArrayList)
Serializes data format.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | Represents record list to serialize into. |
SetDefaultValues()
Sets default values.
Declaration
public void SetDefaultValues()
UpdateColor(ChartSerieImpl, ChartDataPointImpl)
Updates color for line, markers and series.
Declaration
public static int UpdateColor(ChartSerieImpl serie, ChartDataPointImpl dataPoint)
Parameters
Type | Name | Description |
---|---|---|
ChartSerieImpl | serie | Represents series to update color. |
ChartDataPointImpl | dataPoint | Represents data point to update color. |
Returns
Type | Description |
---|---|
System.Int32 | Returns updated color index. |
UpdateDataFormatInDataPoint()
Updates data format in data points.
Declaration
public void UpdateDataFormatInDataPoint()
UpdateLineColor()
Updates line color for line, radar, skater Series data format.
Declaration
public int UpdateLineColor()
Returns
Type | Description |
---|---|
System.Int32 | Returns updated color index or -1. |
UpdateSerieFormat()
Updates series formats for chartformat object.
Declaration
public void UpdateSerieFormat()
UpdateSerieIndex()
Updates Series index.
Declaration
public void UpdateSerieIndex()