DashboardItem

A DashboardItem is an item that is rendered in a dashboard. There are multiple dashboards that can exist in the system. One dashboard is created by default, which is rendered to the top left of the screen. Others can be added through the ScreenSpaceDashboard. Each DashboardItem shows its respective text in the dashboard if it is enabled and it depends on the concrete type of DashboardItem to determine what that information is.

Members

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