DataPA Enterprise Dashboard Controls API Reference

The DashboardObject type exposes the following members.

Constructors

  Name Description
Public method DashboardObject()()()()
Creates and returns a new DashboardObject.
Public method DashboardObject(DashboardObjects)
Creates and returns a new DashboardObject.
Public method DashboardObject(DrillDown)
Creates and returns a new DashboardObject.
Public method DashboardObject(DashboardObjects, DashboardObject..::..DashboardObjectType)
Creates and returns a new DashboardObject.
Public method DashboardObject(DrillDown, DashboardObject..::..DashboardObjectType)
Creates and returns a new DashboardObject.
Public method DashboardObject(DashboardObjects, DashboardObject..::..DashboardObjectType, String)
Creates and returns a new DashboardObject.
Public method DashboardObject(DrillDown, DashboardObject..::..DashboardObjectType, String)
Creates and returns a new DashboardObject.

Methods

  Name Description
Public method BuildGridData
Causes the object to rebuild the Summary Data for a data grid.
Public method BuildParamString
Returns the parameter string to be used when rendering an object.
Public method BuildTreeViewData
Causes the object to rebuild the Treeview nodes for a tree view.
Protected method ColumnIsNumeric
Public method ConvertToLetter
Converts the given column number to a letter or letters, e.g. 1 = A, 27 = AA
Public method CopyToClipboard
Copies this object to the clipboard.
Public method ExportToExcel
Export this dashboard object to Excel 2007 and above (XSLX)
Protected method Finalize (Overrides Object..::..Finalize()()()().)
Public method GetChartResizeScript
Gets the javascript required to resize the chart.
Public method GetColumnFormat
Protected method GetDateFormat
Public method getFilterCondition
Gets a valid DataTable filter condition for a given column and value.
Public method getFilterConditionFromNameType
Gets a valid DataTable filter condition for a given column and value.
Public method GetObjectData
Public method GetObjectImageByteArray
Gets an image array of the dashboard object for the specified size.
Public method KillThread
Kills the background thread (if any) being used to generate XMl.
Public method ReBuildSummaryData
Forces the summary data object to rebuild it's summary table.
Public method RefreshXML
Causes the object to rebuild the XML property.
Public method ResetDataProvider
Resets the dataprovider for this object, forcing it to be rebuilt
Public method ResetSummaryDataTable
Resets the summary data table for this object, forcing it to be rebuilt
Protected method SetHeaderStyle
Protected method SetObjectData
Protected method StripPrefixAndSuffix
Public method UserDependantFilter

Properties

  Name Description
Public property Alerts
Gets and sets the alerts collection for this object
Public property AllowAdvancedXML
Gets a property that indicates if it is possible to specify advanced XML for this object type.
Public property AllowAppearance
Gets a property that indicates if it is possible to specify appearance attributes for this object type.
Public property AllowColour
Gets a property that indicates if this objects supports colour definition.
Public property AllowColourRanges
Gets a property that indicates if this object supports colour ranges
Public property AllowDataGridDefaultColumnFit
Gets a property that indicates if it is possible to specify default column fit type for this object.
Public property AllowDrillDown
Gets a property that indicates if it is possible to specify a drill down object for this object type.
Public property AllowFont
Gets a property that indicates if it is possible to specify a default font for this object type.
Public property AllowForEach
Gets a property that indicates if it is possible to specify for each iteration types.
Public property AllowGlassEffect
Gets a property that indicates if it is possible to specify whether glass effect is visible for this object type.
Public property AllowLineOrAreaColour
Gets a property that indicates if the line or area colour options are shown.
Public property AllowMultipleGroupColumns
Gets a value that indicates whether this object supports multiple group columns.
Public property AllowMultipleSummaryColumns
Gets a value that indicates whether this object supports multiple summary columns.
Public property AllowNoZeroPlot
Gets a property that indicates if it is possible to specify that zero values are not plotted.
Public property AllowPointLabels
Gets a property that indicates if it is possible to specify Point Labels this object type.
Public property AllowScalingUnits
Gets a property that indicates if it is possible to specify advanced scaling units for this object type.
Public property AllowSpecifyLegend
Gets a property that indicates if it is possible to specify whether a legend is visible for this object type.
Public property AllowSubTitles
Gets a property that indicates if it is possible to specify sub titles this object type.
Public property AllowTickMarks
Public property AllowTitles
Gets a property that indicates if it is possible to specify titles this object type.
Public property AllowXAxis
Gets a property that indicates if it is possible to specify x axis attributes for this object type.
Public property AllowYAxis
Gets a property that indicates if it is possible to specify y axis attributes for this object type.
Public property AvailableSummaryColumnDisplayTypes
Gets an array that indicates the valid SummaryDataDisplayTypes for this object type.
Public property BuildingObject
Gets or sets a value that indicates whether or not the object is currently building XML.
Public property Caption
Gets and sets the caption of this object.
Public property ChartHeight
Gets a value that indicates the internal height of the chart object.
Public property ChartWidth
Gets a value that indicates the internal width of the chart object.
Public property Clone
Gets cloned copy of this object (only the ID will be different).
Public property ColumnAlignmentCollection
Public property ColumnFormat
Gets the format string for a given column in this dashboard object.
Public property ColumnHeading
Gets the column heading for a given column in this dashboard object.
Public property ComSourceDataTable
Gets the Source DataTable used to render this object.
Public property ControlPanelBackgroundColour
Gets and sets the background colour for the control panel objects.
Public property ControlPanelObjects
Gets and sets the ControlPanelObjects collection associated with this Dashboard Object.
Public property Dashboard
Gets the ManagedDashboard object that this Dashboard Object belongs too.
Public property DashboardLabelOrientation
Gets and sets value that indicates the orientation of X axis labels for this object.
Public property DashboardQuery
Gets a property that is the DashboardQuery object associated with this DashboardObject.
Public property DataGridDefaultColumnFit
Gets and sets a value that determines the default methid used to fit columns in a datagrid.
Public property DataGridDisplayStyle
Gets and sets a property that determines how a datagrid is rendered.
Public property DataGridFont
Gets and sets the bespoke font that will be used to render this datagrid if DataGridUseBespokeFont is true.
Public property DataGridLayout
Gets and sets an the layout of a DataGrid in the form of an XML string.
Public property DataGridTextColor
Gets and sets the colour of the text used for this data grid if DataGridUseBespokeFont is true.
Public property DataGridUseBespokeFont
Gets and sets a value that indicates if this object should use a bespoke font when rendered as a data grid.
Public property DescendantDashboardObject
Gets the Descendant (drill down) Dashboard Object with the specified ID.
Public property DivHeight
Gets a value that indicates the div height of the chart object.
Public property DrillDown
Gets and sets a DrillDown object representing any drill down options for this object.
Public property DrillDownEnabled
Gets a property that indicates if a drill down object is defined for this object.
Public property DualYAxis
Gets a value that indicates whether this object has a sual Y axis.
Public property Filter
Gets the filter object that filters data for this object
Public property FilterClearedDependantObjects
Gets and sets a collection that contains all dashboard objects that need refreshing because they have had this filter removed.
Public property FilterDependantObjects
Gets a collection that contains all the DashboardObjects that are dependant on this tree view filter panel.
Public property FlashVars
Gets the FlashVars string to support rendering of the chart.
Public property ForceSummaryColumnDisplayType
Gets a value that indicates if the display type for a summary column is defined by which Y axis it is assigned to.
Public property FusionChartType
Gets the Fusion chart type
Public property GaugeData
Gets and sets the GaugeData object that represents numerical information about this dashboard object
Public property GaugeObject
Gets a property that indicates if this object type represents a single summary value (with no groups)
Public property Static member GaugeObject[([( DashboardObject..::..DashboardObjectType])])
Gets a property that indicates if this object type represents a single summary value (with no groups)
Public property GUID
Gets a GUID that uniquely identifies this object.
Public property Height
Gets and sets a value that indicates the height of this object.
Public property HideLabelsIfLegendShown
Gets a property that indicates if labels should be hidden when a legend is shown.
Public property HideZeroValueGroups
Gets and sets a value that indicates whether groups with all zero values should be hidden.
Public property HTML
Generates and returns the HTML required to render this object.
Public property ID
Gets a value that indicates the Unique ID of this object.
Public property InLineXML
Gets a property that indicates if the XML for this chart should be rendered in line with the HTML.
Public property IsDrillDownObject
Gets a property that indicates if this DashboardObject is a drill down DashboardObject.
Public property LastUsedFilter
Gets a string that indicates the filter string used last time the object was rendered.
Public property LimitXAxisLabelLength
Gets and sets a value that indicates if MaxXAxisLabelLength should be applied to X Axis labels on the chart.
Public property LineOrAreaColour
Gets and sets the colour of the line in a line chart.
Public property LoadScript
Gets the script required to load this DashboardObject in a web browser.
Public property MaxXAxisLabelLength
Gets and sets a value that indicates the maximum length of X Axis labels on the chart.
Public property MenuTitle
Gets a value that indicates the title that will be used on the object (build from caption and sub caption properties).
Public property NoDataMessage
Gets the text displayed by this message if no data is available.
Public property NoLeadingZeroPlot
Gets and sets a property that indicates if leading zero values are plotted on the chart.
Public property NoZeroPlot
Public property NumericColumn
Gets a property that indicates if the given column is a numeric column.
Public property ObjectType
Gets or sets a value that indicates the type of this DashboardObject.
Public property OverrideDefaultColourScheme
Gets and sets a value that indicates if the default colour scheme for this object will be overridden
Public property PanelObject
Gets a property that indicates if this object type requires a panel to be rendered.
Public property Parent
Gets and sets an object that represents the parent of this object.
Public property PauseXMLEvents
Gets or sets a value that indicates whether or not any xmlgenerateComplete events will be delayed.
Public property PrimaryYAxis
Gets and sets a YAxis object that represents the primary Y Axis.
Public property ProcessButtonLabel
Gets and sets a label that will be shown on the process button.
Public property ProcessButtonLocation
Gets and sets a value that indicates the location of the process button.
Public property ProcessingObjectData
Gets a property that indicates if the object is currently building the XML string.
Public property RebuildRequired
Gets or sets a value that indicates whether or not the object has been modified since the last call to refreshXML.
Public property SecondaryYAxis
Gets and sets a YAxis object that represents the Secondary Y Axis.
Public property Selected
Gets or sets a value that indicates if this object is selected.
Public property showBorder
Gets and sets value that indicates whether a border should be shown on this object.
Public property ShowCheckAllUnCheckAll
Gets a value that indicates if the Check All and UnCheck All buttons should be shown on the process button bar.
Public property ShowCheckBoxes
Gets and sets a value that indicates if this dashboard object should show checkboxes and a process button in a data grid.
Public property showGlassEffect
Gets and sets value that indicates whether glass effect should be shown on this object.
Public property showLegend
Gets and sets value that indicates whether Legend should be shown on this object.
Public property ShowPivotTotals
Gets and sets a property that determines if the pivot table will show totals.
Public property showPointLabels
Gets and sets value that indicates whether point labels should be shown on this object.
Public property showPointLabelsInside
Gets and sets value that indicates whether point labels should be shown inside the chart on this object.
Public property SourceDataTable
Gets a raw System.Data.DataTable from the query used to build the summary data for the chart.
Public property SubCaption
Gets and sets the sub caption of this object.
Public property SummaryData
Gets and sets the SummaryData object that defines and generates the data used to render this chart.
Public property SuplimentaryXML
Gets and sets any supplementary XML to be applied to this object.
Public property SupplimentaryAttributes
Gets and sets any supplementary attributes to be applied to the chart node of this objects XML
Public property SwfFile
Gets a value that indicates the swf file required to render this object.
Public property SwitchAxisLabels
Gets a value that indicates whether the X and Y axis labels should be switched.
Public property Tab
Gets the DashboardTab object that this Dashboard Object belongs too.
Public property Thread
Gets and sets the thread used by this object to generate XML in the background.
Public property TreeViewNodesCheckedByDefault
Gets and sets a property that indicates if treeview nodes are checked by default.
Public property TrimLeadingXAxisCharacters
Gets and sets a property that indicates if extra characters in X Axis labels should be trimmed from the start rather than the end of the label.
Public property UpdatingFilterObjects
Gets a collection of ControlPanelObjects that cause this object to refresh when the filter value is changed.
Public property verticalPointLabels
Gets and sets a value that indicates whether point labels should be displayed vertically.
Public property Width
Gets and sets a value that indicates the width of this object.
Public property xAxisName
Gets and sets a value that will be used as the name of the X Axis.
Public property XML
Gets the XML required to render this object.
Public property XmlDefinitionType
Gets the the XML definition type of this object.
Public property XmlUrl
Gets the url that retrieves the XML data for this object.

Events

  Name Description
Public event DataGridLayoutUpdateRequest
Event fired when the DataGridLayout property is queried.
Public event GridDataGenerateComplete
Event fired when the object has completed the BuildGridData method.
Public event TreeViewDataGenerateComplete
Event fired when the object has completed the BuildTreeViewData method.
Public event xmlGenerateComplete
Event fired when the object has completed the RefreshXML method.

See Also