Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

Kpi Class

 

Applies To: SQL Server 2016 Preview

Represents a Key Performance Indicator (KPI). This class cannot be inherited.

Namespace:   Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)


[GuidAttribute("8627F50A-070E-4501-86E0-1BB6CA124473")]
public sealed class Kpi : NamedComponent, ICloneable

NameDescription
System_CAPS_pubmethodKpi()

Initializes a new instance of Kpi using the default values.

System_CAPS_pubmethodKpi(String, String)

Initializes a new instance of Kpi using a name and an identifier.

NameDescription
System_CAPS_pubpropertyAnnotations

Gets a collection within which you can store custom data.(Inherited from ModelComponent.)

System_CAPS_pubpropertyAssociatedMeasureGroup

Gets the measure group that is associated with the calculations in a Kpi.

System_CAPS_pubpropertyAssociatedMeasureGroupID

Gets or sets the identifier of the measure group that is associated with the calculations in a Kpi.

System_CAPS_pubpropertyContainer

(Inherited from Component.)

System_CAPS_pubpropertyCurrentTimeMember

Gets or sets an MDX expression that returns the member that identifies the temporal context of the KPI.

System_CAPS_pubpropertyDescription

Gets or sets the description of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyDisplayFolder

Gets or sets the folder in which the KPI will appear when a user is browsing the cube.

System_CAPS_protpropertyFriendlyName

Returns a user-friendly name.(Inherited from NamedComponent.)

System_CAPS_pubpropertyGoal

Gets or sets an MDX numeric expression or a calculation that returns the target value of the KPI.

System_CAPS_pubpropertyID

Gets or sets the identifier of the component.(Inherited from NamedComponent.)

System_CAPS_protpropertyKeyForCollection

Returns the key used in collections.(Inherited from NamedComponent.)

System_CAPS_pubpropertyName

Gets or sets the name of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyOwningCollection

Gets or sets the collection that contains the ModelComponent.(Inherited from ModelComponent.)

System_CAPS_pubpropertyParent

Gets the Cube object that is the parent of the Kpi object.

System_CAPS_pubpropertyParentDatabase

Gets the Database object that is the parent of the Kpi object's Cube object.

System_CAPS_pubpropertyParentKpiID

Gets or sets the ID of the parent Kpi.

System_CAPS_pubpropertyParentServer

Gets the Server object that is the parent of the Kpi.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertySiteID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the identifier for the site associated with the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyStatus

Gets or sets an MDX expression that represents the state of the KPI at a specified point in time.

System_CAPS_pubpropertyStatusGraphic

Gets or sets a visual element that provides a quick indication of the status for a KPI.

System_CAPS_pubpropertyTranslations

Gets the collection of translations associated with a Kpi object.

System_CAPS_pubpropertyTrend

Gets or sets an MDX expression that evaluates the value of the KPI over time.

System_CAPS_pubpropertyTrendGraphic

Gets or sets a visual element that provides a quick indication of the trend for a KPI.

System_CAPS_pubpropertyValue

Gets or sets an MDX numeric expression that returns the actual value of the KPI.

System_CAPS_pubpropertyWeight

Gets or sets an MDX numeric expression that assigns a relative importance to a KPI.

NameDescription
System_CAPS_protmethodAddToContainer(IContainer)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds a ModelComponent object to the specified container.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterInsert(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponent object after added to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterMove(Int32, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponent object after moving to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterRemove(ModelComponentCollection)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponentCollection after a ModelComponent object is removed.(Inherited from ModelComponent.)

System_CAPS_protmethodBeforeRemove(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the ModelComponent object before the cleanup.(Inherited from ModelComponent.)

System_CAPS_pubmethodClone()

Creates a new, full copy of the Kpi object.

System_CAPS_pubmethodCopyTo(Kpi)

Copies a Kpi to the specified object.

System_CAPS_pubmethodCreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodRemoveFromContainer(IContainer)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes a ModelComponent object from the specified container.(Inherited from ModelComponent.)

System_CAPS_pubmethodSubmit()

This API supports the product infrastructure and is not intended to be used directly from your code. Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodSubmit(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodToString()

Returns a string containing the name of the component.(Inherited from NamedComponent.)

System_CAPS_pubmethodValidate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.(Inherited from ModelComponent.)

System_CAPS_pubmethodValidate(ValidationErrorCollection, Boolean)

Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors.(Inherited from ModelComponent.)

System_CAPS_pubmethodValidate(ValidationErrorCollection, Boolean, ServerEdition)

NameDescription
System_CAPS_pubeventDisposed

(Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICloneable.Clone()

Creates a new, full copy of the Kpi object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.(Inherited from NamedComponent.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

Show:
© 2015 Microsoft