ManagedDashboard Class

DataPA OpenAnalytics API Reference

Object represents a visual Dashboard that can be opend, closed, saved, viewed and edited.

Inheritance Hierarchy

SystemObject
DataPAEnterpriseDashboardManagedDashboard

Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class ManagedDashboard : _ManagedDashboard, 
	ISerializable, ISerializable, ITelemetry

<SerializableAttribute>
Public Class ManagedDashboard
	Implements _ManagedDashboard, ISerializable, ISerializable, ITelemetry

[SerializableAttribute]
public ref class ManagedDashboard : _ManagedDashboard, 
	ISerializable, ISerializable, ITelemetry

DataPAEnterpriseDashboard.ManagedDashboard = function();

Type.createClass(
	'DataPAEnterpriseDashboard.ManagedDashboard',
	null,
	DataPAEnterpriseDashboard.ManagedDashboard._ManagedDashboard,
	ISerializable,
	DataPASerialization.ISerializable,
	DataPA.Telemetry.ITelemetry);

The ManagedDashboard type exposes the following members.

Constructors

	Name	Description
	ManagedDashboard	Create and returns a new Manageddashboard object
	ManagedDashboard(Application)	Create and returns a new Manageddashboard object.

Top

Methods

	Name	Description
	AddQueryFromFile	Allows a query to be added to the dashboard from a query file.
	AlertsMenuJSON
	ApplyFiltersToDashboard
	ApplyTreeviewValues
	BuildDependentObjectLists	Method that builds the lists of dependant objects for each control panel object
	CancelRefreshingQuery	Causes the RefreshingQuery to be cancelled.
	ClearCachedSourceData	If the dashboard has been loaded without source data, will clear the stored data
	ClearData	Clears all stored data from this dashboard.
	ClearData(Boolean)	Clears all stored data from this dashboard.
	DropDownListArrayString
	EnsureObjectsAreRefreshed
	GetMetadata	Returns metadata on this Dashboard's objects, such as number of objects, number of control panels etc
	GetObjectData(SerializationInfo)
	GetObjectData(SerializationInfo, StreamingContext)
	GetTelemetryMetrics
	GetTelemetryProperties
	KillTimers	Stops all auto refresh timers.
	LoadSourceData	If the dashboard has been loaded without source data, will force the data to load
	ProcessAlerts	Method that checks the conditions against each defined dashboard alert and raises the Alert event for any that resolve to true
	ProcessAlerts(DashboardQuery)	Method that checks the conditions against each dashboard alert based on a specific query and raises the Alert event for any that resolve to true
	ProcessAPIParametersUpdates
	ProcessColumnDrillDownString
	ProcessDataDrillDownString
	ProcessDataGridRowDrillDownString
	ProcessGetSelectionResults
	ProcessGroupDrillDownString
	ProcessMobileGetDashboardProperties
	ProcessObjectsToExport	Method that checks for objects that need to be exported, and raises an event against any objects that need to be exported
	ProcessObjectsToExport(DashboardQuery)	Method that checks for objects that need to be exported, and raises an event against any objects that need to be exported
	ProcessPostRefreshData
	ProcessRefreshOnOpen
	Publish	Publishes this Dashboard to DataPA Enterprise
	pushToinmydata	Pushes data for this dashboard query to inmydata
	RefreshDataAndSave	Refreshes all the data in the dashboard and saves the resulting dashboard.
	RefreshXML	Causes all DashboardObjects in this ManagedDashboard to rebuild the XML property.
	Save	Saves this dashboard to disk.
	Serialize	Serializes this ManagedDashboard to a memory stream
	UpdateDashboardObjectsAfterQueryRefresh	Updates all of the dashboard objects dependant on a specific query
	WriteJSONtoString

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	APIParameters
	Application	Gets and sets the RunDataPA Application Object used to provide the core DataPA data functionality for this object.
	Author	Gets and sets the author of this dashboard.
	AutoRefreshFunction	Gets the Javascript required to support auto refresh functionality in the web for this ManagedDashboard.
	BuildIndependantObjectHTML	Gets and sets a value that indicates if the HTML for each dashboard object should be rendered as a single document.
	BuildPartialSummaries	Gets a value that indicates whether partial summaries should be built in the current process
	Category	Gets and sets a category used to identify of this dashboard.
	chartBaseFontSize	Gets and sets the base font size of the chart.
	chartOutCnvBaseFontSize	Gets and sets the base font size for labels outside the chart canvas bounds.
	ChartSupportScript	Gets the Javascript required to support web rendering of this ManagedDashboard.
	Clone	Gets cloned copy of this dashboard.
	Comments	Gets and sets a comments string associated with this dashboard.
	ContentType
	ControlPanelObjectFromID	Gets a ControlPanelObject from a given ID.
	CurrentAlerts	Gets a list of the current alerts
	DashboardClientType	Gets and sets a the client type for which this dashboard should be rendered
	DashboardContainsAnyFilters	Gets a boolean flag that indicate whether the dashboard has any filters anywhere on it.
	DashboardObjectFromID	Gets a Dashboard Object by searching all DashboardObjects in this ManagedDashboards tabs for the given ID.
	Data	Gets and sets the a dictionary of the source data (if available) and partial summary data for this dashboard
	DataVersion	Gets and sets a value that identifies this particular instance of the data in this dashboard
	DebugQueries	Gets and sets a value that indicates if this dashboard will generate query debug information.
	Description	Gets and sets the description of this dashboard.
	DPALogging	Gets and sets the logging object for this managed dashboard instance.
	DrillDownFunction	Gets the Javascript required to support drill downs in the web for this ManagedDashboard.
	DrillDownParentFromID	Returns a DrillDownParent object referenced by a given ID.
	FileName	Gets and sets the file name for this dashboard.
	FilterParamaterObjects	Gets a collection that contains all of the ControlPanelObjects with an objectType property of ControlPanelObjectFilterParameter.
	FilterParameterFromID	Gets a FilterParameter from a given ID.
	FinalizedBy	Gets and sets a property who allows us to log which method has finalized the managed dashbaord object
	GUID	Gets and sets a GUID that uniquely identifies this object.
	HasData	Gets a value that indicates if this dashboard has data.
	Height	Gets the height of this Dashboard.
	HttpApplicationPath	Gets and sets the the ApplicationPath for this Managed Dashboard.
	ID	Gets a value that indicates the Unique ID of this object.
	InLineXML	Gets and sets a property that indicates if the XML for charts should be renderedd in line with the HTML.
	KeyWords	Gets and sets a commer seperated list of keywords used to identify this dashboard.
	LogObjectErrors	Gets and sets a value that indicates if this dashboard will log object errors.
	Modified	Gets and sets a value that indicates if this dashboard has been modified since the last save.
	NumbertoPreLoad	Gets and sets the number of instances of dashboards to pre load
	ObjectSizes	Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
	PageSettings	Gets and sets the page settings object for this dashboard.
	PreLoad	Gets and sets the pre load property for this dashboard
	PrintScalePercent	Gets and sets a value that indicates the scaling used to print this dashboard.
	Queries	Gets or sets the DashboardQueries object for this Dashboard.
	RaisedAlerts	Gets a list of the DashboardAlert objects that currently resolve to true for this dashboard.
	RefreshAndSaveCompletedOK	Gets and sets an error flag used by RefreshAndSave
	RefreshAndSaveErrorString	Gets and sets an error string used by RefreshAndSave
	RefreshingQuery	Gets the DashboardQuery object that represents the current refreshing query.
	RemoteServiceAgentBrokerID	Gets and sets the ID of the remote service agent broker the service will use to refresh this query
	RenderForAccessibility	Gets and sets a property that indicates whether this dashboard should be rendered for accessibility
	RequiresSourceData	Gets a property that indicates if any object on this dashboard requires source data
	SaveDataFailed	Gets a property that indicates if one or more queries failed to serialize the data during the last serialzation process.
	SaveDataFailedQueries	Gets a list of queries that failed to serialize the data during the last serialzation process.
	SelectedTab	Gets and sets the currently selected DashboardTab
	ServerFileName	Gets and sets the filename of this dashboard on the server
	ShowDebugInfo	Gets and sets a value that indicates if this dashboard will show debug information.
	Silent	Gets and sets a property that indicates if error messages should be supressed
	Skin	Gets and sets the DashboardSkin object that defines the appearance of this dashboard.
	Tabs	Gets or sets the DashboardTabs object for this Dashboard.
	Title	Gets and sets the title of this dashboard.
	ToArray	Gets this object converted to a byte array.
	UserGroup	Gets and sets the
	Username	Gets and sets the current username used to filter content on the dashboard
	Width	Gets the width of this Dashboard.

Top

Events

	Name	Description
	AfterLoad	Event raised after this ManagedDashboard object is saved to disk.
	AfterRefreshData	Event raised after this ManagedDashboard object refreshes data.
	Alert	Event raised for any DashboardAlerts that resolve to true when ProcessAlerts is called.
	AutoRefreshQueryRequest	Event raised when a dashboard query is due to refresh as determined by its AutoRefresh and RefreshInterval properties.
	BeforePublish	Event raised before this ManagedDashboard object is published to DataPA Enterprise.
	BeforeRefreshData	Event raised before this ManagedDashboard object refreshes data.
	BeforeSave	Event raised before this ManagedDashboard object is saved to disk.
	DashboardModified	Event raised when this ManagedDashboard object is modified.
	ExportObjectRequest	Event raised for any DashboardObjects that need to be exported on refresh when ProcessObjectsToExport is called
	RequestSignalRMessage	Event raised when a Signal R message is required to be sent
	RequiredFieldValueRequest	Event raised for each Required Field that is not assigned a valid ControlPanelObject, before the query is run.

Top

Remarks

Reference

DataPAEnterpriseDashboard Namespace

Send comments on this topic to info@datapa.com