KPI Class

Reference

Definition

Namespace:: Microsoft.AnalysisServices.Tabular

Assembly:: Microsoft.AnalysisServices.Tabular.dll

Package:: Microsoft.AnalysisServices.retail.amd64 v19.79.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Key Performance Indicator object. It is a child of a Measure object.

public sealed class KPI : Microsoft.AnalysisServices.Tabular.MetadataObject

type KPI = class
    inherit MetadataObject

Public NotInheritable Class KPI
Inherits MetadataObject

Inheritance: Object

MetadataObject
KPI

Constructors

KPI()

Create a new instance of the KPI class with default settings.

Properties

Annotations	Gets the collection object of all annotations in the current KPI.
Description	The description of the KPI, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.
ExtendedProperties	Gets the collection object of all extendedproperties in the current KPI.
IsRemoved	A Boolean specifying whether this object was removed from an object tree. (Inherited from MetadataObject)
Measure	A reference to a Measure object that owns this KPI.
Model	Gets the Tabular model that contains this object. (Inherited from MetadataObject)
ModifiedTime	The time that the object was last modified.
ObjectType	Gets the type of the object.
Parent	Parent object, null for Model objects.
StatusDescription	A description of the Status value for the KPI.
StatusExpression	An expression that is used to calculate the status of the KPI.
StatusGraphic	The recommended graphic to represent the status of this KPI.
TargetDescription	The description of the target value of the KPI.
TargetExpression	An expression that evaluates to a number and indicates the goal for the KPI.
TargetFormatString	The format string to be used when presenting the target value for the KPI.
TrendDescription	A description of the trend value of the KPI.
TrendExpression	An expression representing the trend of the KPI.
TrendGraphic	A string that identifies the graphic to show for the trend of the KPI.

Methods

Clone()	Creates a new, full copy of a KPI object.
CopyFrom(KPI)	Obsolete. Deprecated. Use CopyTo method instead.
CopyTo(KPI)	Copies a KPI object to the specified object.
Validate()	This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only. (Inherited from MetadataObject)

Applies to