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.

Chart - Properties

Hide navigation
RSS
Modified on Thu, 21 Nov 2013 06:06 PM Categorized as Chart, Data Controls
Click to return to: Documentation | Designing Dashboards | DV Controls | Chart


Overview

This article describes the properties of the Dundas Dashboard Chart controls. For introductions and walkthroughs on chart features, see Using Charts.

For quick reference, here is the primary chart element hierarchy, which can help you identify where to find properties for each chart element and to navigate to it directly:


Property attributes

Each property of the control may have attributes as follows:

Property attribute
ImageThis is an Advanced property.
ImageThis is a property that can be saved into a Style Resource.

Also, note that a property appearing without a Property Name is accessible via scripting only.


Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
ImageChart Cursor [ChartCursor]DashboardCursorSettingsThe settings to apply to the zooming and selection cursor. (Hidden for Pie and Funnel charts.)
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
ImageDisable Exporting [Not_accessible_in_script_editor]boolIf this is set to true, this control will not appear in the export wizard or be available for export in any other way.
ImageEnabled [IsEnabled]boolIndicates whether this control can be interacted with. Some controls have a different appearance when not enabled.
ImageExport Order [Not_accessible_in_script_editor] Defines an order in which the control is exported.
Friendly Name [FriendlyName]stringThe friendly name of the control which will appear to viewers and should be easily identifiable for them.
ImageHit Test Visible [IsHitTestVisible]boolIndicates whether this element can be interacted with.
Name [Name]stringThe name of the control which can be used to reference it with scripting.
[Quadrant1]DashboardQuadrantSettingsThe settings for customizing the quadrant of the chart where the X and Y axes both reach their maximum, usually top-right.
[Quadrant2]DashboardQuadrantSettingsThe settings for customizing the quadrant of the chart where the X axis reaches its minimum and the Y axis reaches its maximum, usually top-left. (Only applies to rectangular charts with the Y axis crossing the X axis higher than its minimum.)
[Quadrant3]DashboardQuadrantSettingsThe settings for customizing the quadrant of the chart where both the X and Y axes reach their minimum, usually bottom-left. (Only applies to rectangular charts with X and Y axes crossing each other higher than their minimums.)
[Quadrant4]DashboardQuadrantSettingsThe settings for customizing the quadrant of the chart where the X axis reaches its maximum and the Y axis reaches its minimum, usually bottom-right. (Only applies to rectangular charts with the X axis crossing the Y axis higher than its minimum.)
ImageQuadrants [Not_accessible_in_script_editor]The settings for customizing the quadrants of the chart, which can appear when using axis crossing.
ImageSeries [Series]DashboardDataSeriesCollectionThe series of data points displayed in the chart. Each series corresponds to a KPI or dataset.
Switch X & Y Axes [AxesAreTransposed]boolIndicates whether the X and Y axes are transposed for rectangular charts, so that the X axes are vertical and the Y horizontal. (Hidden for Pie and Funnel charts.)
ImageTimeout [Timeout]intThe maximum amount of time allowed for the chart to take to display in milliseconds before cancelling.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.
ImageX Axes [XAxes]DashboardAxisCollectionThe primary X axes within the chart, displayed on the bottom by default. (Hidden for Pie and Funnel charts.)
ImageX Secondary Axes [X2Axes]DashboardAxisCollectionThe secondary X axes within the chart, displayed on the top by default. (Hidden for Pie and Funnel charts.)
[XViewport]DashboardViewportSettingsThe settings for zooming and scrolling in script along the X axes of the chart.
ImageY Axes [YAxes]DashboardAxisCollectionThe primary Y axes within the chart, displayed on the left by default. (Hidden for Pie and Funnel charts.)
ImageY Secondary Axes [Y2Axes]DashboardAxisCollectionThe secondary Y axes within the chart, displayed on the right by default. (Hidden for Pie and Funnel charts.)
[YViewport]DashboardViewportSettingsThe settings for zooming and scrolling in script along the Y axes of the chart.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageBackground [Background]DashboardBrushThe background brush of the control.
ImageBorder Brush [BorderBrush]DashboardBrushThe border of the control.
ImageBorder Thickness [BorderThickness]ThicknessThe thickness (in pixels) of the border.
ImageImageBottom [Bottom]doubleThe bottom border thickness, in pixels.
ImageImageLeft [Left]doubleThe left border thickness, in pixels.
ImageImageRight [Right]doubleThe right border thickness, in pixels.
ImageImageTop [Top]doubleThe top border thickness, in pixels.
ImageMouse Cursor [Cursor]DashboardCursorThe mouse cursor that displays when the viewer puts their mouse overtop of this element.
ImageImageOpacity [Opacity]doubleThe opacity of the control.
ImagePlotting Area Background [PlottingAreaBackground]DashboardBrushThe brush used to fill the background of the plotting area, located on the inside of the axes. (Hidden for Pie and Funnel charts.)
ImageSeries Custom Palette [SeriesCustomPalette]DashboardPaletteDataPointCollectionThe palette settings applied in sequence to each series.

Note: After this property is customized, the Series Palette property will be set to Custom.
ImageSeries Palette [SeriesPalette]DashboardChartColorPaletteThe palette of colors applied in sequence to the fill of each series.

Note: The colors of the selected palette will be available in the Series Custom Palette property.
Style [Not_accessible_in_script_editor]The style to use on this dashboard object.
ImageVisibility [Visibility]VisibilityIndicates whether this control is visible or not. If it is collapsed, it will not be visible.
ImageImageVisual Effect [VisualEffect]DashboardEffectThe visual effect applied to this element.

Layout

ImageImageProperty Name [Script Name]TypeDescription
Align Axes With [AlignWithControl]stringA control to align the axes of this chart with. (Advanced for Pie and Funnel charts.)
ImageAlignment Data Horizontal Group [AlignmentDataHorizontalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align axis data horizontally separately from other groups.
ImageAlignment Data Vertical Group [AlignmentDataVerticalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align axis data vertically separately from other groups.
Alignment Orientations [AlignmentOrientations]DashboardAlignmentOrientationsThe orientations that aligning should be performed in. (Advanced for Pie and Funnel charts.)
ImageAlignment Position Horizontal Group [AlignmentPositionHorizontalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align axis positions horizontally separately from other groups.
ImageAlignment Position Vertical Group [AlignmentPositionVerticalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align axis positions vertically separately from other groups.
Alignment Types [AlignmentTypes]DashboardAlignmentTypesThe types of alignment to perform with other controls. (Advanced for Pie and Funnel charts.)
[BottomGuidelineName]stringThe name of the bottom guideline.
ImageBottom Pin [BottomPin]boolIndicates whether the bottom pin is enabled or not.
Height [Height]doubleThe height of the control.
Left [Left]doubleThe left is how far from the left side the control resides.
[LeftGuidelineName]stringThe name of the left guideline.
ImageLeft Pin [LeftPin]boolIndicates whether the left pin is enabled or not.
ImageMargin [Margin]ThicknessThe margin around the outside of the control in pixels.
ImageBottom [Bottom]doubleThe bottom margin thickness, in pixels.
ImageLeft [Left]doubleThe left margin thickness, in pixels.
ImageRight [Right]doubleThe right margin thickness, in pixels.
ImageTop [Top]doubleThe top margin thickness, in pixels.
ImageMaximum Height [MaxHeight]doubleSets the maximum height for a control. During re-size, the control will not go more than this value.
ImageMaximum Width [MaxWidth]doubleSets the maximum width for a control. During re-size, the control will not go more than this value.
ImageMinimum Height [MinHeight]doubleSets the minimum height for a control. During re-size, the control will not go less than this value.
ImageMinimum Width [MinWidth]doubleSets the minimum width for a control. During re-size, the control will not go less than this value.
ImageImagePadding [Padding]ThicknessThe padding around the inside of the control in pixels.
ImageImageBottom [Bottom]doubleThe bottom padding thickness, in pixels.
ImageImageLeft [Left]doubleThe left padding thickness, in pixels.
ImageImageRight [Right]doubleThe right padding thickness, in pixels.
ImageImageTop [Top]doubleThe top padding thickness, in pixels.
[RightGuidelineName]stringThe name of the right guideline.
ImageRight Pin [RightPin]boolIndicates whether the right pin is enabled or not.
Top [Top]doubleThe top is how far from the top the control resides.
[TopGuidelineName]stringThe name of the top guideline.
ImageTop Pin [TopPin]boolIndicates whether the top pin is enabled or not.
Width [Width]doubleThe width of the control.

Text

ImageImageProperty Name [Script Name]TypeDescription
ImageImageCustom Font [CustomFont]stringA comma-separated list of font names to use when the value of Font Family is set to <Custom>.
ImageFont Brush [Foreground]DashboardBrushThe brush used to paint text.
ImageFont Family [FontFamily]DashboardFontFamilyThe name of the font used for text.
ImageFont Size [FontSize]doubleThe size of the font (in pixels) used for text.
ImageFont Style [FontStyle]DashboardFontStyleThe style of the font used for text.
ImageFont Weight [FontWeight]DashboardFontWeightThe weight or thickness of the font used for text.

Legend

ImageImageProperty Name [Script Name]TypeDescription
Legend [Legend]stringThe name of the legend on the dashboard which will display the entries from this chart.
Legend Category [LegendCategory]stringThe category of the legend items for this chart.
Reverse Legend Items [LegendItemsAreReversed]boolIndicates whether legend items representing each data series of this chart are displayed in reverse order.

Other

ImageImageProperty Name [Script Name]TypeDescription
ImageAccelerator Key [AcceleratorKey]stringThis is the accelerator key for accessibility.
ImageAccess Key [AccessKey]stringThis is the access key for accessibility.
ImageAnnotation Adding Disabled [Not_accessible_in_script_editor]boolIndicates whether adding user annotations is disabled on this dashboard control. If disabled, viewers will not be able to add user annotations to this control.
ImageCustom Context Menu Commands [CustomContextMenuCommands]InteractionCommandCollectionThe custom commands appended to the context menu for the dashboard and any elements which don't have their own context menu.
[DataDescriptors]Collection<DashboardDataDescriptor>A collection containing a descriptor for each KPI or dataset displayed on this control.
ImageDisable Loading Data [IsLoadingDataDisabled]boolPrevents the control from loading data.
Help Text [HelpText]stringThis is the help text for accessibility.
ImageHover Delay [HoverDelay]doubleThe number of seconds that have to elapse before the hover interaction event fires.
Show User Annotation (Design) [Not_accessible_in_script_editor]boolDetermines if the annotation indicator is visible at design time.
ImageTab Index [TabIndex]intThe index that this item is in the tab order.
ImageTab Navigation [TabNavigation]KeyboardNavigationModeThe way tab is navigated to/from within this control.
[Tag]objectUsed to store an arbitrary object in script.
ImageUser Annotation Indicator [UserAnnotationIndicator]DashboardChartAnnotationIndicatorThe user annotation indicator settings.

Note: Setting the User Annotation Indicator's Mouse Cursor after annotations have been displayed will have no effect.

Methods

InvalidateChartLayout

Invalidates the layout of chart elements, causing them to be re-positioned and re-plotted according to the current chart size and viewport.

  • InvalidateChartLayout()

Note: The chart re-plots automatically when any property or the displayed data is changed, so this method normally does not need to be called.

Refresh

Refreshes the data from the KPIs and Datasets displayed by the control.


Parameters:
  • descriptorsToRefresh: If specified, only these descriptors will be refreshed.

Related topics


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

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.