Class ChartSeriesCollection
ChartSeriesCollection - collection of the chart series.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartSeriesCollection : CollectionBaseEx<IChartSerie>, IChartSeries, IParentApplication, ICollection<IChartSerie>, IEnumerable<IChartSerie>, IEnumerable, ICloneParent, IList<IChartSerie>
Constructors
ChartSeriesCollection(IApplication, Object)
Creates collection.
Declaration
public ChartSeriesCollection(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the collection. |
System.Object | parent | Parent object for the collection. |
Fields
DEF_START_SERIE_NAME
Start of the default series name.
Declaration
public const string DEF_START_SERIE_NAME = "Serie"
Field Value
Type |
---|
System.String |
Properties
Item[Int32]
Returns a single Name object from a Names collection.
Declaration
public IChartSerie this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
IChartSerie |
Item[String]
Returns a single Name object from a Names collection.
Declaration
public IChartSerie this[string name] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.String | name |
Property Value
Type |
---|
IChartSerie |
Methods
Add()
Defines a new series.
Declaration
public IChartSerie Add()
Returns
Type | Description |
---|---|
IChartSerie | Returns a Series object. |
Add(ExcelChartType)
Defines a new series. Returns a Series object.
Declaration
public IChartSerie Add(ExcelChartType serieType)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | serieType | Type of new series. |
Returns
Type | Description |
---|---|
IChartSerie | Newly created series object. |
Add(ChartSerieImpl)
Adds series to the collection.
Declaration
public IChartSerie Add(ChartSerieImpl serieToAdd)
Parameters
Type | Name | Description |
---|---|---|
ChartSerieImpl | serieToAdd | Series that should be added to the collection. |
Returns
Type | Description |
---|---|
IChartSerie | Series that was added. |
Add(String)
Defines a new series. Returns a Series object.
Declaration
public IChartSerie Add(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the new series. |
Returns
Type | Description |
---|---|
IChartSerie | Newly created series object. |
Add(String, ExcelChartType)
Defines a new series. Returns a Series object.
Declaration
public IChartSerie Add(string name, ExcelChartType serieType)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the new series. |
ExcelChartType | serieType | Type of new series. |
Returns
Type | Description |
---|---|
IChartSerie | Newly created series object. |
AssignTrendDataLabel(ChartTextAreaImpl)
Assign trend data label.
Declaration
public void AssignTrendDataLabel(ChartTextAreaImpl area)
Parameters
Type | Name | Description |
---|---|---|
ChartTextAreaImpl | area | Represents data label. |
ClearDataFormats(ChartSerieDataFormatImpl)
Clears all series data formats.
Declaration
public void ClearDataFormats(ChartSerieDataFormatImpl format)
Parameters
Type | Name | Description |
---|---|---|
ChartSerieDataFormatImpl | format | Represents format to update. |
ClearSeriesForChangeChartType()
Sets for default all series in chart.
Declaration
public void ClearSeriesForChangeChartType()
Clone(Object)
Clone current instance.
Declaration
public override object Clone(object parent)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object. |
Returns
Type | Description |
---|---|
System.Object | Returns cloned instance. |
Overrides
Clone(Object, Dictionary<String, String>, Dictionary<Int32, Int32>)
Clone current instance.
Declaration
public ChartSeriesCollection Clone(object parent, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Hash table with new Worksheet names. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
Returns
Type | Description |
---|---|
ChartSeriesCollection | Returns cloned instance. |
FindOrderByType(ExcelChartType)
Finds order by series type.
Declaration
public int FindOrderByType(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Type to find. |
Returns
Type | Description |
---|---|
System.Int32 | Returns order. |
GetCountOfSeriesWithSameDrawingOrder(Int32)
Gets count of series that has same chart group index.
Declaration
public int GetCountOfSeriesWithSameDrawingOrder(int order)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | order | Parameter to check. |
Returns
Type | Description |
---|---|
System.Int32 | Returns count of found series. |
GetCountOfSeriesWithSameStartType(ExcelChartType)
Gets count of series with same type in collection.
Declaration
public int GetCountOfSeriesWithSameStartType(ExcelChartType type)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Current type. |
Returns
Type | Description |
---|---|
System.Int32 | Returns count of same start types. |
GetCountOfSeriesWithSameType(ExcelChartType, Boolean)
Gets count of series with same type in collection.
Declaration
public int GetCountOfSeriesWithSameType(ExcelChartType type, bool usePrimaryAxis)
Parameters
Type | Name | Description |
---|---|---|
ExcelChartType | type | Current type. |
System.Boolean | usePrimaryAxis |
Returns
Type | Description |
---|---|
System.Int32 | Returns count of same types. |
GetDefSerieName()
Gets default series name.
Declaration
public string GetDefSerieName()
Returns
Type | Description |
---|---|
System.String | Returns default series name. |
GetDefSerieName(Int32)
Gets default series name.
Declaration
public string GetDefSerieName(int iSerieIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iSerieIndex | Represents series index in collections. |
Returns
Type | Description |
---|---|
System.String | Returns default series name. |
GetEnteredRecords(Int32)
Returns array of entered records.
Declaration
public List<BiffRecordRaw> GetEnteredRecords(int siIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | siIndex | Si record index. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> | Returns array of entered records. |
GetLegendEntryOffset(Int32)
Returns legend offset.
Declaration
public int GetLegendEntryOffset(int iSerIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iSerIndex | Represents series index. |
Returns
Type | Description |
---|---|
System.Int32 | Returns legend offset. |
GetSeriesWithDrawingOrder(Int32)
Gets series that has same chart group index.
Declaration
public List<ChartSerieImpl> GetSeriesWithDrawingOrder(int order)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | order | Parameter to check. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<ChartSerieImpl> | Returns list of found series. |
GetTypeByOrder(Int32)
Gets series type by order.
Declaration
public ExcelChartType GetTypeByOrder(int iOrder)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iOrder | Current order. |
Returns
Type | Description |
---|---|
ExcelChartType | Returns found type. |
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. |
OnClear()
Performs additional operations before the Clear method.
Declaration
protected override void OnClear()
Overrides
ParseSiIndex(IList<BiffRecordRaw>, ref Int32)
Parses ChartSiIndex records.
Declaration
public void ParseSiIndex(IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> | data | Array of records containing ChartSiIndex records. |
System.Int32 | iPos | Position of the first ChartSiIndex record. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | When specified record is not ChartSiIndex record. |
Remove(String)
Removes series by name.
Declaration
public void Remove(string serieName)
Parameters
Type | Name | Description |
---|---|---|
System.String | serieName | Series name to remove. |
RemoveAt(Int32)
Removes Series object from the collection.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Index of the series to remove. |
Serialize(OffsetArrayList)
Serializes collection.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | OffsetArrayList that will receive all records. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | When specified OffsetArrayList is NULL. |
SerializeDataLabels(OffsetArrayList)
Serializes data labels data.
Declaration
public void SerializeDataLabels(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | List of biff records to serialize into. |
UpdateDataPointForCylConePurChartType(ExcelBaseFormat, ExcelTopFormat)
Updates data points for create one of Pyramid, Cylinder, Cone chart types.
Declaration
public void UpdateDataPointForCylConePurChartType(ExcelBaseFormat baseFormat, ExcelTopFormat topFormat)
Parameters
Type | Name | Description |
---|---|---|
ExcelBaseFormat | baseFormat | Base format for update. |
ExcelTopFormat | topFormat | Top format for update. |
UpdateDataPointForCylConePyrChartType(ExcelBaseFormat, ExcelTopFormat)
Updates data points for create one of Pyramid, Cylinder, Cone chart types.
Declaration
public void UpdateDataPointForCylConePyrChartType(ExcelBaseFormat baseFormat, ExcelTopFormat topFormat)
Parameters
Type | Name | Description |
---|---|---|
ExcelBaseFormat | baseFormat | Base format for update. |
ExcelTopFormat | topFormat | Top format for update. |
UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)
Updates formulas after copy operation.
Declaration
public void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iCurIndex | Current worksheet index. |
System.Int32 | iSourceIndex | Source worksheet index. |
Rectangle | sourceRect | Source rectangle. |
System.Int32 | iDestIndex | Destination worksheet index. |
Rectangle | destRect | Destination rectangle. |
UpdateReferenceIndexes(Int32[])
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | arrUpdatedIndexes | Array with updated indexes. |
UpdateSerieIndexAfterRemove(Int32)
Updates series index after remove
Declaration
public void UpdateSerieIndexAfterRemove(int iRemoveIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iRemoveIndex | Remove index. |