jCarrotCell Demo: Using the API

Getting the API

To obtain the carrotCell API, a callback function can be used, see the customize demo: initialized callback. Another way is to obtain it through the carrotCell creation.

var myCarrotCell = $(".carrotCell").carrotCell();
var myAPI = $(myCarrotCell).data("carrotCell");

Calling API Methods

To see the complete list of API methods, please see the documentation.

This example shows how the API method getPAgeCount is used.

var kitten = $("#kitten").carrotCell();
var kittenAPI = $(kitten).data("carrotCell");
var howManyPages = kittenAPI.getPageCount();
$("#kittenResult").html(howManyPages + " pages of kittens");

Some API Methods

A demonstrating of the API methods follow.

For the complete list of what getters return, please see the documentation.

var getKitten = $("#getKitten").carrotCell({ auto: true, delay: 2000 });
var getKittenAPI = $(getKitten).data("carrotCell");			
var getResult = $("#getResult");

$("#getName").bind("click", function(){ getResult.html(getKittenAPI.getName()); });
$("#getPageCount").bind("click", function(){ getResult.html(getKittenAPI.getPageCount()); });
$("#getTotalItems").bind("click", function(){ getResult.html(getKittenAPI.getTotalItems()); });
$("#getSettings").bind("click", function(){ 			
	var mySettings = getKittenAPI.getSettings()
	var output = '';
	for (property in mySettings) {
	  output += property + ': ' + mySettings[property]+'; 
';
	}				
	getResult.html(output); 
});

$("#goForward").bind("click", function(){ getKittenAPI.forward(); });
$("#goBackward").bind("click", function(){ getKittenAPI.backward(); });
$("#goPlay").bind("click", function(){ getKittenAPI.play(); });
$("#goStop").bind("click", function(){ getKittenAPI.stop(); });
$("#goPause").bind("click", function(){ getKittenAPI.pause(); });