DashboardQuery.ResolveRequiredFieldRequirements Method

DashboardQueryResolveRequiredFieldRequirements Method

DataPA OpenAnalytics API Reference

Ensures each required field defined by this query has an assoiciated ControlPanelObject on the dashboard.

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

Syntax

C++

JavaScript

Copy

public DashboardObject ResolveRequiredFieldRequirements()

Public Function ResolveRequiredFieldRequirements As DashboardObject

public:
virtual DashboardObject^ ResolveRequiredFieldRequirements() sealed

function ResolveRequiredFieldRequirements();

Return Value

Type: DashboardObject
The DashboardObject that has had ControlPanelObjects added, if any have been, or else nothing.

Remarks

The procedure checks each required field in turn. If there is no ControlPanelObject associated with the required field it looks to create one. When creating a ControlPanelObject, it will look for a control panel that already contains objects associated with this query, and create it there. If no control panel is found, it will create one on the currently selected tab. The dashboardObject that represents the control panel object with the new query parameters is returned (if any have been added, otherwise the function returns nothing).

Reference

DashboardQuery Class

DataPAEnterpriseDashboard Namespace