Interface JScrollPaneSettings

Index

Properties

Properties

optional public animateDuration?: number

The number of milliseconds taken to animate to a new position

optional public animateEase?: string

The type of easing to use when animating to a new position

optional public animateScroll?: boolean

Whether to use animation when calling scrollTo or scrollBy. You can control the animation speed and easing by using the animateDuration and animateEase settings or if you want to exercise more complete control then you can override the animate API method. Demo.

optional public arrowButtonSpeed?: number

A multiplier which is used to control the amount that the scrollpane scrolls each time on of the arrow buttons is pressed.

optional public arrowRepeatFreq?: number

The number of milliseconds between each repeated scroll event when the mouse is held down over one of the arrow keys.

optional public arrowScrollOnHover?: boolean

Whether the arrow buttons should cause the jScrollPane to scroll while you are hovering over them.

optional public autoReinitialise?: boolean

Whether jScrollPane should automatically reinitialise itself periodically after you have initially initialised it. This can help with instances when the size of the content of the scrollpane (or the surrounding element) changes. However, it does involve an overhead of running a javascript function on a timer so it is recommended only to activate where necessary.

optional public autoReinitialiseDelay?: number

The number of milliseconds between each reinitialisation (if autoReinitialise is true).

optional public clickOnTrack?: boolean

Whether clicking on the track (e.g. the area behind the drag) should scroll towards the point clicked on. Defaults to true as this is the native behaviour in these situations.

optional public contentWidth?: number

The width of the content of the scroll pane. The default value of undefined will allow jScrollPane to calculate the width of it's content. However, in some cases you will want to disable this (e.g. to prevent horizontal scrolling or where the calculation of the size of the content doesn't return reliable results)

optional public enableKeyboardNavigation?: boolean

Whether keyboard navigation should be enabled (e.g. whether the user can focus the scrollpane and then use the arrow (and other) keys to navigate around.

optional public hideFocus?: boolean

Whether the focus outline should be hidden in all browsers. For best accessibility you should not change this option. You can style the outline with the CSS property outline and outline-offset.

optional public hijackInternalLinks?: boolean

Whether internal links on the page should be hijacked so that if they point so content within a jScrollPane then they automatically scroll the jScrollPane to the correct place.

optional public horizontalArrowPositions?: string

Where the horizontal arrows should appear relative to the horizontal track.

optional public horizontalDragMaxWidth?: number

The largest width that the horizontal drag can have. The size of the drag elements is based on the proportion of the size of the content to the size of the viewport but is contrained within the minimum and maximum dimensions given.

optional public horizontalDragMinWidth?: number

The smallest width that the horizontal drag can have. The size of the drag elements is based on the proportion of the size of the content to the size of the viewport but is contrained within the minimum and maximum dimensions given.

optional public horizontalGutter?: number

The amount of space between the bottom of the content and the horizontal scrollbar.

optional public maintainPosition?: boolean

Whether the scrollpane should attempt to maintain it's position whenever it is reinitialised. If true then the viewport of the scrollpane will remain the same when it is reinitialised, if false then the viewport will jump back up to the top when the scrollpane is reinitialised. See also stickToBottom and stickToRight.

optional public mouseWheelSpeed?: number

A multiplier which is used to control the amount that the scrollpane scrolls each time the mouse wheel is turned.

optional public showArrows?: boolean

Whether arrows should be shown on the generated scroll pane. When set to false only the scrollbar track and drag will be shown, if set to true then arrows buttons will also be shown.

optional public stickToBottom?: boolean

If maintainPosition is true and the scrollpane is scrolled to the bottom then the scrollpane then the scrollpane will remain scrolled to the bottom even if new content is added to the pane which makes it taller.

optional public stickToRight?: boolean

If maintainPosition is true and the scrollpane is scrolled to its right edge then the scrollpane then the scrollpane will remain scrolled to the right edge even if new content is added to the pane which makes it wider.

optional public trackClickRepeatFreq?: number

The number of milliseconds between each repeated scroll event when the mouse is held down over the track.

optional public trackClickSpeed?: number

A multiplier which is used to control the amount that the scrollpane scrolls each trackClickRepeatFreq while the mouse button is held down over the track.

optional public verticalArrowPositions?: string

Where the vertical arrows should appear relative to the vertical track.

optional public verticalDragMaxHeight?: number

The largest height that the vertical drag can have. The size of the drag elements is based on the proportion of the size of the content to the size of the viewport but is contrained within the minimum and maximum dimensions given.

optional public verticalDragMinHeight?: number

The smallest height that the vertical drag can have. The size of the drag elements is based on the proportion of the size of the content to the size of the viewport but is contrained within the minimum and maximum dimensions given.

optional public verticalGutter?: number

The amount of space between the side of the content and the vertical scrollbar.