Back to API Home

The DashboardDataDescriptor type exposes the following members.

Constructors

  NameDescription
Public methodDashboardDataDescriptor
Initializes a new instance of the DashboardDataDescriptor class.

Methods

  NameDescription
Public methodCopy
Copies this instance (deep copy). Please note the name on this clone will be the same as the original.
Public methodGetDataPointAxisValue
Gets the value of the axis of the data point.
Public methodGetDataPointColumnValue
Gets the column value of the data point.
Public methodGetDataPointFromValue
Gets the data point from the value.
Public methodGetDataPointFromValues
Gets the data point from the values.
Public methodGetDataPointKeyCaption
Gets the data point key caption from column id. This is required for the hierarchy control.
Public methodGetDataPointKeyCaptionFromColumnId
Gets the data point key caption from column id.
Public methodGetDataPointKeyValues
Gets the data point key index values from column id. This is for a full dimension.
Public methodGetDataPointKeyValuesFromColumnId
Gets the data point key index values from column id. This is for a full dimension.
Public methodGetDataPointMetricValue(DataPoint, Int32)
Gets the metric value of the data point.
Public methodGetDataPointMetricValue(DataPoint, String)
Gets the metric value of the data point.
Public methodGetDataPointStateValue(DataPoint, String, Guid)
Gets the state value of the data point.
Public methodGetDataPointStateValue(DataPoint, String, String)
Gets the state value of the data point.
Public methodGetDataPointStateValueFromColumnId(DataPoint, Guid, Guid)
Gets the data point state value from column id.
Public methodGetDataPointStateValueFromColumnId(DataPoint, Guid, String)
Gets the data point state value from column id.
Public methodGetDataPointValueFromColumnId
Gets the data point value from kpi column id.
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.
Public methodResetAnnotationGroups
Resets the annotation groups associated with this data descriptor to the default, as defined by the dashboard designer.
Public methodSerializingDataConstructor
Called when de-serialization occurs as this instance is marked with data contract.
Public methodSetAnnotationGroups
Sets the annotation groups associated with this data descriptor.
Public methodSetDataResult
Sets the data result.

Properties

  NameDescription
Public propertyAnnotationGroups
Gets or sets a collection of annotation groups which are shown by default for this data descriptor.
Public propertyCurrentAxisLevelParameter
Gets the current parameter acting on this Data Descriptor. It will only be set during the viewer cycle.
Public propertyCurrentFilterParameter
Gets the current filter parameter acting on this Data Descriptor. It will only be set during the viewer cycle.
Public propertyDashboardData
Gets the dashboard data. This property is not serialized.
Public propertyDashboardDataName
Gets or sets the name of the dashboard data.
Public propertyDataAnnotations
Gets or sets the data annotations.
Public propertyDataObjectName
Public propertyDataResult
Gets the data result. This property is not serialized. It will only be set during a viewer cycle.
Public propertyDataVisualizationObjectName
Gets or sets the name of the data visual object to which this descriptor acts upon.
Public propertyDefaultAnnotationGroupId
Gets or sets the ID of the default annotation group.
Public propertyDimensions
Gets the IDs of columns which are being used as axis dimensions.
Public propertyHasScalarResult
Gets a value indicating whether the data associated with the descriptor will always be a scalar (i.e. single data point).
Public propertyId
Gets or sets the id of the dashboard data object.
Public propertyIsAxisActive
Gets or sets a value indicating whether a possible dimension axis requires calculations.
Public propertyIsChildExistenceCheckRequired
Gets dictionary of IsChildExistenceCheckRequired of dimensions associated with this data descriptor, the key is the ID of the dimension.
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.
Public propertyIsGenerated
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.
Public propertyIsRealTimeSource
Gets or sets a value indicating whether the data source is set as real time.
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.
Public propertyMaxNumberRecords
Gets or sets the max number records.
Public propertyMetrics
Gets or sets the metrics.
Public propertyName
Gets or sets the name of the dashboard data descriptor. This name is guaranteed to be unique across all dashboard data descriptors.
Public propertyRefreshInterval
Gets or sets the refresh interval.
Public propertyStateGroups
Gets or sets the state groups.
Public propertyTokenId
Gets or sets the token id. This is used by the wrapper to identify the series associated with the data object.
Public propertyTopDimensionAncestryLevel
Gets dictionary of TopDimensionAncestryLevel of dimensions associated with this data descriptor, the key is the ID of the dimension.
Public propertyVisualObjectName
Public propertyVisualProperties
Gets or sets the user-set visual properties associated with this descriptor.

See Also