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.

DashboardDataPoint Class

Hide navigation
RSS
Modified on Mon, 06 May 2013 05:28 PM Categorized as Library Reference
Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties

Table of Contents [Hide/Show]


A DashboardControl representing a chart data point.

DashboardDataPoint is the base class for DashboardPieDataPoint and DashboardStateDataPoint.

Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
[ActualToolTipText]stringGets the actual text displayed as a tooltip for this data point, with data point keywords replaced.

Note: This value is not updated until the Axis Updated Interaction is triggered or IsUpdatePending is false for both axes to which this point's series is assigned.
[ActualXAxisLabelText]stringGets the actual text displayed as an X axis label if a label corresponds to this data point, with data point keywords replaced.

Note: This value is not updated until the Axis Updated Interaction is triggered or IsUpdatePending is false for both axes to which this point's series is assigned.
[Series]DashboardDataSeriesGets the data series this data point is associated with.
Tooltip Text [ToolTipText]stringThe text displayed when the user hovers over a data point with their mouse. This text can include data point keywords.
[XAxisLabelText]stringThe label text displayed corresponding to this point along the X axis. This text can include data point keywords.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageFill [Fill]DashboardBrushThe fill brush to apply to this data point. Set to Inherit (null in script) to use a value specified in a point style, the series or palette.
ImageMarker Fill [MarkerFill]DashboardBrushThe brush used to fill the marker. Set to Inherit (null in script) to use a value specified in a point style, the series or palette.
ImageMarker Shape [MarkerShape]DashboardMarkerShapeThe shape of the marker. Set to None to use a value specified in a point style, the series or palette.
ImageMarker Stroke [MarkerStroke]DashboardBrushThe brush used to draw the marker's edges. Set to Inherit (null in script) to use a value specified in a point style, the series or palette.
ImageMarker Stroke Thickness [MarkerStrokeThickness]doubleThe thickness of the marker stroke in pixels. Set to Auto (double.NaN in script) to use a value specified in a point style, the series or palette.
ImageMarker Visibility [MarkerVisibility]VisibilityIndicates whether the markers are visible or not. If collapsed, they will not be visible.
ImageImageMarker Visual Effect [MarkerVisualEffect]DashboardEffectThe visual effect applied to the marker.
ImageStroke [Stroke]DashboardBrushThe brush used to draw the edges of the data point. Set to Inherit (null in script) to use a value specified in a point style, the series or palette.
ImageImageStroke Pattern [StrokePattern]DashboardLinePatternTypeThe pattern applied to the stroke of the data point. Set to Auto to use a value specified in a point style, the series or palette.
ImageStroke Thickness [StrokeThickness]doubleThe thickness of the stroke in pixels. Set to Auto (double.NaN in script) to use a value specified in a point style, the series or palette.

Note:
  • The Point Chart uses markers to display data points, so only the marker properties above affect their appearance. The Marker Visibility property does not apply.
  • The Bubble Chart does not support markers.
  • The Line Chart and Stock Chart display only line strokes, so the Fill property is used in place of the Stroke property.


Layout

ImageImageProperty Name [Script Name]TypeDescription
ImageLabel Z-Index [LabelZIndex]intThe data point label z-index, which determines which elements are drawn over others if they overlap. A higher value places an element on top.
ImageMarker Height [MarkerHeight]doubleThe height of the marker in pixels. Set to Auto (double.NaN in script) to use a value specified in a point style, the series or palette.
ImageMarker Width [MarkerWidth]doubleThe width of the marker in pixels. Set to Auto (double.NaN in script) to use a value specified in a point style, the series or palette.
ImageMarker Z-Index [MarkerZIndex]intThe marker z-index, which determines which elements are drawn over others if they overlap. A higher value places an element on top.

Text

ImageImageProperty Name [Script Name]TypeDescription
[ActualLabelText]stringGets the actual label text displayed for this data point, with data point keywords replaced.

Note: This value is not updated until the Axis Updated Interaction is triggered or IsUpdatePending is false for both axes to which this point's series is assigned.
[IsOverlappedLabelHidden]boolIndicates whether series labels that cannot be prevented from overlapping with other labels are hidden. The default value is True.
ImageImageLabel Alignment [LabelAlignment]DashboardAnchorAlignmentThe alignment of the label relative to the data point Y-value. The default value is Auto.
ImageImageLabel Background [LabelBackground]DashboardBrushThe brush painted behind data point label text.
ImageImageLabel Border Brush [LabelBorderBrush]DashboardBrushThe brush used to paint a rectangular border around the data point label text.
ImageImageLabel Border Thickness [LabelBorderThickness]ThicknessThe thickness of the border drawn around the series label text using Label Border Brush.
ImageImageLabel Leader Line Brush [LabelLeaderLineBrush]DashboardBrushThe brush used to paint leader lines to data point labels.
[LabelMaxMovingDistance]doubleThe maximum distance in pixels labels can be moved to prevent overlap when Label Alignment is Auto. The default value is 300.
ImageImageLabel Offset [LabelOffset]doubleThe offset of the label away from the data point Y-value in pixels. The default value is 5.
Label Text [LabelText]stringThe label text for this data point. This text can include data point keywords.
[LabelLeaderLineVisibility]DashboardLeaderLineVisibilityDetermines when leader lines are displayed between data points and their associated labels. The default value is Auto.
ImageImageLabel Visual Effect [LabelVisualEffect]DashboardEffectThe visual effect applied to the data point label.
Show Y-Value Label [IsValueShownAsLabel]boolIndicates whether the first Y-value is shown as a data point label for this point.

Note: If text has been specified for Label Text, this value is ignored.

Note: The label positioning properties above do not apply to Pie or Funnel charts, or to bar charts with labels inside.

Data

ImageImageProperty Name [Script Name]TypeDescription
[DataSource]objectGets the KPI or dataset data point or the analytical cell object that provides the values displayed by this chart data point.
[XValue]objectGets or sets the value of this data point that is plotted against the series X axis. This value can be double.PositiveInfinity or double.NegativeInfinity to represent the value at the maximum or minimum of the axis, respectively.
[YValues]DashboardYValueCollectionGets the collection of values of this data point plotted against the series Y axis. These values can be double.PositiveInfinity or double.NegativeInfinity to represent the value at the maximum or minimum of the axis, respectively.



Legend

ImageImageProperty Name [Script Name]TypeDescription
[ActualLegendText]stringGets the actual text displayed in the legend for this data point, with data point keywords replaced.

Note: This value is not updated until the Axis Updated Interaction is triggered or IsUpdatePending is false for both axes to which this point's series is assigned.
Displayed in Legend [IsDisplayedInLegend]boolIndicates whether this data point is shown in the legend or not if the chart has a legend assigned and the series is displaying legend items for every data point. The default value is True.
Legend Text [LegendText]stringThe text displayed in a legend for this data point. This text can include data point keywords.

Other

ImageImageProperty Name [Script Name]TypeDescription
[IsSelected]boolGets or sets a value indicating whether this point appears selected.

Methods

Constructors

  • DashboardDataPoint ( )
  • DashboardDataPoint ( object xValue, object yValue )
  • DashboardDataPoint ( object xValue, IEnumerable<object> yValues )

Create a DashboardDataPoint with the specified X and Y values.

Parameters:
  • xValue: The X (dimension) value for chart types that plot against an X axis.
  • yValue: The Y (usually metric) value for chart types that plot a single value against a Y axis.
  • yValues: An array, collection or list of Y values (usually metric values) for chart types that plot multiple values against a Y axis.

Reset

  • Reset ( )

Resets the properties of this data point that were customized using script, so that the settings from series point styles, the series or the palettes are used instead.

Related topics




Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.