Interface: HTML

HTML

The HTML-widget renders a custom HTML-snippet based on a template.

Extends

Methods

get(name) → {Object}

Gets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
Inherited From:
Returns:
- The property's value.
Type
Object

getData() → {Object}

Returns the widget's data object. This object contains values that are used to render the HTML template.
Returns:
- The data object.
Type
Object

getId() → {ID}

Returns the ID of the widget.
Inherited From:
Returns:
- The ID of the widget
Type
ID

getInputData() → {Object}

Returns the widget's input-data. This function will scan the DOM in this HTML-widget and collect the values of all input-fields and return an object with key/value-pairs. The key of an input will be either it's id-attribute or the value of data-name.
Returns:
- The data object.
Type
Object

getValue() → {Object}

Returns the widget's value.
Inherited From:
Returns:
- The widget's value.
Type
Object

hide()

Hides the widget.
Inherited From:

isEnabled() → {Boolean}

Returns true if the widget is enabled.
Inherited From:
Returns:
- True if enabled, otherwise false.
Type
Boolean

refresh(data)

Refreshes the content of the widget. The data passed in will be available in your template as data.data
Parameters:
Name Type Description
data Object An object containing the parameters to be used by the HTML template.

set(name, value)

Sets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
value Object The new value.
Inherited From:

setEnabled(Enabled)

Enables/disables the widget.
Parameters:
Name Type Description
Enabled Boolean True to enable the widget, false to disable.
Inherited From:

setLabel(Label)

Sets the label on the button.
Parameters:
Name Type Description
Label String Text or HTML to set as the label on this button.
Overrides:

setStyle(Object)

Set the widget-style
Parameters:
Name Type Description
Object Object with style-properties
Inherited From:

setTemplate()

Set the displayed HTML.
Parameters:
Type Description
String The new HTML to display.

setValue()

Sets the widget's value.
Parameters:
Type Description
Object The new value.
Overrides:

show()

Shows the widget.
Overrides: