ScrollWrap Class Reference

Scroll bar container component, Controls the scrolling of a pdfviewer view
. More...

Inheritance diagram for ScrollWrap:

Public Member Functions
	getHeight ()
	Gets the height of the view. More...
	getScrollHost ()
	Gets the host of the scroll bar that needs to be listened to for scroll events. . More...
	getScrollLeft ()
	Viewer's scroll bar left value. More...
	getScrollOffsetLeft ()
	Viewer relative to the left of the scroll hosts. More...
	getScrollOffsetTop ()
	Viewer relative to the top of the scroll hosts. More...
	getScrollTop ()
	Viewer's scroll bar top value. More...
	getScrollX ()
	Gets the value of the horizontal scroll bar. More...
	getScrollY ()
	Gets the value of the vertical scroll bar. More...
	getWidth ()
	Holds the width of the view. More...
	scrollBy (x, y)
	Scroll to relative position. More...
	scrollTo (x, y)
	Scroll to position. More...

Detailed Description

Scroll bar container component, Controls the scrolling of a pdfviewer view
.

Example:

function example () {
   new PDFViewer({
       customs: {
           ScrollWrap: class CustomScrollWrap extends ScrollWrap {
               constructor (viewerRender) {
                   super(viewerRender)
               }
           }
       }
   })
}

Member Function Documentation

getHeight()

ScrollWrap::getHeight ( )

inline

Gets the height of the view.

Returns

{number}

getScrollHost()

ScrollWrap::getScrollHost ( )

inline

Gets the host of the scroll bar that needs to be listened to for scroll events.
.

Returns

{window | HTMLElement | Element}

getScrollLeft()

ScrollWrap::getScrollLeft ( )

inline

Viewer's scroll bar left value.

Returns

{Number}

getScrollOffsetLeft()

ScrollWrap::getScrollOffsetLeft ( )

inline

Viewer relative to the left of the scroll hosts.

Returns

{Number}

getScrollOffsetTop()

ScrollWrap::getScrollOffsetTop ( )

inline

Viewer relative to the top of the scroll hosts.

Returns

{Number}

getScrollTop()

ScrollWrap::getScrollTop ( )

inline

Viewer's scroll bar top value.

Returns

{Number}

getScrollX()

ScrollWrap::getScrollX ( )

inline

Gets the value of the horizontal scroll bar.

Returns

{Number}

getScrollY()

ScrollWrap::getScrollY ( )

inline

Gets the value of the vertical scroll bar.

Returns

{Number}

getWidth()

ScrollWrap::getWidth ( )

inline

Holds the width of the view.

Returns

{number}

scrollBy()

ScrollWrap::scrollBy (   x,   y  )

inline

Scroll to relative position.

Parameters

x	{number}
y	{number}

scrollTo()

ScrollWrap::scrollTo (   x,   y  )

inline

Scroll to position.

Parameters

x	{number}
y	{number}