HTML

The HTML widget allows the user to place their own HTML content fragment directly into a page. It directs embed secure HTML pages or paste in HTML from local or third party sources.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
DisabledThe widget cannot be used.
HiddenHides the widget from the user.
HTMLThe HTML that should be displayed by the widget.
MaximizeSet this widget to be maximized (take up all available space).
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
TemplateUse a template as the HTML.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
Render Triggered when data is completely rendered on the element.
event Object containing the domNode (event.domNode) and the data (event.data) that was rendered.

Function

getData ( ) →{ Object }

Returns the widget's data object. This object contains values that are used to render the HTML template.

Returns

The data object.

getInputData ( ) →{ Object }

Returns the widget's input-data. This function will scan the DOM in this HTML-widget and collect the values of all

Returns

The data object.

refresh ( data: Object , force: Boolean )

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.
force Boolean Forces reloading of data if this is widget is connected to a query.

setTemplate ( html: String )

Set the displayed HTML.

Parameters
Name Type Description
html String The new HTML to display.

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) →{ Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) →{ ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) →{ Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) →{ Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) →{ Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.

Other Widgets