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 Instant Hierarchy Viewer - Properties

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


Overview

This article describes the properties of the Dundas Dashboard Parameter Instant Hierarchy Viewer control, which lets users perform multiple selection on a list of instant dimension filter values.

This control corresponds to the Multi-Select Viewer dashboard control option in the Set Up a Dashboard Parameter wizard.

Tip: You can use this parameter control instead of a Check Box List when you have a filter on an instant dimension and have allowed multiple selection. The advantage is that it is consistent in style to the Hierarchy Viewer for full dimensions. However, note that the Multi-Select Viewer always allows multiple selection (i.e. there is no single selection option) and it only displays a one-level hierarchy.

Parameter Instant Hierarchy Viewer control (Multi-Select Viewer).

Parameter Instant Hierarchy Viewer control (Multi-Select Viewer).


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.
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.
Name [Name]stringThe name of the control which can be used to reference it with scripting.
ImageImageToken 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.
ImageImageOpacity [Opacity]doubleThe opacity of the control.
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.
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.
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.

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

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.