File

projects/components/src/widgets/common/carousel/carousel.directive.doc.ts

Description

The wmCarousel directive defines a carousel widget.

Index

Methods
Inputs

Methods

onChange
onChange(widget: any, newIndex: number, oldIndex: number)

Callback function which will be triggered when the widget is clicked or when datavalue has changed.

Parameters :
Name Type Optional Description
widget any No

Instance of the widget

newIndex number No

index of the active carousel in view

oldIndex number No

index of the previous carousel in view

Returns : void

Inputs

animation

This property controls the animation of an element. The animation is based on the CSS classes and works only in the run mode.

Allowed Values: auto, none

auto: Select to have an animation on the element

none: select for no animation

Type : string

Default value : 'auto'

animationinterval

This property defines the animation interval in seconds.

Type : number

Default value : 3

class

Class of the widget.

Type : string

controls

This property allows you to enable the controls for the selected widget

Allowed Values: navs, indicators, both, none

navs: To navigate left and right clickable arrows shows up on the carousel.

indicators: To indicate the number of carousel items, small white dots appears and are also clickable.

both: This control enables both navs and indicators.

none: None of the controls available.

Type : string

Default value : 'both'

name

Name of the carousel widget.

Type : string

show

This property will be used to show/hide the carousel widget on the web page.

Type : boolean

Default value : true

result-matching ""

    No results matching ""