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.

DashboardContent Class

Hide navigation
RSS
Modified on Tue, 02 Apr 2013 10:36 AM

This class represents the content of your dashboard.

Properties

ImageImageProperty Name [Script Name]TypeDescription
ActualHeight [ActualHeight]doubleGets or sets the actual height of this dashboard.
ActualWidth [ActualWidth]doubleGets or sets the actual width of this dashboard.
AdditionalInfoUrl [AdditionalInfoUrl]stringGets or sets the additional info URL.
AnalyticalCommands [AnalyticalCommands]DdObservableCollection
<object>
Gets or sets the analytical commands.
AnalyticalCommandsDataContract [Not_accessible_in_script_editor]stringGets or sets the analytical commands data contract.
AnalyticalDataDescriptors [AnalyticalDataDescriptors]Collection
<DashboardAnalyticalDataDescriptor>
Gets or sets the analytical data descriptors.
Background [Not_accessible_in_script_editor]DashboardBrushGets or sets the background of the dashboard.
CustomContextMenuCommands [CustomContextMenuCommands]InteractionCommandCollectionGets or sets the custom context menu commands.
DashboardId [DashboardId]GuidGets the dashboard ID.
DashboardParameters [DashboardParameters]Collection
<DashboardParameter>
Gets or sets the parameters on this dashboard.
DashboardSettings [Not_accessible_in_script_editor]Dictionary<string,object>Gets or sets the dashboard settings.
DataDescriptors [DataDescriptors]Collection
<DashboardDataDescriptor>
Gets or sets the data descriptors.
Description [Description]stringGets the description.
Height [Height]doubleGets or sets the height of the dashboard.
HorizontalGuidelines [Not_accessible_in_script_editor]Collection
<DashboardHorizontalGuideline>
Gets or sets the height of the dashboard.
IsAnalytical [IsAnalytical]boolGets or sets a value indicating whether this dashboard is an analytical dashboard.
IsAnnotationsDisabled [Not_accessible_in_script_editor]boolGets or sets a value indicating whether annotations are disabled on this entire dashboard.
IsContextMenuEnabled [Not_accessible_in_script_editor]boolGets or sets a value indicating whether all of the controls have their context menu enabled on this dashboard. This value overrides the value set on the element level, so if this is not enabled, no elements will show their context menu.
IsDesignTimeMode [Not_accessible_in_script_editor]boolGets or sets a value indicating whether this instance is in design time mode. If so, interactions will be ignored.
MaxHeight [Not_accessible_in_script_editor]doubleGets or sets the maximum height of the dashboard.
MaxWidth [Not_accessible_in_script_editor]doubleGets or sets the maximum width of the dashboard.
MinHeight [Not_accessible_in_script_editor]doubleGets or sets the minimum height of the dashboard.
MinWidth [Not_accessible_in_script_editor]doubleGets or sets the minimum width of the dashboard.
Name [Name]stringGets or sets the dashboard's name.
ProjectId [ProjectId]GuidGets the project ID.
ResizeMode [Not_accessible_in_script_editor]DashboardResizeModeGets or sets the resize mode.
ThemeResourceKey [Not_accessible_in_script_editor]ThemeResourceKeyGets or sets the theme id for this dashboard.
VerticalGuidelines [Not_accessible_in_script_editor]Collection
<DashboardVerticalGuideline>
Gets or sets the vertical guidelines.
VisualObjects [VisualObjects]Collection
<DashboardElement>
Gets or sets the visual objects that will appear on the dashboard.
Width [Width]doubleGets or sets the width of the dashboard.

Methods

GetAnalyticalDataDescriptorByName

Gets the analytical data descriptor by name. Returns the analytical data descriptor if found, or null if not.


Where:
  • name - The name of the analytical data descriptor.

GetAnalyticalDataDescriptorsByAnalyticalVisualObjectName

Gets the name of the data descriptors by analytical visual object name.


Where:
  • name - The name of the analytical visual object.

GetDashBlockViewerControls

Gets the dashblock viewer controls.

  • Collection<DashBlockViewer> GetDashBlockViewerControls()

GetDashboardAnalyticalControls

Gets the dashboard analytical controls.

  • Collection<DashboardAnalyticalControl> GetDashboardAnalyticalControls()

GetDashboardDataVisualizationControls

Gets the dashboard data visualization controls.

  • Collection<DashboardDataVisualizationControl> GetDashboardDataVisualizationControls()

GetDashboardParameterByName

Gets the dashboard parameter by name. Returns null if no matching parameter is found.


Where:
  • name - The name of the parameter.

GetDashboardParametersByDataDescriptor

Gets the dashboard parameters by data descriptor. Returns the dashboard parameters or an empty collection.


Where:
  • descriptor - The descriptor.
  • descriptorName - The name of the descriptor.

GetDashboardParameterVisualObjectByName

Gets the parameter visual object by name. Returns null if no match is found, or the parameter control if found.


Where:
  • name - The name of the parameter visual object.

GetDataDescriptorByName

Gets the data descriptor by name. Returns the data descriptor if found, or null if not.


Where:
  • name - The name of the data descriptor.

GetDataDescriptorByToken

Gets the data descriptor by token. Returns the data descriptor if found, or null if not.


Where:
  • tokenId - The token id.

GetDataDescriptorsByDataVisualizationObjectName

Gets the name of the data descriptors by data visualization object name. Returns a collection which may be empty.


Where:
  • name - The name of the data visualization object.

GetDataResultDimensionGrain

Gets the data result dimension grain. This is used in the DataGrid's on-demand data retrieval code.


Where:
  • columnId - The column id.
  • dataDescriptor - The data descriptor.

GetGroupCurrentPosition

Gets the group's current position (top left x,y). Returns an empty point, or the group's current top/left position.

  • Point GetGroupCurrentPosition( string groupName )

Where:
  • groupName - The name of the group.

GetVisibleAndExportableDashboardControls

Gets the dashboard controls that consume data, are visible and are exportable.


GetVisualObjectByName

Return the named visual object.


Where:
  • name - The name of the visual object.

GetVisualObjectsByGroup

Gets the visual objects by group name. Returns a collection of the elements belonging to the group, or an empty collection if the group isn't found.


Where:
  • groupName - The name of the group.

SetGroupPosition

Sets the group's position.

  • void SetGroupPosition( string groupName, int newLeft, int newTop )

Where:
  • groupName - The name of the group.
  • newLeft - The new left position.
  • newTop - The new top position.

SetGroupProperty

Sets a property on all elements within a group.

  • void SetGroupProperty( string groupName, string propertyName, object newValue )

Where:
  • groupName - The name of the group.
  • propertyName - The name of the property.
  • newValue - The new value. The type of this value must match the expected type for the property.

SetGroupVisibility

Sets the group's visibility.

  • void SetGroupVisibility( string groupName, bool isVisible )

Where:
  • groupName - The name of the group.
  • isVisible - If set to true, then the group is made visible; otherwise the group is made invisible.

Related topics


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

Copyright © 2009-2014 Dundas Data Visualization, Inc.