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.

Map - Properties

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

Table of Contents [Hide/Show]


Overview

This article describes the properties of the Dundas Dashboard Map control.

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
[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.
ImageImageEnable Mouse Panning [IsMousePanningEnabled]boolWhether mouse panning is enabled.
ImageEnable Mouse Wheel Zooming [IsMouseWheelZoomEnabled]boolWhether mouse wheel zooming is enabled.
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.
ImageMouse Wheel Zoom Percent [MouseWheelZoomPercent]doubleThe percentage zoom to be applied on a single mouse wheel event.
Name [Name]stringThe name of the control which can be used to reference it with scripting.
Paths [Paths]DashboardMapPathCollectionThe collection of paths.
Shapes [Shapes]DashboardMapShapeCollectionThe collection of shapes.
Symbols [Symbols]DashboardMapSymbolCollectionThe collection of symbols.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.

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.
ImageDefault Path Brush [DefaultPathBrush]DashboardBrushThe default brush used to draw the path, when there is no data attached.
ImageDefault Path Thickness [DefaultPathThickness]doubleThe default path thickness, when there is no data attached.
ImageDefault Shape Border Brush [DefaultShapeBorderBrush]DashboardBrushThe default shape border brush, when there is no data attached.
ImageDefault Shape Border Width [DefaultShapeBorderWidth]doubleThe default shape border width.
ImageDefault Shape Fill Brush [DefaultShapeFillBrush]DashboardBrushThe default shape fill, when the shape has no data attached.
ImageDefault Symbol Border Brush [DefaultSymbolBorderBrush]DashboardBrushThe default symbol border brush.
ImageDefault Symbol Border Width [DefaultSymbolBorderWidth]doubleThe default symbol border width.
ImageDefault Symbol Fill Brush [DefaultSymbolFillBrush]DashboardBrushThe default symbol fill, when the symbol has no data attached.
ImageDefault Symbol Height [DefaultSymbolHeight]doubleThe default symbol height, when there is no data attached.
ImageDefault Symbol Marker Shape [DefaultSymbolMarkerShape]DashboardMarkerShapeThe default symbol marker shape, when there is no data attached.
ImageDefault Symbol Width [DefaultSymbolWidth]doubleThe default symbol width, when there is no data attached.
ImageLabels [Labeling]DashboardLabelingSettings for labeling (alignment, visibility, etc).
ImageMap Grid [MapGrid]DashboardMapGridSettings for the map grid / grid lines.
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.
Projection Settings [MapProjection]DashboardMapProjectionSettings related to the map's current projection.
ImageScroll Panel [ScrollPanel]DashboardScrollPanelThe scroll panel, which can be used in place of mouse panning.
Style [Not_accessible_in_script_editor] The style to use on this dashboard object.
Viewport [Viewport]DashboardMapViewportThe viewport, which represents the visible map area in the control.
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.
ImageZoom Panel [ZoomPanel]DashboardZoomPanelThe zoom panel, which can be used in place of mouse wheel zooming.

Layout

ImageImageProperty Name [Script Name]TypeDescription
[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.
ImageImagePadding [Padding]ThicknessThe padding around the inside of the control 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.

Data

ImageImageProperty Name [Script Name]TypeDescription
Color Rules [ColorRules]DashboardColorRulesCollectionCollection of rules used for binding data.
Marker Rules [MarkerRules]DashboardMarkerRulesCollectionCollection of rules used for binding data that determines the text of various elements.
Size Rules [SizeRules]DashboardSizeRulesCollectionCollection of rules used for binding data that determines the size of various elements.
Text Rules [TextRules]DashboardTextRulesCollectionCollection of rules used for binding data that determines the text of various elements.

Legend

ImageImageProperty Name [Script Name]TypeDescription
Legend [Legend]stringThe name of the legend on the dashboard which will display the entries from this map.

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 [IsAnnotationAddingDisabled]boolIndicates 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.
[MapSources]DdObservableCollection<MapResourceDescriptor>Gets the map sources.
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]DashboardMapAnnotationThe user annotation indicator settings.

Related topics


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

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.