DashboardItemParallelConnection

Inherits DashboardItem

This DashboardItem displays information about the status of the parallel connection, which is whether OpenSpace is directly connected to other OpenSpace instances and can either control those instances or be controlled by the master of the session. If OpenSpace is not connected, this DashboardItem will not display anything.

The information presented contains how many clients are connected to the same session and whether this machine is currently the host of the session.

Members

Name	Documentation	Type	Description	Optional
FontName	This value is the name of the font that is used. It can either refer to an internal name registered previously, or it can refer to a path that is used.	String	Value of type ‘String’	Yes
FontSize	This value determines the size of the font that is used to render the distance.	Double	Value of type ‘Double’	Yes

Inherited members from DashboardItem

Name	Documentation	Type	Description	Optional
Identifier	The unique identifier for this DashboardItem.	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	No
Type	Determines the type of the DashbordItem that should be created.	String	Value of type ‘String’	No
Enabled	If this value is set to ‘true’ this dashboard item is shown in the dashboard. Otherwise it will be hidden.	Boolean	Value of type ‘Boolean’	Yes
GuiName	The name for the DashboardItem that is used when showing it in the user interface.	String	Value of type ‘String’	Yes

Asset Examples

Basic

This example adds a dashboard item that shows the status of the parallel connection.

local Item = {
  Identifier = "DashboardItemParallelConnection_Example",
  Type = "DashboardItemParallelConnection"
}

asset.onInitialize(function()
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
end)