Module: settings/js/widgets/view-widget

Classes

ViewWidget

Members

<inner> viewTemplate :module:settings/js/widgets/view-widget.ViewWidget~ViewTemplate

Base template for the widget. Override if using Bootstrap 3

Type:

• module:settings/js/widgets/view-widget.ViewWidget~ViewTemplate

Source:

• widgets/view-widget.js, line 47

Methods

<inner> getConfig()

Returns the configuration for the widget

Source:

• widgets/view-widget.js, line 107

Returns:

The configuration for the widget

<inner> handleValidation()

Handles the results of server side validation

Source:

• widgets/view-widget.js, line 125

<inner> render()

Renders the widget

Source:

• widgets/view-widget.js, line 52

<inner> updateConfig(config)

Updates the widget with new configuration

Parameters:

Name	Type	Description
config		The new config for the wizard

Source:

• widgets/view-widget.js, line 88

<inner> validateInputs() → {boolean}

Validates the widget and applies formatting appropriately

Source:

• widgets/view-widget.js, line 148

Returns:

False if

• Viewing mode is Reference, and the reference field is blank
  
• Viewing mode is connector, and the connector host is blank or the port number is invalid
  
• The view server settings are invalid
  

Type

boolean

Type Definitions

ViewWidgetOptions

Extends AciWidgetOptions

Properties:

Name	Type	Description
strings	ViewWidgetStrings	Strings for the widget

Source:

• widgets/view-widget.js, line 22

ViewWidgetStrings

Extends AciWidgetStrings

Properties:

Name	Type	Description
referenceFieldLabel	string	The label of the reference field dropdown
referenceFieldBlank	string	The error message to display when the reference field is blank
referenceFieldPlaceholder	string	Placeholder for the reference field input
connector	string	Label for the connector section
viewingMode	string	Label for the viewing mode dropdown

Source:

• widgets/view-widget.js, line 13

ViewWidgetTemplateParameters

Properties:

Name	Type	Description
strings	ViewWidgetStrings	Strings for the template

Source:

• widgets/view-widget.js, line 35