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.

Gauge - Properties

Hide navigation
RSS
Modified on Fri, 22 Nov 2013 03:13 PM Categorized as Data Controls, Gauge
Click to return to: Documentation | Designing Dashboards | DV Controls | Gauge


Overview

This article describes the properties of Dundas Dashboard Gauge controls. For introductions and walkthroughs on gauge features, see Using Gauges.

For quick reference, here is the primary gauge element hierarchy, which can help you identify where to find properties for each gauge element and to navigate to them 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

Note: Some properties, or property types, apply only to specific types of gauge controls.

Common

ImageImageProperty Name [Script Name]TypeDescription
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
ImageDisable Exporting [Not_accessible_in_script_editor] If 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.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.

ImageImageProperty Name [Script Name]TypeDescription
Pointers [Pointers]ObservableCollection<DashboardLinearPointer> or ObservableCollection<DashboardRadialPointer>Collection of pointers for the primary scale.
Ranges [Not_accessible_in_script_editor]ObservableCollection<DashboardLinearRange> or ObservableCollection<DashboardRadialRange>Collection of ranges for the primary scale.
ImageScales [Scales]ObservableCollection<DashboardLinearScale> or ObservableCollection<DashboardRadialScale>The collection of scales for the gauge.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageAuto Range Fill [IsAutoRangeFillEnabled]boolDetermines if different shades of the Auto Range Fill Brush are automatically applied to the fills of ranges.

Note: This property is available only for the bullet graph gauge type.
ImageAuto Range Fill Brush [AutoRangeFill]DashboardBrushA brush to base range fills on when Auto Range Fill is enabled.

Note: This property is available only for the bullet graph gauge type.
ImageBackground [Background]DashboardBrushThe background brush of the control.
ImageFrame Brush [FrameBrush]DashboardBrushThe frame brush.
ImageFrame Shape [FrameShape]DashboardLinearGaugeFrameShape or DashboardRadialGaugeFrameShapeThe shape of gauge frame.
ImageFrame Thickness [FrameThickness]DashboardUnitLengthThe thickness of the gauge frame.
ImageImageFrame Visual Effect [FrameVisualEffect]DashboardEffectThe visual effect applied to the frame.
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.
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.

Note: For Bullet Graph only: If Auto Range Fill is set to True, the Auto Range Fill Brush setting will be applied automatically to each of the bullet graph's ranges. This modifies each range's Fill property. To manually set the fill for each range, set Auto Range Fill to False.

Exceptions:

Layout

ImageImageProperty Name [Script Name]TypeDescription
Align Scales With [AlignWithControl]stringA control to align the scales of this gauge with.
ImageAlignment Data Horizontal Group [AlignmentDataHorizontalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align scale 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 scale data vertically separately from other groups.
Alignment Orientations [AlignmentOrientations]DashboardAlignmentOrientationsThe orientations that aligning should be performed in.
ImageAlignment Position Horizontal Group [AlignmentPositionHorizontalGroup]intAssigns a zero or positive group number to match up with other aligned controls to align scale 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 scale positions vertically separately from other groups.
Alignment Types [AlignmentTypes]DashboardAlignmentTypesThe types of alignment to perform with other controls.
ImageAuto Frame Margin [AutoFrameMargin]DashboardUnitLengthThe spacing reserved between the scales and the edge of the frame when Frame Shape is Auto.

Note: This property is only available for the radial gauge type.
[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.
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.
[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 gauge.
Legend Category [LegendCategory]stringThe category of the legend items for this gauge.

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] Indicates whether adding annotations is disabled on this dashboard control. If disabled, viewers will not be able to add 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 Annotations (Design) [Not_accessible_in_script_editor] Determines 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 [AnnotationIndicator]DashboardAnnotationIndicatorThe user annotation indicator settings.

Related topics


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

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.