Back to API Home

The DashboardKpiDescriptor type exposes the following members.

Constructors

  NameDescription
Public methodDashboardKpiDescriptor
Initializes a new instance of the DashboardKpiDescriptor class.

Methods

  NameDescription
Public methodCopy
Copies this instance (deep copy). Please note the name on this clone will be the same as the original.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointAxisValue
Gets the value of the axis of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointColumnValue
Gets the column value of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointDataAnnotationValue(DataPoint, Int32)
Gets the data annotation value of the data point.
Public methodGetDataPointDataAnnotationValue(DataPoint, String)
Gets the data annotation value of the data point.
Public methodGetDataPointFromValue
Gets the data point from the value.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointFromValues
Gets the data point from the values.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointKeyCaption
Gets the data point key caption from column id. This is required for the hierarchy control.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointKeyCaptionFromColumnId
Gets the data point key caption from column id.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointKeyValues
Gets the data point key index values from column id. This is for a full dimension.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointKeyValuesFromColumnId
Gets the data point key index values from column id. This is for a full dimension.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointMetricValue(DataPoint, Int32)
Gets the metric value of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointMetricValue(DataPoint, String)
Gets the metric value of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointStateValue(DataPoint, String, Guid)
Gets the state value of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointStateValue(DataPoint, String, String)
Gets the state value of the data point.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointStateValueFromColumnId(DataPoint, Guid, Guid)
Gets the data point state value from column id.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointStateValueFromColumnId(DataPoint, Guid, String)
Gets the data point state value from column id.
(Inherited from DashboardDataDescriptor.)
Public methodGetDataPointValueFromColumnId
Gets the data point value from kpi column id.
(Inherited from DashboardDataDescriptor.)
Public methodRecalculateSingleDataPoint
Recalculates the [!:DataResult.SingleDataPoint] property of the DataResult associated with this dashboard data descriptor. This method should be called after data points have been added to or removed from the DataResult.
(Inherited from DashboardDataDescriptor.)
Public methodResetAnnotationGroups
Resets the annotation groups associated with this data descriptor to the default, as defined by the dashboard designer.
(Inherited from DashboardDataDescriptor.)
Public methodSerializingDataConstructor
Called when de-serialization occurs as this instance is marked with data contract.
(Inherited from DashboardDataDescriptor.)
Public methodSerializingKpiConstructor
Called when de-serialization occurs as this instance is marked with data contract.
Public methodSetAnnotationGroups
Sets the annotation groups associated with this data descriptor.
(Inherited from DashboardDataDescriptor.)
Public methodSetDataResult
Sets the data result.
(Inherited from DashboardDataDescriptor.)

Properties

  NameDescription
Public propertyAnnotationGroups
Gets or sets a collection of annotation groups which are shown by default for this data descriptor.
(Inherited from DashboardDataDescriptor.)
Public propertyCurrentAxisLevelParameter
Gets the current parameter acting on this Data Descriptor. It will only be set during the viewer cycle.
(Inherited from DashboardDataDescriptor.)
Public propertyCurrentFilterParameter
Gets the current filter parameter acting on this Data Descriptor. It will only be set during the viewer cycle.
(Inherited from DashboardDataDescriptor.)
Public propertyDashboardData
Gets the dashboard data. This property is not serialized.
(Inherited from DashboardDataDescriptor.)
Public propertyDashboardDataName
Gets or sets the name of the dashboard data.
(Inherited from DashboardDataDescriptor.)
Public propertyDataAnnotations
Gets or sets the data annotations.
(Inherited from DashboardDataDescriptor.)
Public propertyDataObjectName (Inherited from DashboardDataDescriptor.)
Public propertyDataResult
Gets the data result. This property is not serialized. It will only be set during a viewer cycle.
(Inherited from DashboardDataDescriptor.)
Public propertyDataVisualizationObjectName
Gets or sets the name of the data visual object to which this descriptor acts upon.
(Inherited from DashboardDataDescriptor.)
Public propertyDefaultAnnotationGroupId
Gets or sets the ID of the default annotation group.
(Inherited from DashboardDataDescriptor.)
Public propertyDimension
Gets or sets the dimension. Since a Kpi can only have 1 axis dimension, it just returns the first item in the collection.
Public propertyDimensions
Gets the IDs of columns which are being used as axis dimensions.
(Inherited from DashboardDataDescriptor.)
Public propertyHasScalarResult
Gets a value indicating whether the data associated with the descriptor will always be a scalar (i.e. single data point).
(Inherited from DashboardDataDescriptor.)
Public propertyId
Gets or sets the id of the dashboard data object.
(Inherited from DashboardDataDescriptor.)
Public propertyIsAxisActive
Gets or sets a value indicating whether a possible dimension axis requires calculations.
(Inherited from DashboardDataDescriptor.)
Public propertyIsChildExistenceCheckRequired
Gets dictionary of IsChildExistenceCheckRequired of dimensions associated with this data descriptor, the key is the ID of the dimension.
(Inherited from DashboardDataDescriptor.)
Public propertyIsContextualMetric
Gets a value indicating whether this instance is contextual metric.
Public propertyIsDataRetrievedManually
Gets or sets a value indicating whether this instance has data retrieved manually. If so, the viewer will not retrieve data for this descriptor, and it will be up to any control using it to get the data itself.
(Inherited from DashboardDataDescriptor.)
Public propertyIsGenerated (Inherited from DashboardDataDescriptor.)
Public propertyIsHidden
Gets or sets a value indicating whether any visual series associated with this data descriptor should be hidden. This allows the user to hide the series in run-time.
(Inherited from DashboardDataDescriptor.)
Public propertyIsRealTimeSource
Gets or sets a value indicating whether the data source is set as real time.
(Inherited from DashboardDataDescriptor.)
Public propertyIsStackAxisActive
Gets or sets a value indicating whether a possible dimension axis stack requires calculations.
Public propertyKpi
Gets the kpi. This property is not serialized. It will only be set during a viewer cycle.
Public propertyKpiId
Gets or sets the kpi id.
Public propertyKpiName
Gets or sets the name of the kpi.
Public propertyLastParameterChanged
Gets or sets the last parameter changed. This will be a reference to either CurrentFilterParameter or CurrentAxisLevelParameter, depending on which one changed last, or null if neither was set.
(Inherited from DashboardDataDescriptor.)
Public propertyMaxNumberRecords
Gets or sets the max number records.
(Inherited from DashboardDataDescriptor.)
Public propertyMetrics
Gets or sets the metrics.
(Inherited from DashboardDataDescriptor.)
Public propertyName
Gets or sets the name of the dashboard data descriptor. This name is guaranteed to be unique across all dashboard data descriptors.
(Inherited from DashboardDataDescriptor.)
Public propertyRefreshInterval
Gets or sets the refresh interval.
(Inherited from DashboardDataDescriptor.)
Public propertyStateGroups
Gets or sets the state groups.
(Inherited from DashboardDataDescriptor.)
Public propertyTokenId
Gets or sets the token id. This is used by the wrapper to identify the series associated with the data object.
(Inherited from DashboardDataDescriptor.)
Public propertyTopDimensionAncestryLevel
Gets dictionary of TopDimensionAncestryLevel of dimensions associated with this data descriptor, the key is the ID of the dimension.
(Inherited from DashboardDataDescriptor.)
Public propertyVisualObjectName (Inherited from DashboardDataDescriptor.)
Public propertyVisualProperties
Gets or sets the user-set visual properties associated with this descriptor.
(Inherited from DashboardDataDescriptor.)

See Also