Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

clientHeight()

Returns the height of the scrollable widget in pixels.

Return Value:

Number

The value of the widget height in pixels.

See Also

clientWidth()

Returns the width of the scrollable widget in pixels.

Return Value:

Number

The value of the widget width in pixels.

See Also

content()

Returns the widget's container.

Return Value:

Element (jQuery or HTML)

The widget's container. An HTML element or a jQuery element when you use jQuery.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:
rule:

Object

An object specifying default options for the component and the device for which the options must be applied.

Object structure:
device:

Object

|

Array<Object>

|

function

An object representing device parameters, or an array of objects representing device parameters, or a function that provides information on the current device as an input parameter and returning a Boolean value.

options:

Object

A configuration object with specified options.

The defaultOptions method is a static method supported by the widget class. The following code demonstrates how to specify default options for all buttons in the application executed on the iOS platform.

JavaScript
DevExpress.ui.dxButton.defaultOptions({ 
    device: { platform: "ios" },
    options: {
        text: "Click me"
    }
});

dispose()

Removes the widget from the DOM.

element()

Gets the root element of the widget.

Return Value:

Element (jQuery or HTML)

The widget's root element. An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

getInstance(element)

Gets the widget's instance using a DOM element.

Parameters:
element:

DOM Node

|

jQuery

An element containing the widget.

Return Value:

Object

The widget's instance.

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

Return Value:

Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

eventHandler:

function

The handler to be detached from the specified event.

Return Value:

Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName:

String

The name of the event to be subscribed.

eventHandler:

function

An event handler for the specified event.

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to the specified events.

Parameters:
events:

Object

An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName:

String

The option name or the full path to the option.

Return Value: any

This option value.

See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName:

String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also

option(options)

Sets one or more options.

Parameters:
options:

Object

The options along with their new values.

See Also

refresh()

Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event.

See Also

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:

Promise (jQuery or native)

A Promise that is resolved after the widget is released. It is a native Promise or a jQuery.Promise when you use jQuery.

Use this method to hide the load indicator and release the scroll view after the pullDown or reachBottom events have been raised.

See Also
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.

See Also
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.

See Also

scrollHeight()

Returns the height of the scrollable content in pixels.

Return Value:

Number

The value of the content height in pixels.

See Also

scrollLeft()

Returns the current scroll position against the leftmost position.

Return Value:

Number

The requested scroll position.

See Also

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.

See Also

scrollTo(targetLocation)

Scrolls widget content to the specified position.

Parameters:
targetLocation:

Number

A position to scroll to, in pixels.

See Also
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.

See Also

scrollToElement(targetLocation)

Scrolls widget content to the specified element.

Parameters:
element:

DOM Node

|

jQuery

A DOM Node or jQuery object the widget should scroll to.

See Also

scrollTop()

Returns the current scroll position against the topmost position.

Return Value:

Number

The requested scroll position.

See Also

scrollWidth()

Returns the width of the scrollable content in pixels.

Return Value:

Number

The value of the content width in pixels.

See Also

update()

Updates the scrollable contents' dimensions.

Return Value:

Promise (jQuery or native)

A Promise that is resolved after the update is completed. It is a native Promise or a jQuery.Promise when you use jQuery.

Use this method to fit the widget's contents to the widget's size if it changes.

See Also
Show Example:
AngularJS
Knockout
jQuery