Global

Members

BasicTransition

Source:
Source:
Instance of a Slider class (@see Slider).
Source:
Displayed slide (jQuery object).
Source:
Returns current slide.
Type:
  • Object
Source:
Initializes the carousel. Wraps carousel content with
element, selects slides (
  • elements) from
      element, initializes Slider class instance, resets the carousel, and starts automatic slides changing.
  • Source:
    Resets the carousel.
    Source:
    All slides (jQuery object).
    Source:
    Changes current slide to a $newSlide.

    FadeInTransition

    Source:

    FadeInTransition

    Source:
    Source:
    Navigation 'previous' item (if prev/next items are enabled).
    Source:
    Instance of SliderContext class (@see SliderContext)
    Source:
    Navigation items (one for each slide if navigation is enabled).
    Source:
    jQuery object
    Source:
    Selected item (one from this.$items or null).
    Source:
    CSS class used to mark selected item.
    Source:
    Mark navigation item with given index as selected.
    Source:
    Creates or selects navigation items container and fills it with navigation items. If navigation items container is not empty, child elements are adopted as navigation items. Mode of action depends on settings object: var settings = { 'label': '#{index}', 'selector': null }; If settings.selector === null navigation item container is created. If settings.selector !== null element that match settings.selector is adapted as navigagation items container.
    Type:
    • Object
    Source:
    Creates or selects navigation 'previous' and 'next' navigation items (@see NavigationBuilder.createPrevNextItem()). If navigation items container is not empty, child elements are adopted as navigation items.
    Source:
    Navigation 'next' item (if prev/next items are enabled).

    ProgressBarView

    Source:

    ProgressBarView

    Source:

    ProgressBarView

    Source:

    ProgressBarView

    Source:

    RotatorView

    Source:

    RotatorView

    Source:

    RotatorView

    Source:

    RotatorView

    Source:

    SlideHorizontallyTransition

    Source:

    SlideHorizontallyTransition

    Source:

    Slider

    Source:
    Schedules change of a slide, by setting timeout (using setTimeout() function) if it can. If cannot, it tries again after short period of time.

    Slider

    Source:
    Changes current slide by offset performing context.transition Any offset value is save (if it is an integer).

    Slider

    Source:
    Starts automatic slide changing

    Slider

    Source:
    Cancel the default action of event and changes slides manually.

    Slider

    Source:
    Selects navigation item with given index.

    Slider

    Source:
    Executes method with given methodName on each Timer in context.timers (@see Timer)

    Slider

    Source:
    Deschedules change of a slide, by clearing timeout previously set by setTimeout() function.

    SliderContext

    Source:
    Instance of TimeIndicator class (@see TimeIndicator)

    SliderContext

    Source:
    Last timeout identifier.

    SliderContext

    Source:
    Default Slider setting object (@see Slider)

    SliderContext

    Source:
    Navigation object (@see Navigation)

    SliderContext

    Source:
    Slider object that this context is attached to.

    SliderContext

    Source:
    Flag that determines if change of a slide can or can not be scheduled.

    SliderContext

    Source:
    Slider setting object

    SliderContext

    Source:
    Instance of Timer class (@see Timer) that is used to store how much time is left to change the slide.

    SliderContext

    Source:
    Flag that determines if slide can or cannot be changed (for user request)

    SliderContext

    Source:
    Timers array.

    SliderContext

    Source:
    Transition (@see XA.component.carousels.Transitions.Transition) used while changing slides

    SliderContext

    Source:
    Transition settings object (@see XA.component.carousels.Transitions.TransitionSettings)

    SliderContext

    Source:
    jQuery object that contains all slides

    SliderContext

    Source:
    jQuery object that contains the element that wraps slides

    SliderContext

    Source:
    Reference to method that should return jQuery object with current slide

    SliderContext

    Source:
    Reference to method that should change current slide

    SlideVerticallyTransition

    Source:

    SlideVerticallyTransition

    Source:

    Timer

    Source:
    Counts time difference between current time and saved time stamp

    Timer

    Source:
    Saves new time stamp

    Timer :Number

    Source:
    Counts time difference between current time and saved time stamp
    Type:
    • Number

    Timer

    Source:
    Resets elapsed time.

    Timer

    Source:
    Time stamp

    Timer

    Source:
    Time difference between last update() call and last set() call

    TimerIndicator

    Source:
    Plays the attached view.

    TimerIndicator

    Source:
    Pauses the attached view.

    TimerIndicator

    Source:
    Counts time difference between current time and saved time stamp and updates the attached view

    TimerIndicator

    Source:
    Resets elapsed time and resets the attached view.

    TimerIndicator

    Source:
    A time indicator view.

    Transition :Number

    Source:
    Returns a factor associated with settings.offset (@see TransitionSettings) that can be usefull for some animations.
    Type:
    • Number

    Transition

    Source:
    This method is called used by carousels to change slides. Important: settings.callback() (@see TransitionSettings) have to be called at the end of this method execution.

    Transition

    Source:
    Initializes a transition with given settings (@see TransitionSettings).

    TransitionSettings

    Source:
    Callback function that must be called after animation.

    TransitionSettings

    Source:
    Offset between $currentSlide and $nextSlide

    TransitionSettings

    Source:
    All slides (jQuery object)

    TransitionSettings

    Source:
    Next slide jQuery object

    TransitionSettings

    Source:
    Current slide (currently displayed) jQuery object

    View

    Source:
    A jQuery object containing element that will be animated to show time progress.

    View

    Source:
    Updates the time that elapsed since animation began.

    View

    Source:
    Starts/Renews the view animation.

    View

    Source:
    Resets the view

    View

    Source:
    Pauses the view animation.

    Viewion

    Source:
    Initializes the view.

    Methods

    createItems($container, label, count)

    Source:
    Creates navigation items and appends them to $container.
    Parameters:
    Name Type Description
    $container Object navigation items container (jQuery object)
    label String navigation items label template
    count Number number of navigation items to create

    createPrevNextItem(settings, itemSettings, $element)

    Source:
    Creates or selects 'previous'/'next' navigation item. Mode of action depends on settings object: var settings = { isContainer: Boolean value, label: String value, selector: String value, method: String value }; If settings.selector === null or if settings.selector !== null and settings.isContainer == true navigation item is created and attached to $element.first() (using settings.method). If settings.selector !== null and settings.isContainer == false $element.first() is selected as navigation item
    Parameters:
    Name Type Description
    settings Object settings of navigation item
    itemSettings Object html attributes of navigation item
    $element Object navigation items container (jQuery object)
    Returns:
    The 'prev'/'next' navigation item

    getElement(selector)

    Source:
    Returns the element(s) that match the provided selector or null
    Parameters:
    Name Type Description
    selector String a selector used for searching
    Returns:
    a jQuery object containing element(s) that match the provided selector or null if there is no element match

    initialize(context)

    Source:
    Initializes Slider object with a given context.
    Parameters:
    Name Type Description
    context SliderContext a context of a Slider class instance