Click or drag to resize
DashboardQuery Properties DataPA OpenAnalytics
DataPA OpenAnalytics API Reference

The DashboardQuery type exposes the following members.

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