wijsuperpanel jQuery Widget

Add custom scrolling, resizing, rounded corners, and drop shadows to any panel on your page with this alternative to the HTML scroll bar for overflow elements.

Syntax

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.superpanel.wijsuperpanel.options
     
    $(".selector").wijsuperpanel(options);
});

function wijsuperpanel() : any;

Options

	Name	Description
	allowResize	Default value: false The value determines whether the wijsuperpanel can be resized.
	animationOptions	Type: wijmo.superpanel.superpanel_animation The animationOptions function determines whether or not the animation is shown. If true, it defines the animation effect and controls other aspects of the widget's animation, such as duration, queue, and easing.
	autoRefresh	Default value: false This value determines whether wijsuperpanel is automatically refreshed when the content size or wijsuperpanel size are changed. Set this value to true if you load images in the wijsuperpanel without specifying their sizes.
	bubbleScrollingEvent	Default value: true This value determines whether to raise the mouse wheel event when wijsuperpanel is scrolled to the end.
	customScrolling	Default value: false Determines if use custom scrolling.
	hScroller	Type: wijmo.superpanel.superpanel_hscroller This option contains horizontal scroller settings.
	keyboardSupport	Default value: false This value determines whether wijsuperpanel provides keyboard scrolling support.
	keyDownInterval	Default value: 100 This value determines the time interval to call the scrolling function when doing continuous scrolling.
	listenContentScroll	Default value: false Determines if the native scroll events should be listened.
	mouseWheelSupport	Default value: true This value determines whether wijsuperpanel has mouse wheel support.
	resizableOptions	This option determines the behavior of the resizable widget. See the JQuery UI resizable options document for more information.
	showRounder	Default value: true This value determines whether to show the rounded corner of wijsuperpanel.
	vScroller	Type: wijmo.superpanel.superpanel_vscroller This option contains vertical scroller settings.

Top

Methods

	Name	Description
	destroy	Destroys wijsuperpanel widget and reset the DOM element.
	getContentElement	Gets the content element of wijsuperpanel.
	hScrollTo	Scroll to horizontal position.
	needToScroll	Determine whether scoll the child DOM element to view need to scroll the scroll bar
	paintPanel	Refreshes wijsuperpanel. Needs to be called after content being changed.
	refresh	Refreshes wijsuperpanel. Needs to be called after content being changed.
	scrollChildIntoView	Scroll children DOM element to view.
	scrollPxToValue	Convert pixel to scroll value. For example, wijsuperpanel scrolled 50px which is value 1 after conversion.
	scrollTo	Scroll to the specified position. which is value 1 after conversion.
	scrollValueToPx	Convert scroll value to pixel. For example, scroll value is 1 which makes wijsuperpanel scrolled 50px after conversion.
	vScrollTo	Scroll to vertical position.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	dragStop	This function gets called when the user stops dragging the thumb buttons of the scrollbars.
	hScrollerActivating	The hScrollerActivating event handler. A function called when horizontal scrollbar is activating.
	painted	This function gets called after panel is painted.
	resized	Resized event handler. This function gets called when the resized event is fired.
	scroll	Scroll event handler. This function is called before scrolling occurs.
	scrolled	Scrolled event handler. This function gets called after scrolling occurs.
	scrolling	Scrolling event handler. A function called before scrolling occurs.
	vScrollerActivating	A function called when the vertical scrollbar is activating.

Top

Widgets

SuperPanel

Reference

wijsuperpanel jQuery Widget