RenderConfiguration

Render configuration to be applied to the widget.


Properties

string
color Optional

The color to use when rendering an entity. For example, set color as ‘RED’ to render a portion of donut in red.

Possible values are: GREYDARK_GREYLIGHT_GREYSKY_BLUEBLUEGREENYELLOWREDDARK_RED


string
condition Optional

If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.


string
display_value Optional

If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.


array of Icon
icons Optional

Icons to be applied at dashboard for widgets and UI elements.


array of Tooltip
tooltip Optional

Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.

JSON Example

{
	"color": "GREY",
	"condition": "string",
	"display_value": "string",
	"icons": [
		{
			"placement": "PRE",
			"tooltip": [
				{
					"condition": "string",
					"heading": false,
					"text": "string"
				}
			],
			"type": "ERROR"
		}
	],
	"tooltip": [
		{
			"condition": "string",
			"heading": false,
			"text": "string"
		}
	]
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vmw-nsx-module: NsxDashboard

Feedback

Was this page helpful?