The CarouselPanel widget displays images in a carousel. It allows the use of the widget as a composable region for text widgets, and image widgets.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Auto play speedThe delay (in milliseconds) before auto switching panels.
DisabledThe widget cannot be used.
FadeUse a fading transition between panels instead of rotating.
HiddenHides the widget from the user.
Infinite ModeAllow infinite scroll by wrapping around to the start when reaching the end.
MaximizeSet this widget to be maximized (take up all available space).
Navigation typeThe type of controls used to navigate the carousel.
pauseOnHoverPause the change of photos as a carousel when you hover on the widget.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
Transition Speed (ms)The duration (in milliseconds) between each panel rotation.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
AfterChange Triggered after the slide is changed on the carousel.
event Object containing information about current slide (event.currentSlide).
BeforeChange Triggered just before the change of the carousel slide. Contains information about current and next slide
event Object containing information about current slide (event.currentSlide) and the next slide (event.nextSlide).
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.

Function

goto ( paneId: String )

Sets the currently visible pane.

Parameters
Name Type Description
paneId String The id of the pane to made visible.

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.