Module: settings/js/widget

Classes

Widget

Type Definitions

ValidationResponse

Properties:

Name	Type	Argument	Description
valid	boolean		True if the configuration is valid; false otherwise
data	*	<optional>	An object with additional detail about the validation

Source:

• widget.js, line 144

WidgetOptions

Properties:

Name	Type	Description
configItem	string	The section of the configuration represented by this widget
description	string	A description for the widget
serverName	string	(deprecated) Name of the server
strings	WidgetStrings	Internationalisation strings for the widget
title	string	Title for the widget
isOpened	boolean	True if the widget should start opened; false otherwise

Source:

• widget.js, line 18

WidgetStrings

Properties:

Name	Type	Description
iconClass	string	Icon to use in the title bar for the widget

Source:

• widget.js, line 14

WidgetTemplateParameters

Properties:

Name	Type	Description
description	string	this.description
title	string	this.title
configItem	string	this.configItem
isOpened	boolean	this.isOpened
iconClass	string	this.strings.iconClass

Source:

• widget.js, line 74