Class ChartFormatImpl
Provides access to the formatting options for chart elements.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartFormatImpl : CommonObject, IParentApplication, IDisposable, IChartFormat, ICloneParent
Constructors
ChartFormatImpl(IApplication, Object)
Create new instance.
Declaration
public ChartFormatImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object. |
Fields
DEF_BAR_STACKED
Id for bar stacked chart type.
Declaration
public const int DEF_BAR_STACKED = -65436
Field Value
Type |
---|
System.Int32 |
Properties
AutoScaling
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart..
Declaration
public bool AutoScaling { get; set; }
Property Value
Type |
---|
System.Boolean |
BubbleScale
Gets or sets the scale factor for bubbles. Can be an integer value from 0 to 300, corresponding to a percentage of the default size.
Declaration
public int BubbleScale { get; set; }
Property Value
Type |
---|
System.Int32 |
DataFormatOrNull
Returns dataformat or null; Read-only.
Declaration
public ChartSerieDataFormatImpl DataFormatOrNull { get; }
Property Value
Type |
---|
ChartSerieDataFormatImpl |
Delimiter
Represents delimiter.
Declaration
public string Delimiter { get; set; }
Property Value
Type |
---|
System.String |
DelimiterLength
Returns delimiter length.
Declaration
public int DelimiterLength { get; }
Property Value
Type |
---|
System.Int32 |
DepthPercent
Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
Declaration
public int DepthPercent { get; set; }
Property Value
Type |
---|
System.Int32 |
DoughnutHoleSize
Gets or sets the size of the hole in a dough-nut chart. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
Declaration
public int DoughnutHoleSize { get; set; }
Property Value
Type |
---|
System.Int32 |
DrawingZOrder
Drawing order (0 = bottom of the z-order).
Declaration
public int DrawingZOrder { get; set; }
Property Value
Type |
---|
System.Int32 |
DropLines
Represents Drop lines of Stock, Line and Area Charts. Read-only.
Declaration
public IChartBorder DropLines { get; }
Property Value
Type |
---|
IChartBorder |
DropLineStyle
Gets or sets drop lines or hi-low lines or series lines: 0 = drop lines 1 = hi-low lines 2 = series lines (lines used in Pie of Pie and Bar of Pie charts)
Declaration
public ExcelDropLineStyle DropLineStyle { get; set; }
Property Value
Type |
---|
ExcelDropLineStyle |
Elevation
Returns or sets the elevation of the 3-D chart view, in degrees (-90 to +90 degrees).
Declaration
public int Elevation { get; set; }
Property Value
Type |
---|
System.Int32 |
FirstDropBar
Gets the up bars on the line chart. Read-only.
Declaration
public IChartDropBar FirstDropBar { get; }
Property Value
Type |
---|
IChartDropBar |
Remarks
Up bars connect points on series one with higher values on the last series in the chart group (the lines go up from series one). Only 2-D line groups that contain at least two series can have up bars. This object isnt a collection. There's no object that represents a single up bar; you either have up bars turned on for all points in a chart group or you have them turned off.
FirstSliceAngle
Declaration
public int FirstSliceAngle { get; set; }
Property Value
Type |
---|
System.Int32 |
FormatRecordType
Represents type code of major format record type. Read-only.
Declaration
public TBIFFRecord FormatRecordType { get; }
Property Value
Type |
---|
TBIFFRecord |
Gap
Space between the first pie and the second.
Declaration
public int Gap { get; set; }
Property Value
Type |
---|
System.Int32 |
GapDepth
Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )
Declaration
public int GapDepth { get; set; }
Property Value
Type |
---|
System.Int32 |
GapWidth
Declaration
public int GapWidth { get; set; }
Property Value
Type |
---|
System.Int32 |
HasDropLines
True if stock, line or area charts has drop lines
Declaration
public bool HasDropLines { get; set; }
Property Value
Type |
---|
System.Boolean |
HasHighLowLines
True if stock or line charts has high-low lines
Declaration
public bool HasHighLowLines { get; set; }
Property Value
Type |
---|
System.Boolean |
HasRadarAxisLabels
True if a radar chart has axis labels. otherwise False. Applies only to radar charts.
Declaration
public bool HasRadarAxisLabels { get; set; }
Property Value
Type |
---|
System.Boolean |
HasSeriesLines
True if pie of pie or bar of pie charts has series lines
Declaration
public bool HasSeriesLines { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowBar
True if this bar has a shadow; otherwise False.
Declaration
public bool HasShadowBar { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowBoppop
1 = the second pie / bar has a shadow.
Declaration
public bool HasShadowBoppop { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowLine
True if this line has a shadow.
Declaration
public bool HasShadowLine { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowPie
True if this pie has a shadow.
Declaration
public bool HasShadowPie { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowRadar
True if this radar series has a shadow.
Declaration
public bool HasShadowRadar { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowScatter
True if bubble series has a shadow.
Declaration
public bool HasShadowScatter { get; set; }
Property Value
Type |
---|
System.Boolean |
HeightPercent
Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
Declaration
public int HeightPercent { get; set; }
Property Value
Type |
---|
System.Int32 |
HighLowLines
Represents High-low lines of Stock and Line Charts. Read-only.
Declaration
public IChartBorder HighLowLines { get; }
Property Value
Type |
---|
IChartBorder |
Is3D
If true - Series 3D; otherwise Series 2D. Read-only.
Declaration
public bool Is3D { get; }
Property Value
Type |
---|
System.Boolean |
Is3DPhongShade
True if this surface chart has shading.
Declaration
public bool Is3DPhongShade { get; set; }
Property Value
Type |
---|
System.Boolean |
IsAreaShadowed
This area has a shadow.
Declaration
public bool IsAreaShadowed { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBubbles
True if this a bubble series.
Declaration
public bool IsBubbles { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBubbleSize
If true bubble has size.
Declaration
public bool IsBubbleSize { get; set; }
Property Value
Type |
---|
System.Boolean |
IsCategoryBrokenDown
Each category is broken down as a percentage.
Declaration
public bool IsCategoryBrokenDown { get; set; }
Property Value
Type |
---|
System.Boolean |
IsCategoryName
If true category has name.
Declaration
public bool IsCategoryName { get; set; }
Property Value
Type |
---|
System.Boolean |
IsChartChartLine
If true - format contains chart chart line record. Read-only.
Declaration
public bool IsChartChartLine { get; }
Property Value
Type |
---|
System.Boolean |
IsChartLineFormat
If true - format contains line. Read-only.
Declaration
public bool IsChartLineFormat { get; }
Property Value
Type |
---|
System.Boolean |
IsClustered
3D columns are clustered or stacked.
Declaration
public bool IsClustered { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDefaultElevation
Indicates whether elevation has default value.
Declaration
public bool IsDefaultElevation { get; }
Property Value
Type |
---|
System.Boolean |
IsDefaultRotation
Indicates whether rotation has default value.
Declaration
public bool IsDefaultRotation { get; }
Property Value
Type |
---|
System.Boolean |
IsDropBar
If true - format contains drop bar record. Read-only.
Declaration
public bool IsDropBar { get; }
Property Value
Type |
---|
System.Boolean |
IsFillSurface
True if chart contains color fill for surface.
Declaration
public bool IsFillSurface { get; set; }
Property Value
Type |
---|
System.Boolean |
IsHorizontalBar
True for horizontal bars (bar chart). False for vertical bars (column chart).
Declaration
public bool IsHorizontalBar { get; set; }
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 |
IsPercentage
If true has percentage.
Declaration
public bool IsPercentage { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPrimaryAxis
If true then belong to primary axis; otherwise to secondary axis.
Declaration
public bool IsPrimaryAxis { get; }
Property Value
Type |
---|
System.Boolean |
IsSeriesName
If true Series has name.
Declaration
public bool IsSeriesName { 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 |
IsStacked
Series in this group are stacked.
Declaration
public bool IsStacked { get; set; }
Property Value
Type |
---|
System.Boolean |
IsValue
If true has value.
Declaration
public bool IsValue { get; set; }
Property Value
Type |
---|
System.Boolean |
IsVaryColor
Gets or sets a boolean value indicating whether to vary color for each data point.
Declaration
public bool IsVaryColor { get; set; }
Property Value
Type |
---|
System.Boolean |
IsVeryColor
Gets or sets a boolean value indicating whether to vary color for each data point.
Declaration
public bool IsVeryColor { get; set; }
Property Value
Type |
---|
System.Boolean |
LineStyle
Gets or sets drop lines or hi-low lines or series lines: 0 = drop lines 1 = hi-low lines 2 = series lines (lines used in Pie of Pie and Bar of Pie charts)
Declaration
public ExcelDropLineStyle LineStyle { get; set; }
Property Value
Type |
---|
ExcelDropLineStyle |
NumSplitValue
For split = 1, what values should go to the other pie / bar.
Declaration
public int NumSplitValue { get; set; }
Property Value
Type |
---|
System.Int32 |
Overlap
Gets or sets the space between the bars/columns. Can be a value between -100 and 100.
Declaration
public int Overlap { get; set; }
Property Value
Type |
---|
System.Int32 |
Remarks
Applies only to 2-D bar and 2-D column charts.
Perspective
Returns or sets the perspective for the 3-D chart view.( 0 - 100 )
Declaration
public int Perspective { get; set; }
Property Value
Type |
---|
System.Int32 |
PieChartType
0 = normal pie chart 1 = pie of pie chart 2 = bar of pie chart
Declaration
public ExcelPieType PieChartType { get; set; }
Property Value
Type |
---|
ExcelPieType |
PieSecondSize
Gets 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 ).
Declaration
public int PieSecondSize { get; set; }
Property Value
Type |
---|
System.Int32 |
PieSeriesLine
Gets the series line properties for pie of pie or pie of bar charts. Read-only.
Declaration
public IChartBorder PieSeriesLine { get; }
Property Value
Type |
---|
IChartBorder |
RightAngleAxes
True if the chart axes are at right angles, independent of chart rotation or elevation.
Declaration
public bool RightAngleAxes { get; set; }
Property Value
Type |
---|
System.Boolean |
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).
Declaration
public int Rotation { get; set; }
Property Value
Type |
---|
System.Int32 |
SecondDropBar
Gets the down bars on the line chart. Read-only.
Declaration
public IChartDropBar SecondDropBar { get; }
Property Value
Type |
---|
IChartDropBar |
Remarks
Down bars connect points on the first series in the chart group with lower values on the last series (the lines go down from the first series). Only 2-D line groups that contain at least two series can have down bars. This object isnt a collection. There's no object that represents a single down bar; you either have up bars and down bars turned on for all points in a chart group or you have them turned off.
SerieDataFormat
Returns data format. Read-only.
Declaration
public IChartSerieDataFormat SerieDataFormat { get; }
Property Value
Type |
---|
IChartSerieDataFormat |
SerieFormat
Returns record that represents Series format. Read-only.
Declaration
public BiffRecordRaw SerieFormat { get; }
Property Value
Type |
---|
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw |
ShowAsPercentsBar
Each category is displayed as a percentage.
Declaration
public bool ShowAsPercentsBar { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowAsPercentsLine
Each category is broken down as a percentage.
Declaration
public bool ShowAsPercentsLine { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowLeaderLines
True to show leader lines to data labels.
Declaration
public bool ShowLeaderLines { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowNegativeBubbles
True to show negative bubbles on bubble chart. otherwise False.
Declaration
public bool ShowNegativeBubbles { get; set; }
Property Value
Type |
---|
System.Boolean |
SizeRepresents
Gets or sets a value indicating what the bubble size represents on a bubble chart.
Declaration
public ExcelBubbleSize SizeRepresents { get; set; }
Property Value
Type |
---|
ExcelBubbleSize |
SplitPercent
For split = 2, what percentage should go to the other pie / bar.
Declaration
public int SplitPercent { get; set; }
Property Value
Type |
---|
System.Int32 |
SplitType
Gets or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.
Declaration
public ExcelSplitType SplitType { get; set; }
Property Value
Type |
---|
ExcelSplitType |
SplitValue
Gets or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
Declaration
public int SplitValue { get; set; }
Property Value
Type |
---|
System.Int32 |
StackValuesBar
Stack the displayed values.
Declaration
public bool StackValuesBar { get; set; }
Property Value
Type |
---|
System.Boolean |
StackValuesLine
Stack the displayed values.
Declaration
public bool StackValuesLine { get; set; }
Property Value
Type |
---|
System.Boolean |
UseDefaultSplitValue
True to use default split value; otherwise False.
Declaration
public bool UseDefaultSplitValue { get; set; }
Property Value
Type |
---|
System.Boolean |
WallsAndGridlines2D
True if gridlines are drawn two-dimensionally on a 3-D chart.
Declaration
public bool WallsAndGridlines2D { get; set; }
Property Value
Type |
---|
System.Boolean |
Methods
ChangeChartStockHigh_Low_CloseType()
Changes type for stock high low close type.
Declaration
public void ChangeChartStockHigh_Low_CloseType()
ChangeChartStockOpen_High_Low_CloseType()
Changes type for stock open high low close type.
Declaration
public void ChangeChartStockOpen_High_Low_CloseType()
ChangeChartStockVolume_High_Low_CloseTypeFirst()
Change type for stock volume high low close type in primary axis.
Declaration
public void ChangeChartStockVolume_High_Low_CloseTypeFirst()
ChangeChartStockVolume_High_Low_CloseTypeSecond()
Change type for stock volume high low close type in secondary axis.
Declaration
public void ChangeChartStockVolume_High_Low_CloseTypeSecond()
ChangeChartStockVolume_Open_High_Low_CloseType()
Change type for stock volume open high low close type.
Declaration
public void ChangeChartStockVolume_Open_High_Low_CloseType()
ChangeChartType(ExcelChartType, Boolean)
Changed chart type.
Declaration
public void ChangeChartType(ExcelChartType type, bool isSeriesCreation)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to change. |
System.Boolean | isSeriesCreation | Indicates whether we are in the process of series creation. |
ChangeSerieType(ExcelChartType, Boolean)
Changes Series type.
Declaration
public void ChangeSerieType(ExcelChartType type, bool isSeriesCreation)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to change. |
System.Boolean | isSeriesCreation | Indicates whether we are in the process of series creation. |
Clone(Object)
Clones current object.
Declaration
public object Clone(object parent)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object for clone. |
Returns
Type | Description |
---|---|
System.Object | Returns just cloned object. |
GetStartSerieType(ExcelChartType)
Gets start Series type.
Declaration
public static string GetStartSerieType(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to extract. |
Returns
Type | Description |
---|---|
System.String | Returns start Series type. |
Parse(IList<BiffRecordRaw>, ref Int32)
Parsing chart chart format.
Declaration
public void Parse(IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> | data | Records offset. |
System.Int32 | iPos | Position in offset. |
Serialize(OffsetArrayList)
Serialize current object.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | Records offset. |
SetParents()
Finds parent objects.
Declaration
public void SetParents()
Operators
Equality(ChartFormatImpl, ChartFormatImpl)
Equal operator for two chart formats.
Declaration
public static bool operator ==(ChartFormatImpl format1, ChartFormatImpl format2)
Parameters
Type | Name | Description |
---|---|---|
ChartFormatImpl | format1 | |
ChartFormatImpl | format2 |
Returns
Type |
---|
System.Boolean |
Inequality(ChartFormatImpl, ChartFormatImpl)
Not Equal operator for two chart formats.
Declaration
public static bool operator !=(ChartFormatImpl format1, ChartFormatImpl format2)
Parameters
Type | Name | Description |
---|---|---|
ChartFormatImpl | format1 | |
ChartFormatImpl | format2 |
Returns
Type |
---|
System.Boolean |