Constructor

new Carousel(carousel)

Constructor for Carousel. Accepts optional Carousel to clone or list of items to copy.

Parameter

carousel

Optional

(Carousel or Array of OptionItem)

Either a carousel to clone or an array of OptionItem to initialize a new carousel

Property

items

Array of OptionItems

List of 2-20 items to show in this carousel. Required.

Methods

addItems

addItems(optionItems) returns Carousel

Adds a single item or list of items to the carousel.

Parameter

optionItems

(OptionItem or Array of OptionItem)

OptionItems to add.

Returns

Carousel Returns current constructed Carousel.

setImageDisplay

setImageDisplay(option) returns Carousel

Sets the display options for the images in this carousel. Use one of the image display constants. If none is chosen, ImageDisplays.DEFAULT will be enforced.

Parameter

option

string

The option for displaying the image.

Returns

Carousel Returns current constructed Carousel.