Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

clientHeight()

Returns the height of the scrollable widget in pixels.

Return Value: Number
The value of the widget height in pixels.

clientWidth()

Returns the width of the scrollable widget in pixels.

Return Value: Number
The value of the widget width in pixels.

content()

An HTML element of the widget.

Return Value: Object
An element representing in widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

refresh()

Executes the function passed to the pullDownAction option and locks the widget until the release(preventScrollBottom) method is called.

release(preventScrollBottom)

Notifies the scroll view that data loading is finished.

Parameters:
preventScrollBottom: Boolean
Indicates whether or not to prevent reachBottom action execution.
Return Value: Object
A Deferred jQuery object.

Use this method to hide the load indicator and release the scroll view after the pullDownAction or reachBottomAction has been executed.

Show Example:
jQuery

scrollBy(distance)

Scrolls the widget content by the specified number of pixels.

Parameters:
distance: Number
A distance to be scrolled in pixels.

Show Example:
jQuery

scrollBy(distanceObject)

Scrolls widget content by the specified number of pixels in horizontal and vertical directions.

Parameters:
distanceObject: Object
An object specifying a distance to be scrolled in pixels.

The function's parameter should be an object in the following format - { left: value1, top: value2 } - where the left field is the distance to be scrolled in a horizontal direction and the top field is the distance to be scrolled in a vertical direction.

scrollHeight()

Returns the height of the scrollable content in pixels.

Return Value: Number
The value of the content height in pixels.

scrollLeft()

Returns the current scroll position against the leftmost position.

Return Value: Number
The requested scroll position.

scrollOffset()

Returns how far the scrollable content is scrolled from the top and from the left.

Return Value: Object
An object in the following format: { top: *scrollTop*, left: *scrollLeft* }, where *scrollTop* and *scrollLeft* are the left and top scroll offsets respectively.

scrollTo(targetLocation)

Scrolls widget content to the specified position.

Parameters:
targetLocation: Number
A position to scroll to, in pixels.

Show Example:
jQuery

scrollTo(targetLocationObject)

Scrolls widget content to a specified position.

Parameters:
targetLocation: Object
An object specifying the target location after scrolling in pixels.

The function's parameter should be an object in the following format: { left: value1, top: value2 }, where the left field is the target location in a horizontal direction, and the top field is the target location in a vertical direction.

scrollTop()

Returns the current scroll position against the topmost position.

Return Value: Number
The requested scroll position.

scrollWidth()

Returns the width of the scrollable content in pixels.

Return Value: Number
The value of the content width in pixels.

update()

Updates the dimensions of the scrollable contents.

Use this method to fit the widget contents to the widget size after it (size) has been changed.

This function returns a resolved promise of the jQuery Deferred object when the update is complete.

Show Example:
jQuery