Parameters:
| Name |
Type |
Description |
id |
String
|
The id of the component. |
properties |
Object
|
HTMLElement
|
The properties used to initialize the component or the container element. |
- Mixes In:
Returns:
An instance of the component.
-
Type
-
Object
Extends
Classes
- DataPagerEvents
Members
Gets or sets the IDs of the pager buttons.
Type:
Gets or sets the css class of the button container.
Type:
cssClassInfoHolder :String
Gets or sets the css class of the info container.
Type:
cssClassPageHolder :String
Gets or sets the css class of the page container.
Type:
Type:
Gets or sets the id of the hidden input from which the settings are cloned. The hidden input contains the current page index.
Type:
initialIndexChange :Boolean
Gets or sets a value indicating whether the index change event is fired when the component is rendered.
Type:
itemCount :Number
Gets or sets the item count.
Type:
name :String
Type:
numericBoxId :String|null
Gets or sets the id of the numeric box from which the settings are cloned.
Type:
pageIndex :Number
Gets or sets the initial page index.
Type:
pageSize :Number
Gets or sets the items per page.
Type:
visiblePages :Number
Gets or sets the number of visible pages.
Type:
Methods
getPageCount()
getPageFirst()
Gets the first item index of the current page.
getPageIndex()
Gets the index of the current page.
getPageLast()
Gets the last item index of the current page.
render()
Parameters:
| Name |
Type |
Description |
content |
HTMLElement
|
Array.<HTMLElement>
|
DocumentFragment
|
String
|
HTML string or element node as content. Pass null or empty string to remove the existing template. |
setInfoTemplate(content)
Sets paging info template.
Parameters:
| Name |
Type |
Description |
content |
HTMLElement
|
Array.<HTMLElement>
|
DocumentFragment
|
String
|
HTML string or element node as content. Pass null or empty string to remove the existing template. |
setPageIndex(pageIndex)
Sets the page index to the specified number.
Parameters:
| Name |
Type |
Description |
pageIndex |
Number
|
The page index. |
suppressNextChangeEvent(action)
Suppresses any change events fired by the underlying input element during the execution of the provided action. Use this when programmatically setting a component value to prevent the change event from propagating as a user interaction.
The suppression is automatically lifted after the action completes, even if it throws.
Parameters:
| Name |
Type |
Description |
action |
function
|
The action to execute with change events suppressed. |
- Mixes In:
Type Definitions
IndexChangeEventArgs
DataPager index change event arguments.
Type:
Properties:
| Name |
Type |
Description |
pageIndex |
Number
|
The new page index (1-based). |