Loading...

Product List API

Methods
RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

get_productListSorter()

Returns the product list sort dropdown select tag.

Example-get_productListSorter()

tpc.page.TpcProductList.get_productListSorter();
Parameters

Returns

jQuery object 

get_container()

Returns the div container of the widget.

Example-get_container()

tpc.page.TpcProductList.get_container();

Parameters

Returns

jQuery Object

get_productViewSwitcher()

Returns the product view switcher ul tag. 

Example-get_productViewSwitcher()

tpc.page.TpcProductList.get_productViewSwitcher();
Parameters

None

Returns

jQuery Object

get_errorTemplate()

Returns the kendo template for the error element of the widget.

Example-get_errorTemplate()

tpc.page.TpcProductList.get_errorTemplate();

Parameters

Returns

jQuery object

hide()

Hides the widget from the form.

Example-hide()

tpc.page.TpcProductList.hide();

Parameters

Returns

None

get_type()

Returns the type of widget it is. Can be used in conjunction with findAll().

Example-get_type()

tpc.page.TpcProductList.get_type();

tpc.findAll()[0].get_type();

Parameters

Returns

String

get_productListview()

Returns information related to the product list.

Example-get_productListview()

tpc.page.TpcProductList.get_productListview();
Parameters

Returns

Object

get_errorContainer()

Returns the error containing div. 

Example-get_errorContainer()

tpc.page.TpcProductList.get_errorContainer();
Parameters

Returns

jQuery Object

get_element()

Returns the div containing the product list view.

Example-get_element()

tpc.page.TpcProductList.get_element();

Parameters

Returns

jQuery Object

show()

Shows the widget on the form.

Example-show()

tpc.page.TpcProductList.show();

Parameters

Returns

None

toggle()

Toggles the visibility of the widget.

Example-toggle()

tpc.page.TpcProductList.toggle();

Parameters

Returns

None

get_model()

Returns the configuration information of the widget.

Example-get_model()

tpc.page.TpcProductList.get_model();

Parameters

Returns

Object