Class: SimuScroll

new SimuScroll(cfg)

Name Type Description

cfg

object

config for scroll

Name	Type	Description
`SCROLL_ACCELERATION`	number	acceleration for scroll, min value make the scrolling smoothly
`BOUNDRY_CHECK_DURATION`	number	duration for boundry bounce
`BOUNDRY_CHECK_EASING`	number	easing for boundry bounce
`BOUNDRY_CHECK_ACCELERATION`	number	acceleration for boundry bounce
`lockX`	boolean	just like overflow-x:hidden
`lockY`	boolean	just like overflow-y:hidden
`scrollbarX`	boolean	config if the scrollbar-x is visible
`scrollbarY`	boolean	config if the scrollbar-y is visible
`useTransition`	boolean	config if use css3 transition or raf for scroll animation
`bounce`	boolean	config if use has the bounce effect when scrolling outside of the boundry
`boundryCheck`	boolean	config if scrolling inside of the boundry
`preventDefault`	boolean	prevent touchstart
`preventTouchMove`	boolean	prevent touchmove
`container`	string \| HTMLElement	config for scroller's container which default value is ".xs-container"
`content`	string \| HTMLElement	config for scroller's content which default value is ".xs-content"
`indicatorInsets`	object	config scrollbars position {top: number, left: number, bottom: number, right: number}
`stickyElements`	string	config for sticky-positioned elements
`fixedElements`	string	config for fixed-positioned elements
`touchAction`	string	config for touchAction of the scroller

Example

var xscroll = new SimuScroll({
   renderTo:"#scroll",
   lockX:false,
   scrollbarX:true
});
xscroll.render();

Extends

XScroll

Methods

staticSimuScroll.boundryCheck(){SimuScroll} simulate-scroll.js, line 559

bounce to the boundry vertical and horizontal

staticSimuScroll.boundryCheckX(){SimuScroll} simulate-scroll.js, line 509

bounce to the boundry horizontal

staticSimuScroll.boundryCheckY(){SimuScroll} simulate-scroll.js, line 534

bounce to the boundry vertical

staticSimuScroll.computeScroll(zoomType, velocity){Object} simulate-scroll.js, line 445

compute scroll transition by zoomType and velocity

Name	Type	Description
`zoomType`	string	zoomType of scrolling
`velocity`	number	velocity after panend

Example

var info = xscroll.computeScroll("x",2);
// return {pos:90,easing:"easing",status:"inside",duration:500}

staticSimuScroll.destroyScrollBars(){SimuScroll} simulate-scroll.js, line 642

destroy scrollbars

staticSimuScroll.getBoundryOutBottom(){number} simulate-scroll.js, line 424

get the offset value outsideof bottom

staticSimuScroll.getBoundryOutLeft(){number} simulate-scroll.js, line 416

get the offset value outsideof left

staticSimuScroll.getBoundryOutRight(){number} simulate-scroll.js, line 432

get the offset value outsideof right

staticSimuScroll.getBoundryOutTop(){number} simulate-scroll.js, line 408

get the offset value outsideof top

staticSimuScroll.getScrollLeft(){number} simulate-scroll.js, line 144

get scroll left value

staticSimuScroll.getScrollTop(){number} simulate-scroll.js, line 135

get scroll top value

staticSimuScroll.init() simulate-scroll.js, line 59

staticSimuScroll.initController(){SimuScroll} simulate-scroll.js, line 652

init controller for multi-scrollers

staticSimuScroll.initScrollBars(){SimuScroll} simulate-scroll.js, line 611

init scrollbars

staticSimuScroll.isBoundryOut(){boolean} simulate-scroll.js, line 368

judge the scroller is out of boundry horizontally and vertically

staticSimuScroll.isBoundryOutBottom(){boolean} simulate-scroll.js, line 400

judge if the scroller is outsideof bottom

staticSimuScroll.isBoundryOutLeft(){boolean} simulate-scroll.js, line 376

judge if the scroller is outsideof left

staticSimuScroll.isBoundryOutRight(){boolean} simulate-scroll.js, line 384

judge if the scroller is outsideof right

staticSimuScroll.isBoundryOutTop(){boolean} simulate-scroll.js, line 392

judge if the scroller is outsideof top

staticSimuScroll.render(){SimuScroll} simulate-scroll.js, line 594

render scroll

staticSimuScroll.scrollLeft(scrollLeft, duration, easing) origin-scroll.js, line 86

horizontal scroll absolute to the destination

Name	Type	Description
`scrollLeft`	number	scrollLeft
`duration`	number	duration for animte
`easing`	string	easing functio for animate : ease-in \| ease-in-out \| ease \| bezier(n,n,n,n)

staticSimuScroll.scrollLeft(scrollLeft, duration, easing) simulate-scroll.js, line 155

horizontal scroll absolute to the destination

Name	Type	Description
`scrollLeft`	number	scrollLeft
`duration`	number	duration for animte
`easing`	string	easing functio for animate : ease-in \| ease-in-out \| ease \| bezier(n,n,n,n)

staticSimuScroll.scrollTop(scrollTop, duration, easing) origin-scroll.js, line 51

vertical scroll absolute to the destination

Name	Type	Description
`scrollTop`	number	scrollTop
`duration`	number	duration for animte
`easing`	string	easing functio for animate : ease-in \| ease-in-out \| ease \| bezier(n,n,n,n)

staticSimuScroll.scrollTop(scrollTop, duration, easing) simulate-scroll.js, line 169

vertical scroll absolute to the destination

Name	Type	Description
`scrollTop`	number	scrollTop
`duration`	number	duration for animte
`easing`	string	easing functio for animate : ease-in \| ease-in-out \| ease \| bezier(n,n,n,n)

staticSimuScroll.stop(){SimuScroll} simulate-scroll.js, line 569

stop scrolling immediatelly

staticSimuScroll.translate(x, y, scale) simulate-scroll.js, line 183

translate the scroller to a new destination includes x , y , scale

Name	Type	Description
`x`	number	x
`y`	number	y
`scale`	number	scale