Versions Compared

Old Version 12

changes.mady.by.user Justin Obara

Saved on

compared with

New Version 13

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.exporter(container,

options);

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

Description

Instantiates the exporter component, which is the top level component for the PDF and Image Conversion page.

Parameters

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

options
An optional data structure that configures the Exporter component

Returns

The Exporter component

Examples

Code Block
javascript
javascript
var exporter = decapod.exporter("#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 exporter. This should be an {{<h1>}} when Exporter 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 exporter. This should be an <h1> when Exporter is the only component on the page. 
Default
".dc-exporter-title"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

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

{code} |


{div2}
formats
{div2:class=}
||Description|The element that will be used to display a message describing the contents of exporter or some instructions at the top level. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element that will be used to display a message describing the contents of exporter or some instructions at the top level. 
Default
".dc-exporter-formats"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        formats: ".myFormats"
    }
});

{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-exporter-help"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

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

{code} |


{div2}
uploadClear
{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-exporter-uploadClear"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadClear"
    }
});

{code} |


{div2}
uploadContainer
{div2:class=}
||Description|The element used to house the uploader component. The necessary markup will be injected here. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to house the uploader component. The necessary markup will be injected here. 
Default
".dc-exporter-upload"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadContainer"
    }
});

{code} |
{div2}
uploadBrowse
{div2:class=}
||Description|The element used to trigger the browsing of files to be upload. Activating this will launch the browser file system dialog. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to trigger the browsing of files to be upload. Activating this will launch the browser file system dialog. 
Default
".dc-exporter-uploadBrowse"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadBrowse"
    }
});

{code} |


{div2}
importStatusContainer
{div2:class=}
||Description|The element used to house the import status component. The necessary markup will be injected here. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to house the import status component. The necessary markup will be injected here. 
Default
".dc-exporter-importStatus"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myImportStatusContainer"
    }
});

{code} |
{div2}
instructions
{div2:class=}
||Description|The element used to display initial instruction text for uploading files. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to display initial instruction text for uploading files. 
Default
".dc-exporter-instructions"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myInstructions"
    }
});

{code} |


{div2}
pdfs
{div2:class=}
||Description|The element used to display the heading for the PDF export types. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to display the heading for the PDF export types. 
Default
".dc-exporter-pdfs"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myPDFs"
    }
});

{code} |
{div2}
images
{div2:class=}
||Description|The element used to display the heading for the image export types. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used to display the heading for the image export types. 
Default
".dc-exporter-images"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myImages"
    }
});

{code} |


{div2}
accordionContainer
{div2:class=}
||Description|The element used as the container for the accordion. This is what manages the hiding and showing of the options for the various export types. Therefore the export types must be contained within it. |
||Default| {{
 Wiki Markup
 Div
classapi-table
Description
The element used as the container for the accordion. This is what manages the hiding and showing of the options for the various export types. Therefore the export types must be contained within it. 
Default
".dc-exporter-accordion"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    selectors: {
        help: ".myAccordionContainer"
    }
});

{code} |
{div2}
Styles
busy
{div2:class=}
||Description|The css class used to apply the busy styling to the page. 
 Wiki Markup
 Div
classapi-table
Description
The css class used to apply the busy styling to the page. (e.g. 
 
 change 
 
 to 
 
 the 
 
 wait 
 
 cursor) 
  |
||Default| {{
Default
"ds-shared-busy"
}} |
||Example| {code:javascript}
Example
 Code Block
javascript
javascript

decapod.exporter(".myContainer", {
    styles: {
        busy: "myBusyClass"
    }
});

{code} |


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