DashboardItemTimeVaryingText

Inherits DashboardItem

This DashboardItem displays text based on the content of a provided data file. The value that is displayed depends on the current in-game simulation time.

The JSON must contain a ‘data’ array with timestamp-value pairs. Example format: {"data": [["2024-05-10T00:00:00Z", 2.33], ["2024-05-10T03:00:00Z", 3.0]]}

Members

Name	Documentation	Type	Description	Optional
DataFile	The file path to the JSON data.	File	Value of type ‘File’	No
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
FormatString	The format text describing how this dashboard item renders its text. This text must contain exactly one {} which is a placeholder that will be replaced with the values read from the file provided in DataFile	String	Value of type ‘String’	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

Styled

This example shows how to create a time-varying text dashboard item. It has a custom font size and text before the time varying text.

local Item = {
  Type = "DashboardItemTimeVaryingText",
  Identifier = "DashboardItemTimeVaryingText_Example_Styled",
  DataFile = asset.resource("data/dummydata.json"),
  FormatString = "Observed KP index: {}",
  FontSize = 40
}

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

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

Mixed

This example shows how to create a time-varying text dashboard item that is using a mixed type of data entries in the DataFile.

local Item = {
  Type = "DashboardItemTimeVaryingText",
  Identifier = "DashboardItemTimeVaryingText_Example_Mixed",
  DataFile = asset.resource("data/dummydata_mixed.json"),
}

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

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

Basic

This example shows how to create a time-varying text dashboard item.

local Item = {
  Type = "DashboardItemTimeVaryingText",
  Identifier = "DashboardItemTimeVaryingText_Example",
  DataFile = asset.resource("data/dummydata.json"),
}

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

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