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: Number Default Value: 5000
imageCss
Type: Array<CustomType<bootstrapextracomponents-carousel.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: Number Default Value: 300
slides
Type: Array<CustomType<bootstrapextracomponents-carousel.slide>>
slidesFoundset
Type: JSFoundset
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(event,slide)
Parameters:
{JSEvent} event
API
addSlide(slideToAdd)
Adds the given slide
Parameters:
{CustomType<bootstrapextracomponents-carousel.slide>} slideToAdd The slide object to be added to the collection.
getSelectedIndex()
Returns the index of the currently selected slide (0 based)
Returns: Number Index The 0-based index of the currently selected slide.
removeSlide(index)
Removes the slide at the given index (0 based)
Parameters:
{Number} index The 0-based index of the slide to be removed or set as selected.
setSelectedIndex(index)
Sets the selected slide to the given index (0 based)
Parameters:
{Number} index The 0-based index of the slide to be removed or set as selected.
setSlides(slides)
Sets the given slides
Parameters:
{Array<slide>} slides An array of slide objects to set as the current collection of slides.
Types
cssProperty
scripting type: CustomType<bootstrapextracomponents-carousel.cssProperty>
slide
scripting type: CustomType<bootstrapextracomponents-carousel.slide>
Last updated
Was this helpful?