Creation
Wiki Markup |
---|
h2. Creation {div2:class=api-table} || Method | {{decapod.calibrator(container, options);}} || || Description | Instantiates the calibrator component, which is the top level component for Stereo 3D Calibration 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 calibrator component || || Returns | The calibrator component || || Examples | {code:javascript}var calibrator = decapod.calibrator("#myContainer", { selectors: { title: ".mySelector" } });{code} || {div2} |
Wiki Markup |
---|
{div2:class=api-table}
|| Method | {{decapod.dewarper(container, options);}} ||
|| Description | Instantiates the dewarper component, which is the top level component for the Stereo 3D Dewarp page. ||
|| Parameters | {{{_}container{_}}} \\
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the dewarper should be placed \\
\\
{{{_}options{_}}} \\
An optional data structure that configures the dewarper component ||
|| Returns | The dewarper component ||
|| Examples | {code:javascript}var dewarper = decapod.dewarper("#myContainer", {
selectors: {
title: ".mySelector"
}
});{code} ||
{div2}
h2. |
Calibrator
...
and
...
Dewarper
...
Shared
...
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 calibrator/dewarper. This should be an {{<h1>}} when calibrator/dewarper is the only component on the page. ||
|| Default | {{".dc-stereo-title"}} ||
|| Example | {code:javascript}
// Configure calibrator's title.
decapod.calibrator(".myContainer", {
selectors: {
title: ".myTitle"
}
});
// Configure dewarper's title.
decapod.dewarper(".myContainer", {
selectors: {
title: ".myTitle"
}
});
{code} ||
{div2}
h3. {{help}}
|
help
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that will be used as a link to the help material for calibration/dewarping. ||
|| Default | {{".dc-stereo-help"}} ||
|| Example | {code:javascript}
// Configure calibrator's help link text.
decapod.calibrator(".myContainer", {
selectors: {
help: ".myHelp"
}
});
// Configure dewarper's help link text.
decapod.dewarper(".myContainer", {
selectors: {
help: ".myHelp"
}
});
{code} ||
{div2}
h3. {{start}}
|
start
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that will be used to start the process of calibration/dewarping itself. ||
|| Default | {{".dc-stereo-start"}} ||
|| Example | {code:javascript}
// Configure calibrator's start calibration button.
decapod.calibrator(".myContainer", {
selectors: {
start: ".myStart"
}
});
// Configure dewarper's start dewarping button.
decapod.dewarper(".myContainer", {
selectors: {
start: ".myStart"
}
});
{code} ||
{div2}
h3. {{browse}}
|
browse
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that will be used to contain:
* *Calibration:* archive selection step.
* *Dewarping:* captures archive selection step. ||
|| Default | {{".dc-stereo-browse"}} ||
|| Example | {code:javascript}
// Configure calibrator's select archive step container.
decapod.calibrator(".myContainer", {
selectors: {
browse: ".myBrowse"
}
});
// Configure dewarper's select captures archive step container.
decapod.dewarper(".myContainer", {
selectors: {
browse: ".myBrowse"
}
});
{code} ||
{div2}
h3. {{status}}
|
status
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that contains the status/progress box. ||
|| Default | {{".dc-stereo-status"}} ||
|| Example | {code:javascript}
// Configure calibrator's status/progress box container.
decapod.calibrator(".myContainer", {
selectors: {
status: ".myStatus"
}
});
// Configure dewarper's status/progress box container.
decapod.dewarper(".myContainer", {
selectors: {
status: ".myStatus"
}
});
{code} ||
{div2}
h2. |
Dewarper
...
Only
...
Selectors
browseCalibration
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that contains calibration archive selection step. ||
|| Default | {{".dc-stereo-browseCalibration"}} ||
|| Example | {code:javascript}
// Configure dewarper's select calibration archive step container.
decapod.dewarper(".myContainer", {
selectors: {
browseCalibration: ".myBrowseCalibration"
}
});
{code} ||
{div2}
h3. {{colourPicker}}
|
colourPicker
Wiki Markup |
---|
{div2:class=api-table}
|| Description | The element that contains colour picker step. ||
|| Default | {{".dc-stereo-colourPicker"}} ||
|| Example | {code:javascript}
// Configure dewarper's colour picker step container.
decapod.dewarper(".myContainer", {
selectors: {
colourPicker: ".myColourPicker"
}
});
{code} ||
{div2}
h2. Styles
See the [Decapod Styling] guide for information on changing the appearance of |
Styles
See the Decapod Styling guide for information on changing the appearance of Decapod.