Copyright © 2019 EarthSoft, Inc • Modified: 12 Nov 2019
This article describes how to use the Widget Editor to set the properties of the widget. The Widget Editor is accessed by selecting the More Options icon in the upper right corner of the widget to open the drop-down menu and then selecting the Edit menu option.
The Widget Editor consists of a header and various properties of the widget. Each type of widget has a different set of properties. Some widget types do not have any additional properties. For more information on additional properties that are available for a specific widget, view the associated article for the widget.
The top part of the Widget Editor is the widget header. The type of widget will always be displayed in the Widget Editor header, regardless of what is in the widget title.
Within the header, the following properties can be set or actions can be taken:
•Title – The name of the widget is displayed by default. Edit the title of the widget by typing directly into the title text box in the header. The title of the widget will be displayed on the dashboard.
•Color – The default widget color is white. Change the background color of the widget header by selecting the Widget Themeicon and then choosing one of the colors from the drop-down menu. Available colors are red, green, blue, purple, black, and white.
•Widget Object Editor – To set various appearance properties of the widget, select the Editor icon in the middle of the widget header to open the Widget Object Editor. After setting or adding properties, click the Save button to save the changes. Click outside of the Widget Object Editor to close the editor without saving changes.
To configure a widget to not display a header, set showHeader to False. When the widget header is set to not display, the More Options menu can be accessed by right-clicking on the widget.
To configure a widget to refresh automatically, add a property called refresh (if it doesn't already exist) and set it to a non-zero number that is the refresh rate (in seconds). For example, refresh with a value of 60, would refresh the widget every 60 seconds.
Setting Collapsible to True displays the Collapse icon on the widget header and allows the widget to be collapsible (i.e., only display the widget title bar). Setting saveCollapsed to True allows the collapsed state to persist beyond the current session. Setting saveCollapsed to False results in the widget always being fully displayed when the dashboard loads. Changes made in the Widget Object Editor are saved when the Widget Editor is saved.
To add a property, select the Add Property button to open the object types drop-down menu. Select the desired object type and enter a property name in the dialog box. Click the OK button and the property will be added to the Widget Object Editor.
•Cancel – Select the Close without Saving button to exit the Widget Editor without saving changes.
•Save – Changes will be applied to the widget by clicking on the Save button. The Widget Editor will close after the save operation is complete.
•Help – The Help button connects to the online documentation related to the specific widget.