Versions Compared

Old Version 5

changes.mady.by.user Justin Obara

Saved on

compared with

New Version 6

changes.mady.by.user Justin Obara

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Creation

{div2:class=} || Method | {{
Wiki Markup
Div
classapi-table

Method

decapod.capturer(container,

options);

}} || || Description | Instantiates the capturer component, which is the top level component for Capture page. || || Parameters | {{{_}container{_}}} \\ A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the calibrator should be placed \\ \\ {{{_}options{_}}} \\ An optional data structure that configures the capture component || || Returns | The capture component || || Examples | {code:javascript}

Description

Instantiates the capturer component, which is the top level component for Capture page.

Parameters

container
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the calibrator should be placed

options
An optional data structure that configures the capture component

Returns

The capture component

Examples

Code Block
javascript
javascript
var capturer = decapod.capturer("#myContainer", {
    selectors: {
        title: ".mySelector"
    }
});
{code} || {div2}
Component Selectors
 Tip
titleSelectors
Some information about selectors and how they can be configured can be found here: Component Configuration Options - Selectors
title
{div2:class=}
|| Description | The element that will be used to display the main title for the capturer. This should be an {{<h1>}} when capturer is the only component on the page. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element that will be used to display the main title for the capturer. This should be an <h1> when capturer is the only component on the page. 
 Default 
".dc-capturer-title"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        title: ".myTitle"
    }
});

{code} ||
{div2}
captureButton
{div2:class=}
|| Description | The element that will be used to trigger a capture. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element that will be used to trigger a capture. 
 Default 
".dc-capturer-captureButton"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        captureButton: ".myCaptureButton"
    }
});

{code} ||
{div2}
exportButton
{div2:class=}
|| Description | The element that will be used to trigger a download of the captured images. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element that will be used to trigger a download of the captured images. 
 Default 
".dc-capturer-exportButton"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        exportButton: ".myExportButton"
    }
});

{code} ||


{div2}
load
{div2:class=}
|| Description | The element that will house the status message and progress indicator for when the cameras are being checked. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element that will house the status message and progress indicator for when the cameras are being checked. 
 Default 
".dc-capturer-load"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        load: ".myLoad"
    }
});

{code} ||


{div2}
loadMessage
{div2:class=}
|| Description | The element that will display the status message of the cameras being checked. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element that will display the status message of the cameras being checked. 
 Default 
".dc-capturer-loadMessage"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        loadMessage: ".myLoadMessage"
    }
});

{code} ||
{div2}
restart
{div2:class=}
|| Description | The element used to refresh the page. Likely an <a>. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element used to refresh the page. Likely an <a>. 
 Default 
".dc-capturer-restart"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        restart: ".myRestart"
    }
});

{code}


||
{div2}
help
{div2:class=}
|| Description | The element used to refer to the help documentation. Should be an <a> with the url to the help page. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element used to refer to the help documentation. Should be an <a> with the url to the help page. 
 Default 
".dc-capturer-help"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        help: ".myHelp"
    }
});

{code}


||
{div2}
status
{div2:class=}
|| Description | The element used to house the status component. Status messages for capturer will display here. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element used to house the status component. Status messages for capturer will display here. 
 Default 
".dc-capturer-status"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        status: ".myStatus"
    }
});

{code} ||
{div2}
preview
{div2:class=}
|| Description | The element used to house the captureReviewer component. The captured images will display here. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The element used to house the captureReviewer component. The captured images will display here. 
 Default 
".dc-capturer-preview"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        preview: ".myPreview"
    }
});

{code} ||
{div2}
exportDesc
{div2:class=}
|| Description | The element used to hold the message about the download 
 Wiki Markup
 Div
classapi-table
 Description 
 The element used to hold the message about the download (e.g. 
 
 reminder 
 
 to 
 
 calibrate). 
 ||
|| Default | {{
 Default 
".dc-capturer-export-description"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        exportDesc: ".myExportDesc"
    }
});

{code} ||
{div2}
downloadFrame
{div2:class=}
|| Description | The {{<iframe>}} element for which the download url is injected into. This is used to fetch the download. ||
|| Default | {{
 Wiki Markup
 Div
classapi-table
 Description 
 The <iframe> element for which the download url is injected into. This is used to fetch the download. 
 Default 
".dc-capturer-download-frame"
}} ||
|| Example | {code:javascript}
 Example 
 Code Block
javascript
javascript

decapod.capturer(".myContainer", {
    selectors: {
        downloadFrame: ".myDownloadFrame"
    }
});

{code} ||
{div2}
Styles
See the Decapod Styling guide for information on changing the appearance of Decapod.