DashboardItemPropertyValue

Inherits DashboardItem

This DashboardItem will show the value of the provided property. Depending on the type of the property, the DisplayString will have to be adapted. See the documentation for the DisplayString for more information.

Members

Name	Documentation	Type	Description	Optional
DisplayString	The String that is being displayed. It must either be empty (in which case only the value itself will be displayed), or it must contain extact one or more instances of {}, which will be replaced with the value(s) of the property during rendering. For scalar types, there has to be exactly one instance of {}, for vector types, there need to be as many {} as there are components in the vector, for example two {} for vec2 types, three for vec3 types, etc. For more information on how to structure the formatting string, see the documentation at https://en.cppreference.com/w/cpp/utility/format/spec.	String	Value of type ‘String’	Yes
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
URI	The URI of the property that is displayed in this dashboard item.	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

Int

This example adds a dashboard item that shows the state of a integer point value property.

local Item = {
  Identifier = "DashboardItemPropertyValue_Example_Int",
  Type = "DashboardItemPropertyValue",
  URI = "LuaConsole.HistoryLength",
  DisplayString = "Lua Console History Length: {}"
}

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

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

Bool

This example adds a dashboard item that shows the state of a boolean property.

local Item = {
  Identifier = "DashboardItemPropertyValue_Example_Bool",
  Type = "DashboardItemPropertyValue",
  URI = "NavigationHandler.OrbitalNavigator.Friction.RotationalFriction",
  DisplayString = "Rotational Friction is: {}"
}

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

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

Vec4

This example adds a dashboard item that shows the state of a 4-vector value property.

local Item = {
  Identifier = "DashboardItemPropertyValue_Example_Vec4",
  Type = "DashboardItemPropertyValue",
  URI = "RenderEngine.EnabledFontColor",
  DisplayString = "Font Color (enabled): ({}, {}, {}, {})"
}

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

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

Float

This example adds a dashboard item that shows the state of a floating point value property.

local Item = {
  Identifier = "DashboardItemPropertyValue_Example_Float",
  Type = "DashboardItemPropertyValue",
  URI = "RenderEngine.Gamma",
  DisplayString = "Gamma Correction: {}"
}

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

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

Vec3

This example adds a dashboard item that shows the state of a 3-vector value property.

local Item = {
  Identifier = "DashboardItemPropertyValue_Example_Vec3",
  Type = "DashboardItemPropertyValue",
  URI = "RenderEngine.GlobalRotation",
  DisplayString = "Global Rotation: ({}, {}, {})"
}

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

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