416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Parameter Cascading Hierarchy Control - Properties

Hide navigation
RSS
Modified on Fri, 22 Nov 2013 04:38 PM Categorized as Parameter Controls
Click to return to: Documentation | Designing Dashboards | Parameter Controls


Overview

This article describes the properties of the Dundas Dashboard Parameter Cascading Hierarchy control, which lets users perform filtering using a cascading hierarchy selector.

This control corresponds to the Hierarchy (Cascade) dashboard control option in the Set Up a Dashboard Parameter wizard.

Parameter Cascading Hierarchy control.

Parameter Cascading Hierarchy control.


By default, each of the drop downs/selectors comprising the control has a fixed width. Use the Selector Width property in the Layout section to change the width of each selector.

The Parameter Cascading Hierarchy control supports autocomplete functionality when its Dropdown Style property is set to Drop Down. In this case, use the Auto Complete Mode property to configure the control's autocomplete behavior. By default, the control will filter the list of items as you type, and also append remaining characters according to a suggested item.

You can enable multiple selection for the cascading hierarchy control on all levels or just the last level. To configure this, right-click the parameter control on the canvas, and then select Configure Parameter Control.

Cascading Hierarchy control with multiple selection on last level and search filter enabled.

Cascading Hierarchy control with multiple selection on last level and search filter enabled.


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
Allow Multiple Selection [Not_accessible_in_script_editor] Determines whether multiple members can be selected.
ImageAuto Complete Mode [CompleteMode]AutoCompleteModeDetermines whether the control will suggest or append items as you type.
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
ImageEnabled [IsEnabled]boolIndicates whether this control can be interacted with. Some controls have a different appearance when not enabled.
First Selectable Level [Not_accessible_in_script_editor] The first selectable level in the hierarchy control.
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.
Labels [LevelNames]DdObservableCollection<ItemName>The labels for the levels in the hierarchy.
Last Level Multiple Selection [IsOnlyLastLevelMultiSelect]boolAllows Multiple Selection only on the last selectable level.
Last Selectable Level [Not_accessible_in_script_editor] The last selectable level in the hierarchy control.
ImageLast Visible Level [Not_accessible_in_script_editor] The last visible level in the hierarchy control.
Name [Name]stringThe name of the control which can be used to reference it with scripting.
Search Filter Enabled [IsSearchFilterEnabled]boolDetermines whether the search filter toolbar is enabled.
ImageToken Menu Visibility [TokenMenuVisibility]VisibilityIndicates whether this control's NamedToken drop-down menu is displayed or not.
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.
ImageButton Border [ButtonBorderBrush]DashboardBrushThe brush used to paint the border of the trigger button.
ImageButton Border Thickness [ButtonBorderThickness]ThicknessThe thickness (in pixels) of the trigger button's border.
ImageImageDialog Background [DialogBackground]DashboardBrushThe brush that fills the popup dialog.
ImageImageDialog Border [DialogBorderBrush]DashboardBrushThe brush used to paint the border of the popup dialog.
ImageImageDialog Border Thickness [DialogBorderThickness]ThicknessThe thickness (in pixels) of the popup dialog's border.
ImageDropdown Border [DropdownBorderBrush]DashboardBrushThe brush used to paint the border of the dropdown controls.
ImageDropdown Border Thickness [DropdownBorderThickness]ThicknessThe thickness (in pixels) of the dropdown controls' border.
ImageFill [Fill]DashboardBrushThe brush that fills the trigger button.
ImageHover-over Fill [MouseOverFill]DashboardBrushThe brush that fills the trigger button when the mouse is hovering over it.
ImageImageMouse Cursor [Cursor]DashboardCursorThe mouse cursor that displays when the viewer puts their mouse overtop of this element.
ImageImageOpacity [Opacity]doubleThe opacity of the control.
ImageSelector Background [SelectorBackground]DashboardBrushThe brush that fills the background of the dropdown selector button.
Style [Not_accessible_in_script_editor] The style to use on this dashboard object.
ImageImageToken Button Background [TokenButtonBackground]DashboardBrushThe brush used to paint the token menu button.
ImageImageToken Button Border [TokenButtonBorderBrush]DashboardBrushThe brush used to paint the border of the token menu button.
ImageImageToken Menu Background [TokenMenuBackground]DashboardBrushThe brush used to paint the token menu.
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.
ImageDropdown Width [DropdownWidth]doubleThe width (in pixels) of the dropdown popup.
Height [Height]doubleThe height of the control.
Horizontal Alignment [HorizontalAlignment]HorizontalAlignmentThe horizontal alignment of the control.
ImageHorizontal Content Alignment [HorizontalContentAlignment]HorizontalAlignmentThe horizontal alignment of the label/control pairs.
ImageLabel Horizontal Alignment [LabelHorizontalAlignment]HorizontalAlignmentThe horizontal alignment of the labels.
ImageLabel Position [LabelDock]DockThe docking position of a labels with respect its corresponding hierarchy viewer (drop-down).
ImageLabel Vertical Alignment [LabelVerticalAlignment]VerticalAlignmentThe Vertical alignment of the labels.
ImageLabel Width [LabelWidth]doubleThe width of the Labels.
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.
ImageOrientation [Orientation]OrientationThe orientation (horizontal or vertical) of the flow of the cascade.
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.
ImageSelector Horizontal Alignment [ViewerHorizontalAlignment]HorizontalAlignmentThe horizontal alignment of the hierarchy viewers (drop-downs).
ImageSelector Vertical Alignment [ViewerVerticalAlignment]VerticalAlignmentThe vertical alignment of the hierarchy viewers (drop-downs).
ImageSelector Width [ViewerWidth]doubleThe width of the hierarchy viewers (drop-downs).
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.
Vertical Alignment [VerticalAlignment]VerticalAlignmentThe vertical alignment of the control.
ImageVertical Content Alignment [VerticalContentAlignment]VerticalAlignmentThe Vertical alignment of the label/control pairs.
Width [Width]doubleThe width of the control.

However, you can set a specific width in pixels which will prevent the dropdown from resizing while you are scrolling a list of items.

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.
ImageLabel Font Brush [LabelForeground]DashboardBrushThe brush used to paint the labels.
ImageLabel Font Family [LabelFontFamily]DashboardFontFamilyThe name of the font used for the labels.
ImageLabel Font Weight [LabelFontWeight]DashboardFontWeightThe weight the font used for the labels.
ImageSelector Foreground [SelectorForeground]DashboardBrushThe brush that fills the triangle on the dropdown selector button.
ImageImageToken Menu Font Brush [TokenMenuForeground]DashboardBrushThe brush used to paint text on the token menu.
ImageToken Menu Font Size [TokenMenuFontSize]doubleThe size of the font (in pixels) used for the token menu 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.
Help Text [HelpText]stringThis is the help text for accessibility.
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.

Behavior

ImageImageProperty Name [Script Name]TypeDescription
ImageDropdown Style [DropDownStyle]DropDownStyleDetermines whether items in the dropdown can be filtered.

Cascading Hierarchy Layout

ImageImageProperty Name [Script Name]TypeDescription
ImageHorizontal Spacing [HorizontalSpacing]doubleThe horizontal spacing (in pixels) between levels within the cascade.
ImageImageLabel Margin [LabelMargin]ThicknessThe margin (in pixels) around the labels.
ImageSelector Height [ViewerHeight]doubleThe height of the hierarchy viewers (drop-downs).
ImageVertical Spacing [VerticalSpacing]doubleThe spacing (in pixels) between rows of levels within the cascade.

Cascading Hierarchy Text

ImageImageProperty Name [Script Name]TypeDescription
ImageLabel Font Size [LabelFontSize]doubleThe size of the font (in pixels) used for the labels.
ImageLabel Font Style [LabelFontStyle]DashboardFontStyleThe style of the font used for the labels.

Parameter

ImageImageProperty Name [Script Name]TypeDescription
ImageParameter Name [Not_accessible_in_script_editor] The name of the underlying dashboard parameter which this control acts on.
ImageUpdate Type [UpdateType]DashboardParameterUpdateTypeSpecifies how this parameter updates, Automatic (when the control value changes), or Manual (in conjunction with the Filter Update Control).

Notes

  • By default, the Dropdown Width is set to Auto which means the width is determined automatically based on the length of the items in the dropdown list. This means the dropdown will resize dynamically as you scroll through a list of items. This behavior may be undesirable if you have a list of items with very different lengths. In this case, you can set a specific width for the dropdown; this will prevent it from resizing while scrolling.

Related topics


Click to return to: Documentation | Designing Dashboards | Parameter Controls

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.