Q gallery Class

Parameters:

• [options] Object optional

  options is an Object with function parameters

  • [images] Array optional

    images an array of objects containing object { src: String , caption: String , interval: Number, transition: Object}

    • [src] String optional
      src url of the image, will be fed through Q.url(). Required.
    • [caption] String optional
      caption for the image. Optional
    • [interval] Number optional
      interval number overriding default interval. Optional.
    • [transition] Object optional
      transition object overriding default transition. Optional.
  • [transition] Object optional

    transition object that contains properties for making transitions

    • [duration] Number optional
      duration the number of milliseconds the transition should take (where the intervals overlap)
    • [ease] String optional
      ease the type of easing function to apply from Q.Animation.ease object
    • [type] String optional
      type the type of transition. Can only be 'crossfade'
  • [interval] Object optional

    interval object that contains properties for intervals

    • [duration] Number optional
      duration number of milliseconds between beginning times of consecutive transitions
    • [ease] String optional
      ease the type of easing function to apply from Q.Animation.ease object.
    • [type] String optional
      type is a what to do during this interval. Can be empty or 'kenburns'.
    • [from] Object optional
      from is for "kenburns", an object containing "left", "top", "width" and "height"
    • [from.left] Number optional
      left number for "from" object
    • [from.top] Number optional
      top number for "from" object
    • [from.width] Number optional
      width number for "from" object
    • [from.height] Number optional
      height number for "from" object
    • [to] Object optional
      to is for "kenburns", an object containing "left", "top", "width" and "height"
    • [to.left] Number optional
      left number for "to" object
    • [to.top] Number optional
      top number for "to" object
    • [to.width] Number optional
      width number for "to" object
    • [to.height] Number optional
      height number for "to" object
  • [autoplay] Boolean optional

    autoplay for whether to start playing the gallery when it loads.

  • [transitionToFirst] Boolean optional

    transitionToFirst for whether to use a transition to show the first image.

  • [loop] Boolean optional

    loop for whether to show first image after last image is done.

  • [onLoad] Q.Event optional

    onLoad event fires when an image loads, also passes all loaded images

  • [onTransition] Q.Event optional

    onTransition event fires when an image loads, also passes all loaded images