wijlist jQuery Widget

Allow users to select one or more items from a customizable list.

Syntax

Javascript (Usage)
Javascript (Specification)

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

function wijlist() : any;

Options

	Name	Description
	addHoverItemClass	Default value: true The addHoverItemClass option determines whether the "ui-state-hover" class is applied to a list item on mouse over.
	autoSize	Default value: false The autoSize determines whether or not the wijlist will be automatically sized.
	dataSource	Default value: null This option is the wijdataview to which the wijlist is bound.
	disabled	Default value: false Determines whether the widget is disabled. If set to true, the control appears dimmed and does not respond when clicked.
	keepHightlightOnMouseLeave	Default value: false A value determines the highlight state when the mouse leaves an item.
	listItems	Default value: [] An array that specifies the listItem collections of wijlist.
	maxItemsCount	Default value: 5 A value specifies the maximum number of items that will be displayed if the autoSize option is also set to true.
	selectedIndex	Default value: -1 A value that specifies the index of the item to select when using single mode.
	selectionMode	Default value: 'single' A value indicates the list items can be single-selected or multi-selected
	superPanelOptions	Default value: null The superPanelOptions option indicates the customized options of wijsuperpanel when the wijsuperpanel is created.

Top

Methods

	Name	Description
	activate	The activate method activates an item in the wijlist and allows the list to scroll to the item.
	addItem	The addItem method adds the specified item to the list by index.
	deactivate	The deactivate method deactivates the activated item in the wijlist widget.
	destroy	Remove the functionality completely. This will return the element back to its pre-init state.
	findIndexByLabel	Allows the user to find the index of first matched list item by item's label.
	first	The first method tests whether the focus is at the first list item.
	getItems	The getItems method allows the user to find list items by index or by value.
	getList	The method gets the jQuery object reference of the <ul> element of the wijlist widget.
	getSelectedItems	Get the select item(s).
	indexOf	The indexOf method returns the index of the specified list item.
	last	The last method tests whether the last list item has focus.
	next	The next method moves focus to the next list item.
	nextPage	The nextPage method turns to the next page of the list.
	popItem	The popItem method removes the last item from the wijlist widget.
	previous	The previous method moves focus to the previous list item.
	previousPage	The previous method moves focus to the previous list item.
	refreshSuperPanel	The refreshSuperPanel method refreshes the SuperPanel around the wijlist to reflect a change in the wijlist content.
	removeAll	The removeAll method removes all items from the wijlist.
	removeItem	The removeItem method removes the specified item from the wijlist.
	removeItemAt	The removeItemAt method removes the specified list item by index from the wijlist widget.
	renderList	The renderList method renders the wijlist widget on the client browser when list items change.
	selectItems	Selects item(s) in the list by item index/indices or value(s).
	setItems	The method sets the items for the wijlist to render.
	unselectItems	The unselectItems method clears selections from the indicated list items.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	added	The added event is fired after adding item in addItem method.
	blur	The blur event is fired when the mouse leaves the item.
	focus	The focus event is fired when the mouse enters the list item and after the hover event logic is processed.
	focusing	The focusing event is fired when the mouse enters the list item and before the hover event logic is processed.
	itemRendered	The itemRendered event is fired after a list item is rendered.
	itemRendering	The itemRendering event is fired before a list item is rendered.
	listRendered	The listRendered event is fired after the list is rendered.
	selected	Select event handler of wijlist. A function will be called when any item in the list is selected.

Top

Widgets

List

Reference

wijlist jQuery Widget