Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace JQueryCycle

Namespace for the JQuery Cycle plugin, accessible via $.fn.cycle. It is used by the ImageSwitch widget.

This namespace contains several required interfaces and types.

Index

Interfaces

Type Aliases

Type Aliases

CallbackAfter

CallbackAfter: ((this: JQuery, currSlideElement: JQuery, nextSlideElement: JQuery, options: JQueryCycle.Configuration, forwardFlag: boolean) => void)

Type declaration

CallbackBefore

CallbackBefore: ((this: JQuery, currSlideElement: JQuery, nextSlideElement: JQuery, options: JQueryCycle.Configuration, forwardFlag: boolean) => void)

Type declaration

CallbackEnd

CallbackEnd: ((options: JQueryCycle.Configuration) => void)

Type declaration

CallbackFxFn

CallbackFxFn: ((currSlideElement: JQuery, nextSlideElement: JQuery, options: JQueryCycle.Configuration, afterCallback: CallbackAfter, forwardFlag: boolean) => void)

Type declaration

CallbackOnPagerEvent

CallbackOnPagerEvent: ((index: number, slideElement: JQuery) => void)

Type declaration

    • (index: number, slideElement: JQuery): void

    • Callback fn for pager events

      Parameters

      • index: number
      • slideElement: JQuery

      Returns void

CallbackOnPrevNextEvent

CallbackOnPrevNextEvent: ((isNext: boolean, zeroBasedSlideIndex: number, slideElement: JQuery) => void)

Type declaration

    • (isNext: boolean, zeroBasedSlideIndex: number, slideElement: JQuery): void

    • Callback when switching to the next or previous image (prev/next events).

      Parameters

      • isNext: boolean
      • zeroBasedSlideIndex: number
      • slideElement: JQuery

      Returns void

CallbackTimeoutFn

CallbackTimeoutFn: ((currSlideElement: JQuery, nextSlideElement: JQuery, options: JQueryCycle.Configuration, forwardFlag: boolean) => number)

Type declaration

CallbackUpdateActivePagerLink

CallbackUpdateActivePagerLink: ((pager: JQuery, currSlideElement: JQuery, activePagerClass: string) => void)

Type declaration

    • (pager: JQuery, currSlideElement: JQuery, activePagerClass: string): void

    • Callback fn invoked to update the active pager link (adds/removes activePagerClass style)

      Parameters

      • pager: JQuery
      • currSlideElement: JQuery
      • activePagerClass: string

      Returns void

Generated using TypeDoc