Back to API Home

The Kpi type exposes the following members.

Methods

  NameDescription
Public methodStatic memberCheckoutAsync
Checks out the Kpi given the id.
Public methodComposeReport
Calls the OLAP report composer service.
(Inherited from DashboardData.)
Public methodStatic memberDeleteAsync
Delete the Kpi.
Public methodStatic memberGetAsync(Guid, OnCompleted<(Of <<'(Kpi>)>>))
Retrieves the Kpi given the id.
Public methodStatic memberGetAsync(Guid, ObjectVersionType, OnCompleted<(Of <<'(Kpi>)>>))
Retrieves the Kpi given the id.
Public methodStatic memberGetByNameAsync
Retrieve the Kpi given the name.
Public methodStatic memberUndoCheckoutAsync
Undo checkout for the Kpi given the id.

Properties

  NameDescription
Public propertyAvailableRelations
Gets the collection of available virtual relationships.
(Inherited from DashboardData.)
Public propertyAxisDimension
Gets the KPI axis dimension.
Public propertyBusinessObjectType
Gets the type of the business object.
(Inherited from BusinessObjectBase.)
Public propertyCalculatedMeasures
Gets the KPI calculated measures.
Public propertyColumns
Gets the collection of data columns.
(Inherited from DashboardData.)
Public propertyContextualMetrics
Gets the KPI contextual metrics.
Public propertyDataAnnotations
Gets the KPI data annotations.
Public propertyDataCacheClientDuration
Gets or sets the client data cache duration.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheClientPreviewEnabled
Gets or sets a value indicating whether client data cache is used during preview.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheClientViewEnabled
Gets or sets a value indicating whether client data cache is used during view.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerDuration
Gets or sets the server data cache duration.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerPreviewEnabled
Gets or sets a value indicating whether server data cache is used during preview.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerViewEnabled
Gets or sets a value indicating whether server data cache is used during view.
(Inherited from BusinessObjectBase.)
Public propertyDataConnectorId
Gets or sets the data connector id.
(Inherited from DashboardData.)
Public propertyDefaultDataAnnotation
Gets the default KPI annotation.
Public propertyDefaultMeasure
Gets the default KPI measure.
Public propertyDefaultMetric
Gets the overall default metric.
(Overrides DashboardData..::..DefaultMetric.)
Public propertyDefaultUserAnnotationSetId
Gets or sets the default user annotation set id.
(Inherited from DashboardData.)
Public propertyDescription
Gets or sets the object's description.
(Inherited from BusinessObjectBase.)
Public propertyDimensionHierarchies
Gets the dimension hierarchies associated with the object.
(Inherited from DashboardData.)
Public propertyDimensions
Gets the KPI dimensions.
Public propertyFileType
Gets the entry type of the object.
(Inherited from BusinessObjectBase.)
Public propertyFilters
Gets the filters.
(Inherited from DashboardData.)
Public propertyFullName
Gets the object's fully qualified name.
(Inherited from BusinessObjectBase.)
Public propertyId
Gets the object's ID.
(Inherited from BusinessObjectBase.)
Public propertyIsCheckedOut
Gets a value indicating whether this instance is checked out.
(Inherited from BusinessObjectBase.)
Public propertyIsInvalid
Gets or sets a value indicating whether this object instance is invalid.
(Inherited from DashboardData.)
Public propertyIsNeverCheckedIn
Gets a value indicating whether this instance is never checked in.
(Inherited from BusinessObjectBase.)
Public propertyIsOlapBased
Gets a value indicating whether this instance is olap based.
(Inherited from DashboardData.)
Public propertyIsStub
Gets or sets the object stubbing status.
(Inherited from BusinessObjectBase.)
Public propertyItem
Gets the FilterData for the specified column id.
(Inherited from DashboardData.)
Public propertyKeyValues
Gets the key value pairs.
(Inherited from BusinessObjectBase.)
Public propertyMaxDataPointsNumber
Gets or sets the maximum number for the returned data points.
(Inherited from DashboardData.)
Public propertyMaximumValue
Gets or sets the maximum value.
Public propertyMeasures
Gets the KPI measures.
Public propertyMeasureUnit
Gets or sets the unit of measure.
Public propertyMetadata
Gets or sets the structure metadata for the business object.
(Inherited from DashboardData.)
Public propertyMetrics
Gets the data columns returned by the object query.
(Inherited from DashboardData.)
Public propertyMinimumValue
Gets or sets the minimum value.
Public propertyMinPollingInterval
Gets or sets the minimum polling interval.
(Inherited from DashboardData.)
Public propertyMoreInfoUri
Gets or sets the dashboard's "more information" URI.
(Inherited from BusinessObjectBase.)
Public propertyName
Gets or sets the object's name.
(Inherited from BusinessObjectBase.)
Public propertyNonEmptyOlapMeasures
Gets the list of olap measures included in non empty filtering.
(Inherited from DashboardData.)
Public propertyOlapHierarchyInfo
Gets the hierarchy information for OLAP hierarchies associated with the object when viewing.
(Inherited from DashboardData.)
Public propertyParameterData
Gets or sets the parameter metadata for the business object.
(Inherited from DashboardData.)
Public propertyPreferredVisualization
Gets or sets the preferred visualization.
(Inherited from DashboardData.)
Public propertyQueryData
Gets or sets the relational query metadata for the business object.
(Inherited from DashboardData.)
Public propertyRelations
Gets the relations.
(Inherited from DashboardData.)
Public propertyReportData
Gets or sets the OLAP report metadata for the business object.
(Inherited from DashboardData.)
Public propertySingleValueRepresentation
Gets or sets the single value representation.
(Inherited from DashboardData.)
Public propertyStackedAxisDimension
Gets the KPI stacked axis dimension.
Public propertyStateGroups
Gets the state groups.
(Inherited from DashboardData.)
Public propertyStructures
Gets the structures.
(Inherited from DashboardData.)
Public propertyStubGenerator
Gets or sets the stub generator.
(Inherited from DashboardData.)

Events

  NameDescription
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from BusinessObjectBase.)

See Also