Olympe SDK

Class: Carousel

olympe.ui.std. Carousel

Create a Carousel component to display a series of dockable elements.

The Carousel is constituted of a view port and a stepper. The view port width and height are determined from the maximum of the children widths and heights, respectively. All elements are displayed at the view port centre.

Parameters:
Name Type Argument Default Description
elements olympe.df.SortedEnumerable.<!olympe.ui.std.DockableElement>
theme olympe.ui.std.theme.Theme
completeLabel olympe.df.OString | string <optional>
 Next

Methods

getSelectedElementIndex()

Get the a flow providing the rank of the element being displayed.

Returns:
Type
olympe.df.PONumber

isFirstElementSelected()

Get a flow telling whether the element currently displayed is the first element in the list or not.

Returns:
Type
olympe.df.POBoolean

isLastElementSelected()

Get a flow telling whether the element currently displayed is the last element in the list or not.

Returns:
Type
olympe.df.POBoolean

setBulletWidth(width)

Set stepper bullet width

Parameters:
Name Type Description
width olympe.df.PONumber

setLastItemCallback(callback)

Set a callback that will be called whenever the last item is reach and the next butotn is pressed

Parameters:
Name Type Description
callback function

setStepperSpacing(spacing)

Set spacing between spacer and view port

Parameters:
Name Type Description
spacing olympe.df.PONumber

showNextButton(show)

Display next button

Parameters:
Name Type Description
show olympe.df.OBoolean | boolean

showNextElement()

Display (cyclically) the next element.

showPreviousElement()

Display (cyclically) the previous element.