| DashboardObject Class |
|
Object that represents a single visual object on a DashboardTab object.
Inheritance Hierarchy
Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)
Syntax[SerializableAttribute] public class DashboardObject : _DashboardObject, ISerializable, PartialSummaryParent, ITelemetry, DrillDownParent
The DashboardObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DashboardObject |
Creates and returns a new DashboardObject.
|
| DashboardObject(DashboardObjects) |
Creates and returns a new DashboardObject.
|
| DashboardObject(DrillDown) |
Creates and returns a new DashboardObject.
|
| DashboardObject(DashboardObjects, DashboardObjectDashboardObjectType) |
Creates and returns a new DashboardObject.
|
| DashboardObject(DrillDown, DashboardObjectDashboardObjectType) |
Creates and returns a new DashboardObject.
|
| DashboardObject(DashboardObjects, DashboardObjectDashboardObjectType, String) |
Creates and returns a new DashboardObject.
|
| DashboardObject(DrillDown, DashboardObjectDashboardObjectType, String) |
Creates and returns a new DashboardObject.
|
Methods| Name | Description | |
|---|---|---|
 | BuildColumnGroups | |
| BuildDataFieldsAndColumns |
Generates the JSON configuration for the table data fields and columns for the given DashboardObject and DataTable
|
| BuildDependantObjectList |
Rebuilds the DependantObjectList property
|
| BuildGridData |
Causes the object to rebuild the Summary Data for a data grid.
|
| BuildParamString |
Returns the parameter string to be used when rendering an object.
|
| BuildTreeViewData |
Causes the object to rebuild the Treeview nodes for a tree view.
|
| ConvertToLetter |
Converts the given column number to a letter or letters, e.g. 1 = A, 27 = AA
|
| CopyToClipboard |
Copies this object to the clipboard.
|
| CreateCustomClass | |
| DataTableToJson |
Convert the given table to a JSON string
|
| DrillDownParent |
Returns a drilldown parent object based on the ID provided
|
| DropDownListArray | |
| ExportToCSV |
Export this dashboard object to csv
|
| ExportToCSV(DataTable, Boolean, String, CubeDataRenderer, Char) |
Export this dashboard object to csv
|
| ExportToExcel |
Export this dashboard object to Excel 2007 and above (XSLX)
|
| ExportToExcel(DataTable, Boolean, String, CubeDataRenderer, Char) |
Export this dashboard object to Excel 2007 and above (XSLX)
|
| ExportToPDF |
Export this dashboard object to PDF
|
| ExportToPDF(DataTable, ListInt32, String, CubeDataRenderer, Char) |
Export this dashboard object to PDF
|
| ExportToRTF |
Export this dashboard object to RTF
|
| ExportToRTF(DataTable, ListInt32, String, CubeDataRenderer, Char) |
Export this dashboard object to RTF
|
| GetChartResizeScript |
Gets the javascript required to resize the chart.
|
| GetColumnFormat | |
| GetColumnWidth | |
| getFilterCondition |
Gets a valid DataTable filter condition for a given column and value.
|
| getFilterConditionFromNameType |
Gets a valid DataTable filter condition for a given column and value.
|
| GetObjectData | |
| GetObjectImageByteArray |
Gets an image array of the dashboard object for the specified size.
|
| GetTelemetryMetrics | |
| GetTelemetryProperties | |
| KillThread |
Kills the background thread (if any) being used to generate XMl.
|
| QuotedString | |
| ReBuildSummaryData |
Forces the summary data object to rebuild it's summary table.
|
| RefreshXML |
Causes the object to rebuild the XML property.
|
| RemoveNonPrintableCharacter | |
| ResetDataProvider |
Resets the dataprovider for this object, forcing it to be rebuilt
|
| ResetSummaryDataTable |
Resets the summary data table for this object, forcing it to be rebuilt
|
| UserDependantFilter | |
| WaitForDrillDownThread |
Waits for any drill down threads to complete
|
Fields
Properties| Name | Description | |
|---|---|---|
 | ActualSummaryBuildThreshold |
Gets and sets the threshold value used to decide whether or not to build a partial summary for this object
|
| Alerts |
Gets and sets the alerts collection for this object
|
| Allow3D |
Gets a property that indicates if this chart object supports 3D rendering
|
| AllowAdvancedXML |
Gets a property that indicates if it is possible to specify advanced XML for this object type.
|
| AllowAppearance |
Gets a property that indicates if it is possible to specify appearance attributes for this object type.
|
| AllowColour |
Gets a property that indicates if this objects supports colour definition.
|
| AllowColourRanges |
Gets a property that indicates if this object supports colour ranges
|
| AllowDataGridDefaultColumnFit |
Gets a property that indicates if it is possible to specify default column fit type for this object.
|
| AllowDrillDown |
Gets a property that indicates if it is possible to specify a drill down object for this object type.
|
| AllowDrillDownDashboardObjectDashboardObjectType |
Gets a property that indicates if it is possible to specify a drill down object for a given object type.
|
| AllowFont |
Gets a property that indicates if it is possible to specify a default font for this object type.
|
| AllowForEach |
Gets a property that indicates if it is possible to specify for each iteration types.
|
| AllowGlassEffect |
Gets a property that indicates if it is possible to specify whether glass effect is visible for this object type.
|
| AllowLineOrAreaColour |
Gets a property that indicates if the line or area colour options are shown.
|
| AllowMultipleGroupColumns |
Gets a value that indicates whether this object supports multiple group columns.
|
| AllowMultipleSummaryColumns |
Gets a value that indicates whether this object supports multiple summary columns.
|
| AllowNoZeroPlot |
Gets a property that indicates if it is possible to specify that zero values are not plotted.
|
| AllowPointLabels |
Gets a property that indicates if it is possible to specify Point Labels this object type.
|
| AllowRanges |
Gets a property that indicates if this object supports ranges
|
| AllowRegressionLines |
Gets a value that indicates if this object supports regression lines
|
| AllowScalingUnits |
Gets a property that indicates if it is possible to specify advanced scaling units for this object type.
|
| AllowShowSum |
Gets and sets a property that indicates whether ShowSum option is enabled
|
| AllowSpecifyLegend |
Gets a property that indicates if it is possible to specify whether a legend is visible for this object type.
|
| AllowStack100Percent |
Gets and sets a property that indicates whether Stack100Percent option is enabled
|
| AllowSubTitles |
Gets a property that indicates if it is possible to specify sub titles this object type.
|
| AllowTickMarks | |
| AllowTitles |
Gets a property that indicates if it is possible to specify titles this object type.
|
| AllowTotals |
Gets a value that indicates if it is possible to define totals for this object
|
| AllowXAxis |
Gets a property that indicates if it is possible to specify x axis attributes for this object type.
|
| AllowYAxis |
Gets a property that indicates if it is possible to specify y axis attributes for this object type.
|
| AvailableSummaryColumnDisplayTypes |
Gets an array that indicates the valid SummaryDataDisplayTypes for this object type.
|
| BuildingObject |
Gets or sets a value that indicates whether or not the object is currently building XML.
|
| Caption |
Gets and sets the caption of this object.
|
| ChartHeight |
Gets a value that indicates the internal height of the chart object.
|
| ChartWidth |
Gets a value that indicates the internal width of the chart object.
|
| Clone |
Gets cloned copy of this object (only the ID will be different).
|
| ColumnAlignmentCollection | |
| ColumnFormat |
Gets the format string for a given column in this dashboard object.
|
| ColumnHeading |
Gets the column heading for a given column in this dashboard object.
|
| ComSourceDataTable |
Gets the Source DataTable used to render this object.
|
| ControlPanelBackgroundColour |
Gets and sets the background colour for the control panel objects.
|
| ControlPanelObjects |
Gets and sets the ControlPanelObjects collection associated with this Dashboard Object.
|
| Dashboard |
Gets the ManagedDashboard object that this Dashboard Object belongs too.
|
| DashboardLabelOrientation |
Gets and sets value that indicates the orientation of X axis labels for this object.
|
| DashboardQuery |
Gets a property that is the DashboardQuery object associated with this DashboardObject.
|
| DataGridDefaultColumnFit |
Gets and sets a value that determines the default methid used to fit columns in a datagrid.
|
| DataGridDisplayStyle |
Gets and sets a property that determines how a datagrid is rendered.
|
| DataGridFont |
Gets and sets the bespoke font that will be used to render this datagrid if DataGridUseBespokeFont is true.
|
| DataGridLayout |
Gets and sets an the layout of a DataGrid in the form of an XML string.
|
| DataGridTextColor |
Gets and sets the colour of the text used for this data grid if DataGridUseBespokeFont is true.
|
| DataGridUseBespokeFont |
Gets and sets a value that indicates if this object should use a bespoke font when rendered as a data grid.
|
| DataTag |
Gets the group columns for this dashboard object
|
| DependantObjectList |
Gets a comer delimtered string listing the ID's of all the objects dependent on this object
|
| DescendantDashboardObject |
Gets the Descendant (drill down) Dashboard Object with the specified ID.
|
| DisplayApplyButton |
Gets and sets a value that indicates if the treeview should display an apply button
|
| DivHeight |
Gets a value that indicates the div height of the chart object.
|
| DrillDown |
Gets and sets a DrillDown object representing any drill down options for this object.
|
| DrillDownEnabled |
Gets a property that indicates if a drill down object is defined for this object.
|
| DualYAxis |
Gets a value that indicates whether this object has a sual Y axis.
|
| EmailBody |
Gets and sets the email body used when emailing this object after the dashboard is refreshed on the server
|
| EmailRecipients |
Gets and sets the email address(es) that this object should be sent to when the dashboard is refreshed on the server
|
| EmailSubject |
Gets and sets the email subject used when emailing this object after the dashboard is refreshed on the server
|
| ExportBehaviour |
Gets and sets a value that indicates the export behaviour for this object
|
| ExportDocumentType |
Gets and sets a value that indicates what document type will be used to export this object on the server
|
| ExportError |
Gets and sets an error string detailing any errors that occured when trying to export this object on the server
|
| ExportFileExtension |
Gets the file extension that matches the current export document type
|
| ExportLocation |
Gets and sets a location on the server to save an export of this document to
|
| Filter |
Gets the default filter object that filters data for this object
|
| FilterClearedDependantObjects |
Gets and sets a collection that contains all dashboard objects that need refreshing because they have had this filter removed.
|
| FilterDependantObjects |
Gets a collection that contains all the DashboardObjects that are dependant on this tree view filter panel.
|
| Filters |
Gets and sets the all the filter objects that filter data for this object
|
| FlashVars |
Gets the FlashVars string to support rendering of the chart.
|
| ForceSummaryColumnDisplayType |
Gets a value that indicates if the display type for a summary column is defined by which Y axis it is assigned to.
|
| FusionChartType |
Gets the Fusion chart type
|
| GaugeData |
Gets and sets the GaugeData object that represents numerical information about this dashboard object
|
| GaugeObject |
Gets a property that indicates if this object type represents a single summary value (with no groups)
|
| GaugeObjectDashboardObjectDashboardObjectType |
Gets a property that indicates if this object type represents a single summary value (with no groups)
|
| GroupColumns |
Gets the group columns for this dashboard object
|
| GUID |
Gets a GUID that uniquely identifies this object.
|
| HasSourceData |
Gets a property that indicates whether all the queries this object is dependant on have source data
|
| Height |
Gets and sets a value that indicates the height of this object.
|
| HideLabelsIfLegendShown |
Gets a property that indicates if labels should be hidden when a legend is shown.
|
| HideZeroValueGroups |
Gets and sets a value that indicates whether groups with all zero values should be hidden.
|
| HTML |
Generates and returns the HTML required to render this object.
|
| ID |
Gets a value that indicates the Unique ID of this object.
|
| InLineXML |
Gets a property that indicates if the XML for this chart should be rendered in line with the HTML.
|
| IsDrillDownObject |
Gets a property that indicates if this DashboardObject is a drill down DashboardObject.
|
| LastUsedFilter |
Gets a string that indicates the filter string used last time the object was rendered.
|
| LimitXAxisLabelLength |
Gets and sets a value that indicates if MaxXAxisLabelLength should be applied to X Axis labels on the chart.
|
| LineOrAreaColour |
Gets and sets the colour of the line in a line chart.
|
| LoadScript |
Gets the script required to load this DashboardObject in a web browser.
|
| Map |
Gets and sets the map object that defines the map for this dashboard object
|
| MaxXAxisLabelLength |
Gets and sets a value that indicates the maximum length of X Axis labels on the chart.
|
| MenuTitle |
Gets a value that indicates the title that will be used on the object (build from caption and sub caption properties).
|
| NoDataMessage |
Gets the text displayed by this message if no data is available.
|
| NoLeadingZeroPlot |
Gets and sets a property that indicates if leading zero values are plotted on the chart.
|
| NoZeroPlot |
Gets and sets a property that determines whether zero values are plotted on the chart.
|
| NumericColumn |
Gets a property that indicates if the given column is a numeric column.
|
| NumericFormats |
Gets a dictionary containg the numeric format providers for this chart
|
| ObjectSizes |
Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
|
| ObjectType |
Gets or sets a value that indicates the type of this DashboardObject.
|
| OverrideDefaultColourScheme |
Gets and sets a value that indicates if the default colour scheme for this object will be overridden
|
| PanelObject |
Gets a property that indicates if this object type requires a panel to be rendered.
|
| Parent |
Gets and sets an object that represents the parent of this object.
|
| ParentDashboardObject |
DrillDownParent.ParentDashboardObject implementation. Returns this object
|
| PartialSummarySumColumns | |
| PauseXMLEvents |
Gets or sets a value that indicates whether or not any xmlgenerateComplete events will be delayed.
|
| PrimaryYAxis |
Gets and sets a YAxis object that represents the primary Y Axis.
|
| ProcessButtonLabel |
Gets and sets a label that will be shown on the process button.
|
| ProcessButtonLocation |
Gets and sets a value that indicates the location of the process button.
|
| ProcessingObjectData |
Gets a property that indicates if the object is currently building the XML string.
|
| RebuildRequired |
Gets or sets a value that indicates whether or not the object has been modified since the last call to refreshXML.
|
| Render3D |
Gets and sets a property that indicates if this chart should be rendered in 3D
|
| RequiresLongFormTreeviewFilter | |
| RequiresSourceData |
Gets a property that indicates if this object requires the dashboard to load source data
|
| SecondaryYAxis |
Gets and sets a YAxis object that represents the Secondary Y Axis.
|
| Selected |
Gets or sets a value that indicates if this object is selected.
|
| showBorder |
Gets and sets value that indicates whether a border should be shown on this object.
|
| ShowCheckAllUnCheckAll |
Gets a value that indicates if the Check All and UnCheck All buttons should be shown on the process button bar.
|
| ShowCheckBoxes |
Gets and sets a value that indicates if this dashboard object should show checkboxes and a process button in a data grid.
|
| showGlassEffect |
Gets and sets value that indicates whether glass effect should be shown on this object.
|
| ShowGridTotals |
Gets and sets a property that determines if the grid will show totals.
|
| showLegend |
Gets and sets value that indicates whether Legend should be shown on this object.
|
| ShowPivotTotalColumn |
Gets and sets a property that determines if the pivot table will show a total column.
|
| ShowPivotTotalRow |
Gets and sets a property that determines if the pivot table will show a total row.
|
| ShowPivotTotals |
Gets and sets a property that determines if the pivot table will show totals.
|
| showPointLabels |
Gets and sets value that indicates whether point labels should be shown on this object.
|
| showPointLabelsInside |
Gets and sets value that indicates whether point labels should be shown inside the chart on this object.
|
| ShowRegressionLines |
Gets and sets a property that determines if this object will show regression lines on a scatter or bubble chart
|
| ShowSum |
Gets and sets a property that indicates whether sum point labels will be shown on the stacked chart
|
| SourceDataRequirement |
Gets a value that indicates why this object requires source data
|
| SourceDataTable |
Gets a raw System.Data.DataTable from the query used to build the summary data for the chart.
|
| Stack100Percent |
Gets and sets a property that indicates if this stacked chart should stack to 100 percent
|
| SubCaption |
Gets and sets the sub caption of this object.
|
| SummaryBuildThreshold |
Gets and sets the threshold value used to decide whether or not to build a partial summary for this object
|
| SummaryBuildThresholdApplied |
Gets a value that indicates a partial summary is not available for this object due to the summary build threshold being met
|
| SummaryColumns |
Gets the summary columns for this dashboard object
|
| SummaryData |
Gets and sets the SummaryData object that defines and generates the data used to render this chart.
|
| SummaryDataProvider |
Gets the summary data provider for this object
|
| SuplimentaryXML |
Gets and sets any supplementary XML to be applied to this object.
|
| SupplimentaryAttributes |
Gets and sets any supplementary attributes to be applied to the chart node of this objects XML
|
| SwitchAxisLabels |
Gets a value that indicates whether the X and Y axis labels should be switched.
|
| Tab |
Gets the DashboardTab object that this Dashboard Object belongs too.
|
| Task |
Gets and sets the task used by this object to generate XML in the background.
|
| TreeViewNodesCheckedByDefault |
Gets and sets a property that indicates if treeview nodes are checked by default.
|
| 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.
|
| UpdatingFilterObjects |
Gets a collection of Filter Paramaters that cause this object to refresh when the filter value is changed.
|
| ValidExportTypes |
Gets a valid list of email export document types for this object
|
| ValueAxis |
Gets a dictionary containing the value axis objects for this chart
|
| verticalPointLabels |
Gets and sets a value that indicates whether point labels should be displayed vertically.
|
| Width |
Gets and sets a value that indicates the width of this object.
|
| XAxis |
Gets and sets a YAxis object that represents the primary X Axis for XY Plot charts.
|
| xAxisName |
Gets and sets a value that will be used as the name of the X Axis.
|
| XML |
Gets the XML required to render this object.
|
| XmlDefinitionType |
Gets the the XML definition type of this object.
|
| XmlUrl |
Gets the url that retrieves the XML data for this object.
|
Events| Name | Description | |
|---|---|---|
 | AddressSearchComplete |
Event raised when a map data plot finishes searching for addresses
|
| AddressSearchProgress |
Event fires when a search for address locations processes an address
|
| AddressSearchStarted |
Event raised when a map data plot starts searching for addresses
|
| DataGridLayoutUpdateRequest |
Event fired when the DataGridLayout property is queried.
|
| GridDataGenerateComplete |
Event fired when the object has completed the BuildGridData method.
|
| MapDataPlotBuildStarted |
Event raised when a map data plot build starts
|
| MapDataPlotChanged |
Event raised when a map data plot changes
|
| TreeViewDataGenerateComplete |
Event fired when the object has completed the BuildTreeViewData method.
|
| xmlGenerateComplete |
Event fired when the object has completed the RefreshXML method.
|
RemarksSee Also