Dashboard in Expression Language - Revision history

Ollvihe: /* Dashboard functions */

2024-01-15T13:59:30Z

Dashboard functions

← Older revision		Revision as of 13:59, 15 January 2024
Line 111:		Line 111:
	* Dashboard id (Integer)		* Dashboard id (Integer)
	\|\|		\|\|
	Returns dashboard by ~~the~~ given dashboard id. Returns the Dashboard object if such ~~is found~~. Throws an exception if dashboard doesn't exist or user doesn't have permissions to it. ''GenericRead'' permission to the project that contains the dashboard is required.		Returns dashboard by given dashboard id. Returns the Dashboard object if such exists and user has permissions to it. Throws an exception if dashboard doesn't exist or user doesn't have permissions to it. ''GenericRead'' permission to the project that contains the dashboard is required.
	\|}		\|}

2023-10-31T13:15:56Z

Dashboard functions

← Older revision		Revision as of 13:15, 31 October 2023
Line 82:		Line 82:
	dashboards.{ // loop through dashboards		dashboards.{ // loop through dashboards
	let content = _.content; // get dashboard content		let content = _.content; // get dashboard content
	content["variables].Remove("Filter"); // modify content		content["variables"].Remove("Filter"); // modify content
	_.Modify( // store modified content back to the dashboard		_.Modify( // store modified content back to the dashboard
	#{ "Content": content }		#{ "Content": content }

2023-10-31T13:14:02Z

Dashboard functions

← Older revision		Revision as of 13:14, 31 October 2023
Line 71:		Line 71:
	let dashboard = DashboardById(1); // find dashboard		let dashboard = DashboardById(1); // find dashboard
	let content = dashboard.content; // get dashboard content		let content = dashboard.content; // get dashboard content
	content.Set("backgroundColor", "#ffffff"); // modify content		content.layout.Set("backgroundColor", "#ffffff"); // modify content
	dashboard.Modify( // store modified content back to the dashboard		dashboard.Modify( // store modified content back to the dashboard
	#{ "Content": content }		#{ "Content": content }

2023-10-31T13:12:48Z

Dashboard functions

← Older revision		Revision as of 13:12, 31 October 2023
Line 71:		Line 71:
	let dashboard = DashboardById(1); // find dashboard		let dashboard = DashboardById(1); // find dashboard
	let content = dashboard.content; // get dashboard content		let content = dashboard.content; // get dashboard content
	content.Set("backgroundColor", "#ffffff"; // modify content		content.Set("backgroundColor", "#ffffff"); // modify content
	dashboard.Modify( // store modified content back to the dashboard		dashboard.Modify( // store modified content back to the dashboard
	#{ "Content": content }		#{ "Content": content }

2023-10-28T17:02:00Z

Dashboard functions

← Older revision		Revision as of 17:02, 28 October 2023
Line 42:		Line 42:

	== Dashboard functions ==		== Dashboard functions ==
	Dashboard objects in the expression language have functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list ~~existing~~ dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].		Dashboard objects in the expression language have functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].
	{\| class="wikitable"		{\| class="wikitable"
	!'''Function'''		!'''Function'''

2023-10-28T17:01:39Z

Dashboard functions

← Older revision		Revision as of 17:01, 28 October 2023
Line 42:		Line 42:

	== Dashboard functions ==		== Dashboard functions ==
	Dashboard objects in the expression language have ~~the~~ functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list existing dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].		Dashboard objects in the expression language have functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list existing dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].
	{\| class="wikitable"		{\| class="wikitable"
	!'''Function'''		!'''Function'''

2023-10-28T17:01:01Z

← Older revision		Revision as of 17:01, 28 October 2023
Line 1:		Line 1:
	In QPR ProcessAnalyzer, '''dashboard''' consists of a canvas where charts and other visualization components can be added. Each dashboard belongs to project~~. Dashboards~~ have a mandatory name and optional identifier. The identifier is used when creating links between dashboards.		In QPR ProcessAnalyzer, '''dashboard''' consists of a canvas where charts and other visualization components can be added. Each dashboard belongs to project, and dashboards have a mandatory name and optional identifier. The identifier is used when creating links between dashboards.

	==Dashboard properties==		==Dashboard properties==

2023-10-28T16:59:44Z

← Older revision		Revision as of 16:59, 28 October 2023
Line 41:		Line 41:
	\|}		\|}

	== ~~Diagram~~ functions ==		== Dashboard functions ==
	Dashboard objects in the expression language have the functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list existing dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].		Dashboard objects in the expression language have the functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Model.CreateDashboard()]], and to list existing dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model\|Project.Dashboards]].
	{\| class="wikitable"		{\| class="wikitable"
Line 101:		Line 101:
	\|}		\|}

	Function to get ~~diagram~~ by dashboard id:		Function to get dashboard by dashboard id:
	{\| class="wikitable"		{\| class="wikitable"
	!'''Function'''		!'''Function'''

2023-10-28T16:59:15Z

Diagram functions

← Older revision		Revision as of 16:59, 28 October 2023
Line 73:		Line 73:
	content.Set("backgroundColor", "#ffffff"; // modify content		content.Set("backgroundColor", "#ffffff"; // modify content
	dashboard.Modify( // store modified content back to the dashboard		dashboard.Modify( // store modified content back to the dashboard
	#{"Content": content}		#{ "Content": content }
	);		);
	</pre>		</pre>
Line 84:		Line 84:
	content["variables].Remove("Filter"); // modify content		content["variables].Remove("Filter"); // modify content
	_.Modify( // store modified content back to the dashboard		_.Modify( // store modified content back to the dashboard
	#{"Content": content}		#{ "Content": content }
			);
			};
			</pre>

			Example: Move dashboards from a project to other.
			<pre>
			let sourceProjectId = 1;
			let targetProjectId = 2;
			ProjectById(sourceProjectId).Dashboards.{
			_.Modify(
			#{ "ProjectId": targetProjectId }
	);		);
	};		};

2023-10-28T16:57:00Z

Diagram functions

← Older revision		Revision as of 16:57, 28 October 2023
Line 58:		Line 58:
	\|-		\|-
	\|\|Modify		\|\|Modify
	\|\|		\|\|Parameters dictionary
	\|\|		\|\|
	Modifies the dashboard. The parameter is a dictionary containing dashboard properties to be updated. ''EditDashboards'' permission to the project is required. Following properties are supported:		Modifies the dashboard. The parameter is a dictionary containing dashboard properties to be updated. ''EditDashboards'' permission to the project is required. Following properties are supported: