Carousel

(part of package 'Bootstrap Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

cycleInterval

Type: int Default Value: 5000


imageCss

Type: cssProperty[]


imageOptions

Type: string Default Value: "Reduce"


lazyLoading

Type: boolean Default Value: true


location

Type: point


noPause

Type: boolean Default Value: false


noTransition

Type: boolean Default Value: false


responsiveHeight

Type: int Default Value: 300


slides

Type: slide[]


slidesFoundset

Type: foundset


styleClass

Type: styleclass


updateRecordSelection

When true the foundset's selection is updated with any slide selection

Type: boolean Default Value: false


visible

Type: visible


Events

onSlideClicked

Parameters:

event JSEvent slide slide


API

addSlide

Adds the given slide

@param {slide} slideToAdd

Parameters:

slideToAdd slide


getSelectedIndex

Returns the index of the currently selected slide (0 based)

@return {Number} index

Returns: int


removeSlide

Removes the slide at the given index (0 based)

@param {Number} index

Parameters:

index int


setSelectedIndex

Sets the selected slide to the given index (0 based)

@param {Number} index

Parameters:

index int


setSlides

Sets the given slides

@param {Array<slide>} slides

Parameters:

slides slide[]


Types

cssProperty

scripting type: CustomType<bootstrapextracomponents-carousel.cssProperty>

slide

scripting type: CustomType<bootstrapextracomponents-carousel.slide>


Last updated