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.

Legend - Properties

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


Overview

This article describes the properties of the Dundas Dashboard Legend 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
Custom Legend Items [CustomLegendItems]ObservableCollection
<DashboardLegendItem>
A collection of custom legend items.
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
Empty Category Name [EmptyCategoryName]stringThe empty category name of the legend.
ImageEnable Item Merging [MergeLegendItems]boolIndicates whether legend items with the same text, marker shape and marker color will be merged into a single legend item or not.
ImageEnabled [IsEnabled]boolIndicates whether this control can be interacted with. Some controls have a different appearance when not enabled.
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.
[LegendItems]List<DashboardLegendItem>The legend items.
Name [Name]stringThe name of the control which can be used to reference it with scripting.
Title [Title]stringThe title of the legend.
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.
ImageCategory Heading Appearance [CategoryHeadingAppearance]DashboardHeadingAppearanceAppearance properties for the text of category headings.
Category Visibility [CategoryVisibility]DashboardCategoryHeadingVisibilityIndicates whether categories headings are visible or not.
Item Checkbox Visible [IsItemCheckBoxVisible]boolIndicates whether checkboxes should be shown or not.
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.
ImageTitle Appearance [TitleAppearance]DashboardHeadingAppearanceAppearance properties for the text of category headings.
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
[BottomGuidelineName]stringThe name of the bottom guideline.
ImageBottom Pin [BottomPin]boolIndicates whether the bottom pin is enabled or not.
ImageCategory Sort Order [CategorySortOrder]DashboardLegendItemSortOrderThe sort order of categories.
Height [Height]doubleThe height of the control.
Item Horizontal Alignment [ItemHorizontalAlignment]HorizontalAlignmentThe horizontal alignment of legend items.
ImageImageItem Margin [ItemMargin]ThicknessThe margin of automatically generated legend items.
ImageItem Sort Order [ItemSortOrder]DashboardLegendItemSortOrderThe sort order of legend items.
ImageItem Wrap Behavior [ItemWrapBehavior]DashboardWrapBehaviorIndicates how legend items will wrap. Wrapping can either be at the edge of the control or at after a defined number of pixels in which case scroll bars will be displayed as needed.
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.
ImageMinimum Wrap Height [MinWrapHeight]doubleThe minimum wrap height of the legend. If LegendItemWrapBehavior is set to 'DefinedPixel' legend items in a vertically oriented legend will be displayed until they reach at least this height, at which point wrapping will occur. If this value is greater than the height of the legend scroll bars will be used.
ImageMinimum Wrap Width [MinWrapWidth]doubleThe minimum wrap width of the legend. If LegendItemWrapBehavior is set to 'DefinedPixel' legend items in a horizontally oriented legend will be displayed until they reach at least this width, at which point wrapping will occur. If this value is greater than the width of the legend scroll bars will be used.
Orientation [Orientation]DashboardLegendOrientationThe orientation of legend items.
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.
ImageImageScroll Viewer Padding [ScrollViewerPadding]ThicknessThe padding of the legend scroll viewer.
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.

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.
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.
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.
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.

Related topics


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

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.