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.

DashboardDataSeries Class

Hide navigation
RSS
Modified on Thu, 20 Jun 2013 04:06 PM Categorized as Library Reference
Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties

Table of Contents [Hide/Show]


Represents a series of chart data points.

DashboardDataSeries is a DashboardControl, and is the base class for the following classes:

Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
[Chart]DashboardChartGets the chart this series is associated with.
Chart Type [ChartType]DashboardSeriesChartTypeThe chart type used to plot the series.
ImageData Annotations [DataAnnotationSettings]DashboardAnnotationCollectionThe settings for each data annotation column in the KPI, if this series displays a KPI's measures.

Note: Setting the Mouse Cursor on data annotations after they have been displayed will have no effect.
ImageData Table Format [DataTableFormatString]stringThe format used when the values of this series are displayed in a data table with the X Axis labels.
ImageInclude In Data Table [IsDisplayedInDataTable]boolDetermines if this series is included in the X axis data table if it is displayed.
[Points]DashboardDataPointCollectionGets the data points of this series.
Tooltip Text [ToolTipText]stringThe text displayed when the user hovers over a data point with their mouse. This text can include data point keywords.
X Axis [XAxisIndex]intSets the X axis used by this series when there are multiple axes.
X Axis Label Groupings [XAxisLabelGroupings]DashboardAxisLabelGroupingCollectionDefines extra rows of labels to display along the X axis to group together axis dimension values.
ImageX Axis Label Text [XAxisLabelText]stringThe label text displayed corresponding to data points of this series along the X axis. This text can include data point keywords.
X Axis Type [XAxisType]DashboardAxisTypeThe type of X axis to plot this series against. Primary X axes are on the bottom by default; secondary on the top.
[XAxis]DashboardAxisGets the X axis for this series.
Y Axis [YAxisIndex]intSets the Y axis used by this series when there are multiple axes.
ImageY Axis Label Groupings [YAxisLabelGroupings]DashboardAxisLabelGroupingCollectionDefines extra rows of labels to display along the Y axis to group together Y axis dimension or metric values.
Y Axis Type [YAxisType]DashboardAxisTypeThe type of Y axis to plot this series against. Primary Y axes are on the left by default; secondary on the right.
[YAxis]DashboardAxisGets the Y axis for this series.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageChange Point Style [ChangePointStyle]DashboardDataPointThe data point style used for the data points calculated as change points in this series. Reset to None (null in script) to display like the rest of the series.
ImageImageChange Point Threshold [ChangePointThreshold]doubleThe minimum likelihood that a data point represents a change, used to determine if Change Point Style is applied.
ImageEasing Animations Enabled [IsEasingEnabled]boolIndicates whether animations are used to display changes gradually when the data changes.
ImageImageEasing Duration [EasingDuration]TimeSpanThe duration of the animation used for each data point when data changes.
ImageEasing Enabled On Load [UseEasingOnLoad]boolIndicates whether the data is animated when first loaded if easing animations are enabled.
ImageImageEasing Function [EasingFunction]DashboardEasingFunctionThe easing function used for each data point when data changes.
ImageEmpty Point Style [EmptyPointStyle]DashboardDataPointThe data point style used for empty data points in this series when the KPI or dataset is set to calculate empty data points. Reset to None (null in script) to display like the rest of the series.
ImageFill [Fill]DashboardBrushThe fill brush to apply to each data point in the series. Reset to Use Palette (null in script) to use the palettes.
ImageFirst Point Style [FirstPointStyle]DashboardDataPointThe data point style used for the first data point of this series. Reset to None (null in script) to display like the rest of the series.
ImageHigh Point Style [HighPointStyle]DashboardDataPointThe data point style used for the highest data points of this series. Reset to None (null in script) to display like the rest of the series.
ImageImageLabel Fade Duration [LabelFadeDuration]TimeSpanThe length of time it takes to fade in labels and annotations after an animation completes.
ImageLast Point Style [LastPointStyle]DashboardDataPointThe data point style used for the last data point of this series. Reset to None (null in script) to display like the rest of the series.
ImageLow Point Style [LowPointStyle]DashboardDataPointThe data point style used for the lowest data points of this series. Reset to None (null in script) to display like the rest of the series.
ImageMarker Fill [MarkerFill]DashboardBrushThe brush used to fill the marker. Reset to Use Palette (null in script) to use the palettes.
ImageMarker Shape [MarkerShape]DashboardMarkerShapeThe shape of the marker. Reset to None to use the palettes.
ImageMarker Stroke [MarkerStroke]DashboardBrushThe brush used to draw the marker's edges. Reset to Use Palette (null in script) to use the palettes.
ImageMarker Stroke Thickness [MarkerStrokeThickness]doubleThe thickness of the marker's stroke in pixels. Reset to Auto (double.NaN in script) to use the palettes.
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 markers.
ImageImageOutlier Method [OutlierMethod]DashboardOutlierMethodThe mathematical method used to determine which data points in this series are outliers for Outlier Point Style. Outlier Threshold is used differently for each method.
ImageOutlier Point Style [OutlierPointStyle]DashboardDataPointThe data point style used for the data points calculated as outliers in this series. Reset to None (null in script) to display like the rest of the series.
ImageImageOutlier Threshold [OutlierThreshold]doubleThe threshold used to determine if a data point is styled using Outlier Point Style. This value is used differently depending on Outlier Method.
ImagePoints Custom Palette [PointsCustomPalette]DashboardPaletteDataPointCollectionThe palette settings applied in sequence to each point in this series.

Note: After this property is customized, the Points Palette property will be set to Custom.
ImagePoints Palette [PointsPalette]DashboardChartColorPaletteThe palette of colors applied in sequence to the fill of each point in this series. If set to None, the Series Palette or Series Custom Palette property will be used.

Note: The colors of the selected palette will be available in the Points Custom Palette property.
ImageState Styles [StateStyles]DashboardStateDataPointCollectionThe data point styles used for data points with values within the specified KPI or dataset states.
ImageStroke [Stroke]DashboardBrushThe brush used to draw the edges of each data point in the series. Reset to Use Palette (null in script) to use the palettes.
ImageImageStroke Pattern [StrokePattern]DashboardLinePatternTypeThe pattern applied to the stroke of each data point in the series. Reset to Auto to use the palettes.
ImageStroke Thickness [StrokeThickness]doubleThe thickness of the stroke in pixels. Reset to Auto to use the palettes.
ImageImageTrend Animation Duration [TrendAnimationDuration]TimeSpanThe total duration of the sequence of animations for each data point performed during a trend animation.
ImageImageTrend Animation Easing Function [TrendAnimationEasingFunction]DashboardEasingFunctionThe easing function used to progress through the data points in sequence during a trend animation.

Note: DashboardBounceEase and DashboardElasticEase are not supported for trend animations.
ImageTrend Animation Enabled [IsTrendAnimationEnabled]boolIndicates whether each data point of this series is animated in sequence when loaded. Trend animations take priority over easing animations for new data points when enabled.

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. Reset to Auto (double.NaN in script) to use the palettes.
ImageMarker Width [MarkerWidth]doubleThe width of the marker in pixels. Reset to Auto (double.NaN in script) to use the palettes.
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.
ImageZ-Index [ZIndex]intThe 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
ImageImageHide Overlapped Labels [IsOverlappedLabelHidden]boolIndicates whether series labels that cannot be prevented from overlapping with other labels are hidden. The default value is True. This applies only to standard label positioning.
ImageImageLabel Alignment [LabelAlignment]DashboardAnchorAlignmentThe alignment of the label relative to the data point Y-value. The default value is Auto. This applies only to standard label positioning.
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.
ImageImageLabel Offset [LabelOffset]doubleThe offset of the label away from the data point Y-value in pixels. The default value is 5. This applies only to standard label positioning.
Label Text [LabelText]stringThe label text for the data points of this series. This text can include data point keywords.
ImageImageLabel Visual Effect [LabelVisualEffect]DashboardEffectThe visual effect applied to the data point labels.
ImageImageLabels Interactive [IsLabelInteractive]boolIndicates whether series labels share tooltips, mouse cursor settings and mouse interactions with their data points. The default value is False.
ImageImageLeader Line Visibility [LabelLeaderLineVisibility]DashboardLeaderLineVisibilityDetermines when leader lines are displayed between data points and their associated labels. The default value is Auto. This applies only to standard label positioning.
ImageImageMaximum Moving Distance [LabelMaxMovingDistance]doubleThe maximum distance in pixels labels can be moved to prevent overlap when Label Alignment is Auto. The default value is 300. This applies only to standard label positioning.
Show Y-Value Label [IsValueShownAsLabel]boolIndicates whether the first Y-value is shown as a data point label for the points of this series.

Note: If text is specified using the Label Text property, this property is ignored.

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

Legend

ImageImageProperty Name [Script Name]TypeDescription
Legend Category [LegendCategory]stringThe category of the legend items for this series.
Legend Text [LegendText]stringThe text displayed in a legend for this data series. This text can include data point keywords if the Type of Items Displayed property is set to DataPoints.
Reverse Legend Items [LegendItemsAreReversed]boolIndicates whether legend items from the series data points are displayed in reverse order.
ImageType of Items Displayed [LegendDisplayMode]DashboardLegendDisplayModeIndicates how this data series and its points are displayed in the legend.

Data

ImageImageProperty Name [Script Name]TypeDescription
ImageReset Bound Points [BoundPointsAreReset]boolDetermines if data point properties customized through script are automatically reset when data changes.

Other

ImageImageProperty Name [Script Name]TypeDescription
[DataDescriptor]DashboardDataDescriptorGets the data descriptor representing the Dashboard data displayed by this series.
[IsSelected]boolGets or sets a value indicating whether this series appears selected.

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.