Kpi Class
OLAP KPI.When the object is serialized out as xml, its qualified name is x:kpi.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Spreadsheet.Kpi
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class Kpi _
Inherits OpenXmlLeafElement
'Usage
Dim instance As Kpi
public class Kpi : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
18.10.1.47 kpi (OLAP KPI)
Represents the KPI defined on the OLAP server and stored in the PivotCache.
[Example:
<kpi uniqueName="Growth in Customer Base" caption="Growth in Customer Base" displayFolder="Customer Perspective\Expand Customer Base" measureGroup="Internet Sales" value="[Measures].[Growth in Customer Base]" goal="[Measures].[Growth in Customer Base Goal]" status="[Measures].[Growth in Customer Base Status]" trend="[Measures].[Growth in Customer Base Trend]"/>
end example]
Parent Elements |
|---|
kpis (§18.10.1.48) |
Attributes |
Description |
|---|---|
caption (KPI Display Name) |
Specifies the display name of the KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
displayFolder (KPI Display Folder) |
Specifies the folder where this KPI is displayed in a list of fields for the PivotTable. This attribute depends on how the application exposes a list of fields in the user interface. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
goal (KPI Goal Unique Name) |
Specifies the unique name of the KPI goal measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
measureGroup (KPI Measure Group Name) |
Specifies the name of the measure group to which this KPI belongs. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
parent (Parent KPI) |
Specifies the name of the parent KPI for this KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
status (KPI Status Unique Name) |
Specifies the unique name of the KPI status measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
time (Time Member KPI Unique Name) |
Specifies the unique name of the KPI current time member. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
trend (KPI Trend Unique Name) |
Specifies the unique name of the KPI trend measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
uniqueName (KPI Unique Name) |
Specifies the unique name of the KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
value (KPI Value Unique Name) |
Specifies the unique name of the KPI value measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
weight (KPI Weight Unique Name) |
Specifies the unique name of the KPI weight measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
[Note: The W3C XML Schema definition of this element’s content model (CT_PCDKPI) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.