Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Namespace aperture.capture

Functions used to capture snapshot images of a url or DOM element.

Namespace Summary
Constructor Attributes Constructor Name and Description
 

Method Summary

Namespace Detail

aperture.capture
Requires:
an Aperture image capture service
jQuery

Method Detail

  • <static> aperture.capture.initialize()
    On startup this can be called to initialize server side rendering for later use. This otherwise happens on the first request, causing a significant delay.
  • <static> aperture.capture.inline(url, callback, settings, authenticationSettings)
    Creates a rest url that may be used to GET an image capture of a given URL.
    Parameters:
    {String} url
    URL of the page to be captured
    {Function(String)} callback
    The callback to call when the image is ready. On error will be called with null.
    {Object} settings
    A set of key/value pairs that configure the image capture
    {Number} settings.captureWidth
    If set, the virtual "screen" width of content in which to render page in a virtual browser (in pixels). If not set, the element's width will be used.
    {Number} settings.captureHeight
    If set, the virtual "screen" height of content in which to render page in a virtual browser (in pixels). If not set, the element's height will be used.
    {String} settings.format
    If set, specifies the image format to request. May be one of "JPEG", "PNG", or "SVG"
    {Object} authenticationSettings
    A set of key/value pairs that configure the authentication of an image capture. If not set, no authentication will be used.
    {String} settings.username
    The user name used for authentication.
    {String} settings.password
    The password used for authentication.
  • <static> aperture.capture.store(url, callback, settings, authenticationSettings)
    Initiates an image capture of a given URL which will be stored in the aperture CMS. A callback is invoked with the URL that may be used to GET the image.
    Parameters:
    {String} url
    URL of the page to be captured
    {Function(Object)} callback
    The callback to call when the image is ready, with the document descriptor suitable for use with aperture.store.
    {Object} settings
    A set of key/value pairs that configure the image capture
    {Number} settings.captureWidth
    If set, the virtual "screen" width of content in which to render page in a virtual browser (in pixels). If not set, the element's width will be used.
    {Number} settings.captureHeight
    If set, the virtual "screen" height of content in which to render page in a virtual browser (in pixels). If not set, the element's height will be used.
    {String} settings.format
    If set, specifies the image format to request. May be one of "JPEG", "PNG", or "SVG"
    {Object} authenticationSettings
    A set of key/value pairs that configure the authentication of an image capture. If not set, no authentication will be used.
    {String} settings.username
    The user name used for authentication.
    {String} settings.password
    The password used for authentication.