Class KpiInfoCollection
Represents the Collection of KPI Information.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Olap.Engine
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class KpiInfoCollection : CollectionBase, IList, ICollection, IEnumerable, ICloneable<KpiInfoCollection>
Constructors
KpiInfoCollection()
Declaration
public KpiInfoCollection()
Properties
AxisType
Gets or sets the type of the axis.
Declaration
public KpiAxisType AxisType { get; set; }
Property Value
Type | Description |
---|---|
KpiAxisType | The type of the axis. |
Item[Int32]
Gets or sets the KpiInfo at the specified index.
Declaration
public KpiInfo this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index of the KPI information. |
Property Value
Type |
---|
KpiInfo |
Methods
Add(KpiInfo)
Adds the specified KPI information.
Declaration
public int Add(KpiInfo kpiInformation)
Parameters
Type | Name | Description |
---|---|---|
KpiInfo | kpiInformation | The KPI information which is to be added. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the KPI information object in the current collection. |
Clone()
Clones this instance.
Declaration
public KpiInfoCollection Clone()
Returns
Type | Description |
---|---|
KpiInfoCollection | A copy of this instance. |
Contains(KpiInfo)
Determines whether the collection contains specified KPI information.
Declaration
public bool Contains(KpiInfo kpiInfo)
Parameters
Type | Name | Description |
---|---|---|
KpiInfo | kpiInfo | The KPI information object which is to be searched. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Contains(String)
Determines whether the collection contains specified KPI information.
Declaration
public bool Contains(string kpiName)
Parameters
Type | Name | Description |
---|---|---|
System.String | kpiName | The name of the KPI information which is to be searched. |
Returns
Type | Description |
---|---|
System.Boolean |
|
FindByName(String)
Finds the KPI information object by its name.
Declaration
public KpiInfo FindByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the KPI information object. |
Returns
Type | Description |
---|---|
KpiInfo | The KPI information object. |
FindMemberIndexByName(String, String)
Finds the index of the KPI information.
Declaration
public int FindMemberIndexByName(string kpiName, string memberName)
Parameters
Type | Name | Description |
---|---|---|
System.String | kpiName | The name of the KPI information. |
System.String | memberName | The name of the member. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the KPI information. |
FindNextMemberPosition(Int32, String, String, KpiInfoCollection)
Finds the position of the next member.
Declaration
public static int FindNextMemberPosition(int pos, string kpiName, string memberName, KpiInfoCollection kpiInfoCollection)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | pos | The position. |
System.String | kpiName | The name of the KPI information. |
System.String | memberName | The name of the member. |
KpiInfoCollection | kpiInfoCollection | The collection of KPI information . |
Returns
Type | Description |
---|---|
System.Int32 | The position of the next member. |
Merge(KpiInfoCollection)
Merges the specified KPI information collection with the existing collection.
Declaration
public static KpiInfoCollection Merge(KpiInfoCollection kpiInfoCollection)
Parameters
Type | Name | Description |
---|---|---|
KpiInfoCollection | kpiInfoCollection | The collection of KPI information. |
Returns
Type | Description |
---|---|
KpiInfoCollection | The merged collection of KPI information. |
Remove(KpiInfo)
Removes the specified KPI information.
Declaration
public void Remove(KpiInfo kpiInformation)
Parameters
Type | Name | Description |
---|---|---|
KpiInfo | kpiInformation | The KPI information object which is to be removed. |
RemoveMeasures()
Removes the measures.
Declaration
public void RemoveMeasures()