IDashboard

This is the programmatic interface of the Dashboard. It is created during the dashboard initialization phase.

Properties

Name	Type	Description
CustomData	any	Returns the dashboard object's custom data that was specified when the dashboard was opened.
Events	IDashboardEvents	Returns the event registering interface of the IDashboard interface.
IsPopupDashboard	boolean	Indicates whether the dashboard is opened in an own dialog instead of the embedded panes (right pane or listing pane).
ShellFrame	IShellFrame	The Shellframe for the dashboard.
Window	IWindow	Returns the dashboard's underlying window object.

Methods

Name	Description
ShowMessage	Shows the default M-Files message box with the specified content and appearance.
ShowPopupDashboard	Shows a dashboard in popup window.
UpdateCustomData	Refreshes React metadata card content.
WaitForClose	Wait for close dashboard.

Events

Event	Description	Arguments
Refresh	Triggered when the Dashboard data is refreshed.
Started	Sent when the Dashboard turns to started state.
Stop	Sent before the Dashboard is stopped.
CustomDataChanged	This event is triggered, when custom data on dashboard has changed. The event can be used to update the dashboard based on the new data. This event will fire at least once when the dashboard is started and initialized.	data New custom data for the dashboard

Here is example of using the CustomDataChanged event:

dashboard.Events.Register(Event.CustomDataChanged, (data: any) => {
  console.log("Custom data changed: ", data);
});