416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

DashboardDataDescriptor Class

Hide navigation
RSS
Modified on Tue, 10 Apr 2012 11:58 AM Categorized as Library Reference

Describes how the data from a KPI or dataset is assigned to a visualization control to be displayed.

DashboardDataDescriptor is the base class for DashboardKpiDescriptor and DashboardDataSetDescriptor.

Properties

ImageImageProperty Name [Script Name]TypeDescription
[AnnotationGroups]Collection<Guid>The IDs of the user annotation groups that are enabled.
[CurrentAxisLevelParameter]DashboardParameterThe current parameter acting on this data descriptor.
[CurrentFilterParameter]DashboardParameterThe current filter parameter acting on this data descriptor.
[DashboardData]DashboardDataThe KPI or Dataset providing data to display.
[DashboardDataName]stringThe name of the KPI or Dataset providing data to display.
[DataAnnotations]Collection<Guid>The IDs of the data annotation fields displayed by this control. You can use these IDs to identify data annotation fields in the data result.
[DataResult]DataResultThe data returned by the KPI or Dataset to be displayed by the control.
[DataVisualizationObjectName]stringThe name of the data control object that this descriptor acts upon.
[DefaultAnnotationGroupId]GuidThe ID of the default user annotation group. This can be configured in the data settings wizard in the dashboard designer.
[Dimensions]Collection<Guid>The IDs of the axis dimension fields displayed by this control. You can use these IDs to identify dimension fields in the data result.
[Id]GuidThe data descriptor ID.
[IsAxisActive]boolIndicates whether the data control to which this descriptor is assigned uses axis dimension values.
[LastParameterChanged]DashboardParameterThe 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.
[MaxNumberRecords]intThe maximum number of records, which can be configured in the data settings wizard in the dashboard designer.
[Metrics]Collection<Guid>The IDs of the metric fields displayed by this control. You can use these IDs to identify metric fields in the data result.
[Name]stringThe name of the data descriptor. This name is guaranteed to be unique across all dashboard data descriptors, and can be configured in the Dashboard designer.
[StateGroups]Collection<Guid>The IDs of state groups enabled on this control. You can use these IDs to identify fields in the data result that display state values.
[TokenId]GuidThe ID of the token in the control's Tokens collection corresponding to this data descriptor.

Methods

GetDataPointAxisValue

Gets the value of the axis dimension of the data point. Returns null if no value is available.

  • object GetDataPointAxisValue( DataPoint dataPoint )

GetDataPointColumnValue

Gets the column value of the data point. Returns null if no value is available.

  • object GetDataPointColumnValue( DataPoint dataPoint, string columnName )

GetDataPointFromValue

Gets the data point from the value. Returns the data point or null if nothing is found.

  • DataPoint GetDataPointFromValue( object value )

Example usage:

DataPoint dataPoint = BarChart1.DataDescriptors0.GetDataPointFromValue("B");

The value is case sensitive, and it doesn't only apply to dimension values, but any value in the data point. So, you could search for a measure value too. If more than 1 match is found (&ie; there are two points with "B"), it will return the first. If none are found, it will return null.

GetDataPointFromValues

Gets the data point from the values. Returns the data point or null if nothing is found.

  • DataPoint GetDataPointFromValues( Collection<object> values )

GetDataPointKeyCaption

Gets the data point key caption from column name. This is required for the hierarchy control. Returns null if no data point key is available.

  • object GetDataPointKeyCaption( DataPoint dataPoint, string columnName )

GetDataPointKeyCaptionFromColumnId

Gets the data point key caption from column ID. Returns null if no data point key is available.

  • object GetDataPointKeyCaptionFromColumnId( DataPoint dataPoint, Guid columnId )

GetDataPointKeyValues

Gets the data point key index values from column name. This is for a full dimension.


GetDataPointKeyValuesFromColumnId

Gets the data point key index values from column ID. This is for a full dimension.


GetDataPointMetricValue

Gets the metric value of the data point. Returns null if no value is available.

  • object GetDataPointMetricValue( DataPoint dataPoint, int metricIndex )
  • object GetDataPointMetricValue( DataPoint dataPoint, string metricName )

GetDataPointStateValue

Gets the state value of the data point. Returns null if no value is available.

  • object GetDataPointStateValue( DataPoint dataPoint, string metricName, string stateGroupName )
  • object GetDataPointStateValue( DataPoint dataPoint, string metricName, Guid stateGroupId )

GetDataPointStateValueFromColumnId

Gets the data point state value from column ID. Returns null if no value is available.

  • object GetDataPointStateValueFromColumnId( DataPoint dataPoint, Guid columnId, string stateGroupName )
  • object GetDataPointStateValueFromColumnId( DataPoint dataPoint, Guid columnId, Guid stateGroupId )

GetDataPointValueFromColumnId

Gets the data point value from KPI column ID. Returns null if no value is available.

  • object GetDataPointValueFromColumnId( DataPoint dataPoint, Guid columnId )

ResetAnnotationGroups

Resets the annotation groups associated with this data descriptor to the default, as defined by the dashboard designer.

  • void ResetAnnotationGroups()

SetAnnotationGroups

Sets the annotation groups associated with this data descriptor.


Related topics


About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.