ui.vscroll
Virtual scrolls.
The component renders plain scrolls without content.
Constructor
var vscroll = webix.ui({
view:"vscroll",
container:"mydiv",
...config options goes here..
})
//or, in case of jQuery
$("#mydiv").webix_vscroll({
...config options goes here..
});
Methods
activeArea | assigns active mouse wheel zone |
attachEvent | attaches the handler to an inner event of the component (allows behaviour customizations) |
blockEvent | temporarily blocks triggering of ALL events of the calling object |
callEvent | calls an inner event |
define | redefines a single configuration property (or a hash of properties) |
detachEvent | detaches a handler from an event (which was attached before by the attachEvent method) |
getScroll | return current state of scroller |
getSize | returns full scrollable size ( scrollWidth or scrollHeight of content ) |
hasEvent | checks whether the component has the specified event |
mapEvent | routes events from one object to another |
scrollTo | set new position of scroller |
sizeTo | set new size of scrollable content ( scrollWidth or scrollHeight ) |
unblockEvent | cancels blocking events that was enabled by the 'blockEvent' command |
Events
onScroll | fires when the scroll changes its position |
Properties
container | an html container (or its id) where the component needs initializing |
id | the component ID |
on | allows attaching custom handlers to inner events of the component |
scroll | the direction of scrolling |
scrollHeight | the scrolling height of the object (vertical scrolling) |
scrollPos | the top (vertical scrolling ) or left (horizontal scrolling) offset of the scroll. |
scrollSize | the width(vertical scrolling) or height(horizontal scrolling) of the scroll |
scrollStep | the number of items that will be scrolled on each mouse move |
scrollVisible | defines visibility of scroll |
scrollWidth | the scrolling width of the object (horizontal scrolling) |
zoom | the zoom of the total scroll bar length |
Other
config | all options from initial component configuration |
name | indicates the name of the component (a read-only property) |
Back to top