Creation
| Wiki Markup |
|---|
h2. Creation {div2:class=api-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}var exporter = decapod.exporter("#myContainer", { selectors: { title: ".mySelector" } });{code} | {div2} h2. |
Component
...
Selectors
...
| Tip | ||||||
|---|---|---|---|---|---|---|
| =
| }
|||||
Some information about selectors and how they can be configured can be found here: [ Selectors|http://wiki.fluidproject.org/display/docs/Component+Configuration+Options#ComponentConfigurationOptions-selectors] {tip} h3. {{title}} { |
title
| Wiki Markup |
|---|
{div2:class=api-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} decapod.exporter(".myContainer", { selectors: { title: ".myTitle" } }); {code} | {div2} h3. {{formats}} |
formats
| Wiki Markup |
|---|
{div2:class=api-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}
decapod.exporter(".myContainer", {
selectors: {
formats: ".myFormats"
}
});
{code} |
{div2}
h3. {{help}}
|
help
| Wiki Markup |
|---|
{div2:class=api-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}
decapod.exporter(".myContainer", {
selectors: {
help: ".myHelp"
}
});
{code} |
{div2}
h3. {{uploadClear}}
|
uploadClear
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The element used to refresh the page. Likely an {{<a>}}. |
||Default| {{".dc-exporter-uploadClear"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
selectors: {
help: ".myUploadClear"
}
});
{code} |
{div2}
h3. {{uploadContainer}}
|
uploadContainer
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The element used to house the uploader component. The necessary markup will be injected here. |
||Default| {{".dc-exporter-upload"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
selectors: {
help: ".myUploadContainer"
}
});
{code} |
{div2}
h3. {{uploadBrowse}}
|
uploadBrowse
| Wiki Markup |
|---|
{div2:class=api-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}
decapod.exporter(".myContainer", {
selectors: {
help: ".myUploadBrowse"
}
});
{code} |
{div2}
h3. {{importStatusContainer}}
|
importStatusContainer
| Wiki Markup |
|---|
{div2:class=api-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}
decapod.exporter(".myContainer", {
selectors: {
help: ".myImportStatusContainer"
}
});
{code} |
{div2}
h3. {{instructions}}
|
instructions
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The element used to display initial instruction text for uploading files. |
||Default| {{".dc-exporter-instructions"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
selectors: {
help: ".myInstructions"
}
});
{code} |
{div2}
h3. {{pdfs}}
|
pdfs
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The element used to display the heading for the PDF export types. |
||Default| {{".dc-exporter-pdfs"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
selectors: {
help: ".myPDFs"
}
});
{code} |
{div2}
h3. {{images}}
|
images
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The element used to display the heading for the image export types. |
||Default| {{".dc-exporter-images"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
selectors: {
help: ".myImages"
}
});
{code} |
{div2}
h3. {{accordionContainer}}
|
accordionContainer
| Wiki Markup |
|---|
{div2:class=api-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}
decapod.exporter(".myContainer", {
selectors: {
help: ".myAccordionContainer"
}
});
{code} |
{div2}
h2. Styles
h3. {{busy}}
|
Styles
busy
| Wiki Markup |
|---|
{div2:class=api-table}
||Description|The css class used to apply the busy styling to the page. (e.g. change to the wait cursor) |
||Default| {{"ds-shared-busy"}} |
||Example| {code:javascript}
decapod.exporter(".myContainer", {
styles: {
busy: "myBusyClass"
}
});
{code} |
{div2}
|
See
...
the
...
...
...
guide
...
for
...
information
...
on
...
changing
...
the
...
appearance
...
of
...
Decapod.