Class ChartErrorBarsImpl
Represent error bars on the chart series.
Error bars indicate the degree of uncertainty for chart data. Only series in area, bar, column, line, and scatter groups on a 2-D chart can have error bars. Only series in scatter groups can have x and y error bars.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartErrorBarsImpl : CommonObject, IParentApplication, IDisposable, IChartErrorBars
Constructors
ChartErrorBarsImpl(IApplication, Object, Boolean)
Creates new instance of error bars implementation.
Declaration
public ChartErrorBarsImpl(IApplication application, object parent, bool bIsY)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object. |
System.Object | parent | Represents parent object. |
System.Boolean | bIsY | Indicates if it's Y axis bar. |
ChartErrorBarsImpl(IApplication, Object, IList<BiffRecordRaw>)
Parses new instance of error bars from stream.
Declaration
public ChartErrorBarsImpl(IApplication application, object parent, IList<BiffRecordRaw> data)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object. |
System.Object | parent | Represents parent object. |
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> | data | Represents data holder. |
Fields
DEF_NUMBER_X_VALUE
Represents default value for X error bar.
Declaration
public const int DEF_NUMBER_X_VALUE = 1
Field Value
Type |
---|
System.Int32 |
DEF_NUMBER_Y_VALUE
Represents default value for Y axis.
Declaration
public const int DEF_NUMBER_Y_VALUE = 10
Field Value
Type |
---|
System.Int32 |
Properties
Border
Gets the border for the drop bars. Read-only.
Declaration
public IChartBorder Border { get; }
Property Value
Type |
---|
IChartBorder |
Chart3DOptions
Gets the chart3D options. Read-only.
Declaration
public IThreeDFormat Chart3DOptions { get; }
Property Value
Type |
---|
IThreeDFormat |
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 |
HasCap
Gets or sets a boolean value indicating end style for the error bars.
Declaration
public bool HasCap { get; set; }
Property Value
Type |
---|
System.Boolean |
HasShadowProperties
This property indicates whether the shadow object has been created
Declaration
public bool HasShadowProperties { get; }
Property Value
Type |
---|
System.Boolean |
Include
Gets or sets the error bar include type.
Declaration
public ExcelErrorBarInclude Include { get; set; }
Property Value
Type |
---|
ExcelErrorBarInclude |
IsY
If true, error bar is on Y axis; otherwise - on X axis.
Declaration
public bool IsY { get; }
Property Value
Type |
---|
System.Boolean |
MinusRange
Gets or sets IRange object with negative error value for custom error bar.
Declaration
public IRange MinusRange { get; set; }
Property Value
Type |
---|
IRange |
NumberValue
Gets or sets the number value for applicable ExcelErrorBarType.
Declaration
public double NumberValue { get; set; }
Property Value
Type |
---|
System.Double |
PlusRange
Gets or sets IRange object with positive error value for custom error bar.
Declaration
public IRange PlusRange { get; set; }
Property Value
Type |
---|
IRange |
Shadow
Gets the IShadow object. Read-only.
Declaration
public IShadow Shadow { get; }
Property Value
Type |
---|
IShadow |
Type
Gets or sets the error bar type.
Declaration
public ExcelErrorBarType Type { get; set; }
Property Value
Type |
---|
ExcelErrorBarType |
Methods
ClearFormats()
Clears the formats of the error bars.
Declaration
public void ClearFormats()
Clone(Object, Dictionary<String, String>)
Clones current object.
Declaration
public ChartErrorBarsImpl Clone(object parent, Dictionary<string, string> hashNewNames)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Represents parent object for new cloned instance. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Represents new names. |
Returns
Type | Description |
---|---|
ChartErrorBarsImpl | Returns cloned object. |
Delete()
Deletes the error bars.
Declaration
public void Delete()
MarkUsedReferences(Boolean[])
Sets items with used reference indexes to true.
Declaration
public void MarkUsedReferences(bool[] usedItems)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean[] | usedItems | Array to mark used references in. |
Serialize(IList<IBiffStorage>)
Serializes records to biff stream
Declaration
public void Serialize(IList<IBiffStorage> records)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IBiffStorage> | records | Represents record holder. |
SerializeDataFormatRecords(IList<IBiffStorage>, ChartBorderImpl, Int32, Int32, ChartMarkerFormatRecord)
Serialize data format records.
Declaration
public static void SerializeDataFormatRecords(IList<IBiffStorage> records, ChartBorderImpl border, int iSerieIndex, int iIndex, ChartMarkerFormatRecord marker)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IBiffStorage> | records | Represents record holder. |
ChartBorderImpl | border | Represents border object. |
System.Int32 | iSerieIndex | Represents Series index. |
System.Int32 | iIndex | Represents Series indexes. |
ChartMarkerFormatRecord | marker |
SerializeSerieRecord(IList<IBiffStorage>, Int32)
Serialize Series record.
Declaration
public static void SerializeSerieRecord(IList<IBiffStorage> records, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IBiffStorage> | records | Represents record holder. |
System.Int32 | count | Values number. |
UpdateReferenceIndexes(Int32[])
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | arrUpdatedIndexes | Array with updated indexes. |