Peek.js - Documentation - Public Functions

Running:

start( options ):

Starts the peek process using the options passed and attaches the viewed to the DOM elements.
Parameter: options: 'Object' - All the options that should be used (refer to "Start Options" documentation for properties).
Returns: 'Object' - The Peek.js class instance.

stop():

Stops the peek process.
Returns: 'Object' - The Peek.js class instance.

close():

Closes the dialog.
Returns: 'Object' - The Peek.js class instance.

Configuration:

setConfiguration( newOptions ):

Sets the specific configuration options that should be used.
Parameter: newOptions: 'Object' - All the configuration options that should be set (refer to "Configuration Options" documentation for properties).
Returns: 'Object' - The Peek.js class instance.

Additional Data:

getVersion():

Returns the version of Peek.js.
Returns: 'string' - The version number.