CarouselModel
Interface representing the Carousel class.
Properties
animationEffect CarouselAnimationEffect
Specifies the type of animation effect to use.
Default:
Slide
autoPlay Boolean
Specifies whether the slide transition starts automatically or manually.
Default:
true
buttonsVisibility CarouselButtonVisibility
Specifies how to show the previous, next, play and pause buttons visibility.
Default:
Visible
cssClass String
Specifies CSS classes to customize the appearance of the control.
Default:
""
dataStore Object[]
Specifies the data store for the carousel items.
Default: []
enableRtl Boolean
Specifies whether to render the control in right to left direction.
Default: false
enableState Boolean
Specifies whether to persist the state of the control between page loads.
- selectedIndex
Default: false
enableTouchSwipe Boolean
Specifies whether to enable the swipe action on touch devices or not.
Default: false
height String Number
Specifies the height of the accordion expressed in pixels, a number, or in a percentage.
Default: 100%
htmlAttributes {:}
Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.
Default: {}
indicatorsTemplate Function
Specifies the template for the indicators.
Default: null
indicatorsType CarouselIndicatorsType
Specifies the type of indicators to use.
Default: Default
interval Number
Specifies the duration in milliseconds between each carousel item transition.
Default: 5000
items CarouselItemModel[]
Specifies the collection of items to be displayed in the carousel.
Default: []
itemTemplate Function
Specifies the template for the carousel item.
Default: null
locale String
Specifies the culture and localization value for this control, overriding the globally defined value.
Default: en-US
loop Boolean
Specifies whether the slide transitions loops or the transition stops on the last slide.
Default: true
nextButtonTemplate Function
Specifies the template for the next button.
Default: null
partialVisible Boolean
Specifies whether to active slides with partial previous and next slides.
Default: false
pauseOnHover Boolean
Specifies whether the slide transition will be paused when hovered over or not.
Default: true
playButtonTemplate Function
Specifies the template for the play/pause button.
Default: null
previousButtonTemplate Function
Specifies the template for the previous button.
Default: null
selectedIndex Number
Specifies index of the current carousel item.
Default: 0
showIndicators Boolean
Specifies whether to show the indicator position, the current slide position of the carousel, or not.
Default: true
showPlayButton Boolean
Specifies whether to show the play button or not.
Default: false
swipeMode CarouselSwipeMode
Specifies whether the slide transition should occur while performing a swiping action via touch or mouse.
Default: Touch
width String Number
Specifies the width of the accordion expressed in pixels, a number, or in a percentage.
Default: 100%
Events
created EmitType<CreatedEventArgs>
Event callback that is raised when the control has been created.
destroyed EmitType<Object>
Event callback that is raised when the control has been destroyed.
slideChanged EmitType<SlideChangedEventArgs>
Event callback that is raised when the carousel item has changed.
slideChanging EmitType<SlideChangingEventArgs>
Event callback that is raised before the carousel item changes.