MList

WIP description for MList

setStorageMode ( )

getStorageMode ( )

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

getRecords ( ) →{ Object }

Gets the records in the list.

Returns

Promise containing all of the Lists items.

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.

refresh ( opts: Object )

Refreshes the list.

Parameters
Name Type Description
opts Object Optional object used to configure the refresh.

render ( )

Renders the list.

scrollToBottom ( )

Scrolls the list to the bottom.

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.

setQuery ( queryName: String )

Sets the query used to populate the list with items.

Parameters
Name Type Description
queryName String The name of the query.

setRecords ( records: Array<Record>)

Sets the records in the list.

Parameters
Name Type Description
records Array<Record> The records to display.

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.

Widgets