jOVI

jOVI Reference

This page contains a reference to the jQuery jOVI API. It is usually updated to the latest stable version of the plugin, that you can find in the dist directory. If some method that you find in the documentation does not work, most likely I forgot to generate a new jOVI release. In this case either try the version in the src directory (but you'll have to minify it yourself) or send me a tweet.

Calling methods

The syntax I chose to use for making method calls in jOVI are very similar to the one used by the amazing jQuery UI. A typical method call in jOVI looks like this:

$('#container').jOVI('methodName'[, [parameters]]);

Parameter can be simple (String, Number) or complex objects. Typically there is only one complex object referred as "options" in the documentation below. The documentation shows for each parameter and each option what are the possible values and the related types.

The color convention is the following:

• Method Group
• thisIsAMethod
• thisIsAParameter
• thisIsAnOption
• ParameterType
• Default: Value

The method init is implicitly invoked if no method is explicitly indicated. Generally methods throw an error if they are invoked on a container where jOVI was never initialized.