dojox/image/Gallery.js

• Provides:

  • dojox.image.Gallery

• Requires:

  • dojo.fx in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dojox.image.ThumbnailPicker in common
  • dojox.image.SlideShow in common

• dojox.image.Gallery

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Gallery widget that wraps a dojox.image.ThumbnailPicker and dojox.image.SlideShow widget

• dojox.image.Gallery.imageHeight

  • type

    Number

  • summary

    Maximum height of an image in the SlideShow widget

• dojox.image.Gallery.imageWidth

  • type

    Number

  • summary

    Maximum width of an image in the SlideShow widget

• dojox.image.Gallery.pageSize

  • alias - dojox.image.SlideShow.prototype.pageSize
  • type

    Number

  • summary

    The number of records to retrieve from the data store per request.

• dojox.image.Gallery.autoLoad

  • type

    Boolean

  • summary

    If true, images are loaded before the user views them. If false, an
    image is loaded when the user displays it.

• dojox.image.Gallery.linkAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    URL to link to from an image, if any.

• dojox.image.Gallery.imageThumbAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    URL to the thumbnail image.

• dojox.image.Gallery.imageLargeAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    URL to the image.

• dojox.image.Gallery.titleAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    title of the picture, if any.

• dojox.image.Gallery.slideshowInterval

  • type

    Integer

  • summary

    Time, in seconds, between image changes in the slide show.

• dojox.image.Gallery.templateString

  • type

    Object

• dojox.image.Gallery.postCreate

  • summary

    Initializes the widget, creates the ThumbnailPicker and SlideShow widgets

  • type

    Function

• dojox.image.Gallery.widgetid

• dojox.image.Gallery.thumbPicker

  • type

    Object

• dojox.image.Gallery.slideShow

  • type

    Object

• dojox.image.Gallery.setDataStore

  • parameters:
    • dataStore: (typeof An)

      implementation of the dojo.data.api.Read API. This accesses the image
      data.

    • request: (typeof An)

      implementation of the dojo.data.api.Request API. This specifies the
      query and paging information to be used by the data store

    • paramNames: (typeof optional)

      An object defining the names of the item attributes to fetch from the
      data store.  The four attributes allowed are 'linkAttr', 'imageLargeAttr',
      'imageThumbAttr' and 'titleAttr'

  • summary

    Sets the data store and request objects to read data from.

  • type

    Function

• dojox.image.Gallery.reset

  • summary

    Resets the widget to its initial state

  • type

    Function

• dojox.image.Gallery.showNextImage

  • parameters:
    • inTimer: (typeof Boolean)

      If true, a slideshow is active, otherwise the slideshow is inactive.

  • summary

    Changes the image being displayed in the SlideShow to the next
    image in the data store

  • type

    Function

• dojox.image.Gallery.toggleSlideshow

  • type

    Function

• dojox.image.Gallery.toggleSlideShow

  • summary

    Switches the slideshow mode on and off.

  • type

    Function

• dojox.image.Gallery.showImage

  • parameters:
    • index
    • callback: (typeof optional)

      Function Optional callback function to call when the image has finished displaying.

  • summary

    Shows the image at index 'idx'.
    idx: Number
    The position of the image in the data store to display

  • type

    Function

• dojox.image.Gallery.resize

  • parameters:
    • dim
  • type

    Function

• dojox.image.Gallery._centerChildren

  • summary

    Ensures that the ThumbnailPicker and the SlideShow widgets
    are centered.

  • type

    Function

• dojox.image

  • type

    Object

• dojox

  • type

    Object