ui.pager

Page navigation control.

The component makes little sense on its own, but can be used with other data-based components such as DataTable, DataView, List. Not purposed for direct initialization. Check pager documentation for more detailed description.

Constructor

webix.ui({
  view:"list",
  template:"#id#. #title#",
  pager:{   
    size:1,
    group:4
  },
  data:[
     {"id":1,"title":"Item 1"},
     {"id":2,"title":"Item 2"},
     {"id":3,"title":"Item 3"},
     {"id":4,"title":"Item 4"},
     {"id":5,"title":"Item 5"},
     {"id":6,"title":"Item 6"},         
  ]
});

Where to start

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
clone creates a copy of the pager
customize redefines the 'type' property
define redefines a single configuration property (or a hash of properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
getChildViews returns child views of the calling component
getFormView returns master form for the input
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getTopParentView returns top parent view
hasEvent checks whether the component has the specified event
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
queryView returns inner element/elements of a widget that correspond to the defined parameters
refresh repaints the whole view or a certain item
render renders the specified item or the whole component
resize adjusts the view to a new size
select switches pager to the necessary page (zero-based numbering)
show makes the component visible
sync allows you to sync two copies of data (all or just a part of it) from one DataCollection to another
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
Events
onAfterContextMenu fires after the context menu was called in the item area
onAfterPageChange fires after a page is changed
onAfterRender occurs immediately after the component has been rendered.
onAfterScroll occurs when some webix view has been scrolled
onBeforeContextMenu fires before the context menu is called in the item area
onBeforePageChange fires before the page is changed
onBeforeRender occurs immediately before the component has been rendered
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onDestruct occurs when component destroyed
onFocus fires when a view gets focus
onItemClick fires when a component item was clicked
onItemDblClick fires when a component item was double-clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLongTouch fires on holding finger in some position for a certain period of time
onMouseMove fires when the mouse was moved over the specified component
onMouseMoving fires when the mouse was moved over the component
onMouseOut fires when the mouse was moved out from the specified item
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart when some webix view has been touched
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
apiOnly makes the pager invisible to enable paging with custom buttons
borderless used to hide the component borders
container an HTML container (or its id) where the component should be initialized
count the total number of records that the pager will process
css the name of a css class that will be applied to the view container
disabled indicates whether an item is enabled
gravity sets the view gravity (1 by default)
group the number of visible pages in the pager
height sets the height of the component
hidden defines whether the view will be hidden initially
id the component ID
limit the total number of pages in the pager
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
mouseEventDelay the delay between a real mouse action and invoking the related events
on allows attaching custom handlers to inner events of the component
onClick attaches a click behavior for component items with the specified CSS class.
onContext a property used to define custom context-click (right click) handlers for elements in the DataTable cells
onDblClick attaches a dblclick behavior for component items with the specified CSS class.
onMouseMove attaches a mousemove behaviour for component items with the specified CSS class.
page sets the currently active page (zero-based numbering)
size sets the number of records per page
template the component template
width sets the width of the component
Other
$getSize returns the current size of the component
$height current height of the view
$scope scope for resolving event and method names
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
name indicates the name of the component (a read-only property)
on_click redefines default click behavior for component items.
on_context a property used to define custom context-click (right click) handlers for elements in the DataTable cells
on_dblclick attaches a dblclick behavior for component items with the specified CSS class
on_mouse_move attaches a mouse move behavior for component items with the specified CSS class
type currently used set of helpers for view rendering
Back to top