DashboardQuery Class

DataPA OpenAnalytics API Reference

Dashboard wrapper for a DataPA.Query object, allows specification of timing events.

Inheritance Hierarchy

SystemObject
DataPAEnterpriseDashboardDashboardQuery

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class DashboardQuery : _DashboardQuery, 
	ISerializable, ISerializable, ITelemetry

<SerializableAttribute>
Public Class DashboardQuery
	Implements _DashboardQuery, ISerializable, ISerializable, ITelemetry

[SerializableAttribute]
public ref class DashboardQuery : _DashboardQuery, 
	ISerializable, ISerializable, ITelemetry

DataPAEnterpriseDashboard.DashboardQuery = function();

Type.createClass(
	'DataPAEnterpriseDashboard.DashboardQuery',
	null,
	DataPAEnterpriseDashboard.DashboardQuery._DashboardQuery,
	ISerializable,
	DataPASerialization.ISerializable,
	DataPA.Telemetry.ITelemetry);

The DashboardQuery type exposes the following members.

Constructors

	Name	Description
	DashboardQuery	Creates and returns a new DashboardQuery object.
	DashboardQuery(DashboardQueries, Query)	Creates and returns a new DashboardQuery object.

Top

Methods

	Name	Description
	CancelRefresh	Cancels a refresh operation for this query.
	ClearCachedSourceData	If the dashboard has been loaded without source data, will clear the stored data
	ClearRequiredFieldsSuppliedByThirdParty
	ClearRows	Clears the rows from the datatable(s) associated with the query leaving just the datatable(s) columns
	GetObjectData(SerializationInfo)
	GetObjectData(SerializationInfo, StreamingContext)
	GetTelemetryMetrics
	GetTelemetryProperties
	KillTimer	Kills any auto refresh timers on this dashboard query
	LoadSourceData	If the dashboard has been loaded without source data, will force the data to load
	QueriesRefreshedWithThisQuery
	ReApplyCalculatedColumns	Rebuilds the values of any calculated columns in this query.
	RefreshData	Causes the the query to refresh its data.
	RefreshData(Boolean, Boolean, String, String)	Causes the the query to refresh its data.
	RequiredFieldsSuppliedByThirdParty
	ResolveRequiredFieldRequirements	Ensures each required field defined by this query has an assoiciated ControlPanelObject on the dashboard.
	SetNextAutoRefresh	Sets the next auto refresh for this query.
	SetNextAutoRefresh(DateTime)	Sets the next auto refresh for this query.
	UpdateDataSetFields
	UpdateQuery	Updates the Query object this DashboardQuery is based on.

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	Alerts	Gets and sets an alerts collection for this dashboard
	autoRefresh	Gets and sets a value that indicates whether this query wil refresh automatically.
	CalculatedColumns
	ClearDataOnNextRefresh	Gets and sets a property that indicates if data should be cleared on the next refresh.
	ClearRowsAfterRefresh	Gets a property that indicates the data rows for the datatable related to this query should be clear after refresh.
	CollateFilter	Gets and sets a filter that will be applied to the existing data before data from a new refresh is added
	ComRefreshInterval	Gets and sets a string value that indicates how often the query will auto refresh.
	ConnectionDetails	Gets and sets a QueryConnectionDetails object that determines how this query handles different connections.
	CurrentNextAutoRefresh	Gets a value that indicates the current time at which this dashboard query will be refreshed automatically.
	DataManageType	Gets and sets the data manage type that indicates if this query collates data.
	ErrorsOnLastRefresh	Gets a property that indicates if the last multi-connection run of this query returned one or more errors.
	ForceSynchronousProcessAfterRefresh	Gets and sets a property that indicates if the objects dependant on this query should be processed synchronously rather than asynchronously
	GUID	Gets and sets a GUID that uniquely identifies this object.
	HasData
	HasDependantObjects	Gets a value that indicates whether any DashboardObjects are dependant on the data provided by this query.
	HasOrphanedRequiredFields	Returns True if query has reqiured fields that are not represented by a ControlPanelObject on the dashboard.
	ID	Gets a value that indicates the Unique ID of this object.
	inmydataQueryPush	Gets and sets an inmydata dashboard query push class for this dashboard query
	LastRefeshCancelled	Gets a property that indicates if the last refresh was cancelled.
	LastRefreshCompleted	Gets the date and time the query last successfully completed refreshing.
	LastRefreshStarted	Gets the date and time the query last began a refresh operation.
	Name	Gets and sets a value that indicates the name of this query.
	NextAutoRefresh	Gets a value that indicates the time at which this dashboard query will be refreshed automatically.
	NumRows	Gets the total number of rows returned by this query.
	ObjectSizes	Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
	OrphanedRequiredFields	Gets a collection of DataPA.Utils.QueryEngine.Field objects that represent the orphaned required fields for this query.
	Parent	Gets and sets object that represents the parent of this object.
	Password	Gets and sets the encrypted Password used by the Enterprise Service to connect to an appserver when refreshing this query.
	Query	Gets and sets the Query object this DashboardQuery is based on.
	QueryBasedOnSystem	Gets a property that indicates if the query is based on a defined system
	QueryErrorMessage	Gets and sets an error message returned by the query at the last refresh.
	QueryString
	QueuedForRefresh	Gets a value that indicates if this query is queued for refresh.
	RefreshesAcrossMultipleConnections	Gets a property that indicates if this query refreshes across multiple connections
	Refreshing	Gets a value that indicates whether the current query is refreshing.
	refreshInterval	Gets and sets a value that indicates how often the query will auto refresh.
	RefreshOnOpen	Gets and sets a value that indicates if the query will auto refresh when the dashboard is opened.
	RefreshOnPublish	Gets and sets a property that indicates if this query will be refreshed on publish
	ResultsSet	Gets and sets the results set for this query.
	SaveDataFailed	Gets a property that indicates if the query data failed to serialize during the last serialzation process.
	SaveDataFailException	Gets the exception that indicates why the query data failed to serialize during the last serialzation process.
	SQLQueryString	Returns the SQL query string for this query if this query uses one.
	StoredDataFileName	Gets and sets the name of a file where the data for this query has been stored
	SubjectID	Returns the UniqueID of the subject for this query.
	SupportsCollate	Gets a value that indicates if this query supports data collation.
	SystemName	Returns the System name the subject for this query belongs to.
	Username	Gets and sets the username used by the Enterprise Service to connect to an appserver when refreshing this query.
	ValidSubject	Gets a value that indicates if the subject for this query exists.

Top

Events

	Name	Description
	ServerRequestComplete	Event raised when a server request raised by this object is completed.

Top

Remarks

Reference

DataPAEnterpriseDashboard Namespace

Send comments on this topic to info@datapa.com