bob
/
westdc-zf1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
westdc-zf1/htdocs/js/timemap.2.0.1/docs/symbols/TimeMap.loaders.base.html

1026 lines
24 KiB
HTML
Raw Normal View History

merge to trunk r1810. (metadata-v2.0)
2011-12-11 12:22:35 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>Timemap.js
v.2.0.1
: TimeMap.loaders.base : JsDoc Reference</title>
<style type="text/css">
/* default.css */
body {
font: 13px Verdana, Arial, sans-serif;
padding: 0;
margin: 15px;
}
.header {
clear: both;
background-color: #ccc;
padding: 8px;
}
a:link, a:visited {
color: #00A;
}
a:hover, a:active {
color: #00F;
}
h1 {
font-size: 150%;
font-weight: bold;
padding: 0;
}
h3.projectTitle {
font-size: 12px;
font-weight: bold;
margin: 0;
}
h1.classTitle {
font-size:170%;
line-height:130%;
}
hr {
border: none 0;
border-top: 1px solid #627C9D;
height: 1px;
margin: 1em 0;
}
pre.code {
display: block;
padding: 8px;
border: 1px dashed #ccc;
overflow: auto;
}
#index {
float: left;
width: 220px;
position: absolute;
margin-bottom: 15px;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content {
margin-left: 260px;
width: 600px;
}
#index img {
margin: 15px 0;
border: 1px solid #627C9D;
}
ul.classList {
list-style-type: none;
padding: 0;
margin: 0;
font-size: 11px;
}
ul.classList li {
padding: 0;
margin: 0 0 8px 0;
}
h2 , div.sectionTitle {
font-weight: bold;
font-size: 18px;
padding: 15px 0 10px 0;
margin: 0;
}
div.sectionTitle {
margin-bottom: 10px;
border-bottom: 1px solid #627C9D;
}
code {
font-family: "Lucida Console", "Courier New", Courier, monospace;
font-size: 12px;
}
pre {
font-family: "Lucida Console", "Courier New", Courier, monospace;
font-size: 12px;
}
div.toplinks {
font-size: 11px;
padding-top: 8px;
}
td.attributes, .fixedFont
{
font-family: "Lucida Console", "Courier New", Courier, monospace;
font-size: 12px;
}
/* tables */
.summaryTable {
text-align: left;
margin: 10px 0;
border: 1px solid #999999;
width: 100%;
}
.summaryTable th {
color: #FFFFFF;
background-color: #627C9D;
white-space: nowrap;
padding: 3px 10px;
}
.summaryTable th.param {
color: #000;
background-color: #F2F2F2;
white-space: nowrap;
padding: 3px 10px;
}
.summaryTable td {
border-top: #999999 1px solid;
vertical-align: top;
padding: 5px 10px;
}
.summaryTable.params {
width: auto;
}
.row0 {
background-color: #F2F2F2;
}
.row1 {
background-color: #FFFFFF;
}
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList dt
{
float: left;
clear: both;
font-weight: bold;
margin-left: 0;
}
.detailList dd {
padding-bottom: .5em;
margin-left: 7em;
}
.detailList dd.tight {
padding-bottom: 0;
}
.membertitle {
font-size: 1.2em;
padding: .5em;
margin: 2.5em 0px 0.2em;
background: #EEF;
border-bottom: 3px double #999;
}
.membername {
font-weight: bold;
}
.datatype {
color: #999;
}
.paramname {
font-weight: bold;
}
.paramconfig {
color: #999;
}
.optional {
font-style: italic;
}
.defaultvalue {
font-style: italic;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
div.indexClass {
border-top: 1px solid #7F8FB1;
margin-bottom: .5em;
}
/* syntax coloring for examples */
.KEYW {color: #339; font-weight: bold;}
.COMM {color: #999; font-style: italic;}
.NUMB {color: #933;}
.STRN {color: #393;}
.REGX {color: #993;}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<h3 class="projectTitle">Timemap.js
v.2.0.1
</h3>
<div class="toplinks"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<img src="../timemap_sq.jpg">
<!-- begin publish.classesIndex -->
<ul class="classList">
<li><a href="../symbols/TimeMap.html">TimeMap</a></li>
<li><a href="../symbols/TimeMap.dateParsers.html">TimeMap.dateParsers</a></li>
<li><a href="../symbols/TimeMap.filters.html">TimeMap.filters</a></li>
<li><a href="../symbols/TimeMap.intervals.html">TimeMap.intervals</a></li>
<li><a href="../symbols/TimeMap.loaders.html">TimeMap.loaders</a></li>
<li><a href="../symbols/TimeMap.loaders.base.html">TimeMap.loaders.base</a></li>
<li><a href="../symbols/TimeMap.loaders.base%23params.html">TimeMap.loaders.base#params</a></li>
<li><a href="../symbols/TimeMap.loaders.basic.html">TimeMap.loaders.basic</a></li>
<li><a href="../symbols/TimeMap.loaders.flickr.html">TimeMap.loaders.flickr</a></li>
<li><a href="../symbols/TimeMap.loaders.georss.html">TimeMap.loaders.georss</a></li>
<li><a href="../symbols/TimeMap.loaders.gss.html">TimeMap.loaders.gss</a></li>
<li><a href="../symbols/TimeMap.loaders.json.html">TimeMap.loaders.json</a></li>
<li><a href="../symbols/TimeMap.loaders.jsonp.html">TimeMap.loaders.jsonp</a></li>
<li><a href="../symbols/TimeMap.loaders.kml.html">TimeMap.loaders.kml</a></li>
<li><a href="../symbols/TimeMap.loaders.metaweb.html">TimeMap.loaders.metaweb</a></li>
<li><a href="../symbols/TimeMap.loaders.progressive.html">TimeMap.loaders.progressive</a></li>
<li><a href="../symbols/TimeMap.loaders.remote.html">TimeMap.loaders.remote</a></li>
<li><a href="../symbols/TimeMap.loaders.xml.html">TimeMap.loaders.xml</a></li>
<li><a href="../symbols/TimeMap.loadManager.html">TimeMap.loadManager</a></li>
<li><a href="../symbols/TimeMap.mapTypes.html">TimeMap.mapTypes</a></li>
<li><a href="../symbols/TimeMap.params.html">TimeMap.params</a></li>
<li><a href="../symbols/TimeMap.params.ExtendedDataParam.html">TimeMap.params.ExtendedDataParam</a></li>
<li><a href="../symbols/TimeMap.params.OptionParam.html">TimeMap.params.OptionParam</a></li>
<li><a href="../symbols/TimeMap.params.Param.html">TimeMap.params.Param</a></li>
<li><a href="../symbols/TimeMap.state.html">TimeMap.state</a></li>
<li><a href="../symbols/TimeMap.state.params.html">TimeMap.state.params</a></li>
<li><a href="../symbols/TimeMap.themes.html">TimeMap.themes</a></li>
<li><a href="../symbols/TimeMap.util.html">TimeMap.util</a></li>
<li><a href="../symbols/TimeMapDataset.html">TimeMapDataset</a></li>
<li><a href="../symbols/TimeMapFilterChain.html">TimeMapFilterChain</a></li>
<li><a href="../symbols/TimeMapItem.html">TimeMapItem</a></li>
<li><a href="../symbols/TimeMapTheme.html">TimeMapTheme</a></li>
</ul>
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class TimeMap.loaders.base
</h1>
<!-- ============================== class summary ========================== -->
<dl class="detailList">
<dt>Defined in:</dt>
<dd><a href="../symbols/src/c__Users_nick_Documents_timemap_timemap_src_timemap.js.html">timemap.js</a></dd>
</dl>
<p class="description">
Abstract loader class. All loaders should inherit from this class.
</p>
<!-- ============================== constructor summary ==================== -->
<h2>Constructor</h2>
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#constructor">TimeMap.loaders.base</a></b>(options)
</div>
<div class="description">
</div>
<!-- ============================== static properties summary ===================== -->
<!-- ============================== static methods summary ======================== -->
<!-- ============================== instance properties summary ===================== -->
<h2>Fields</h2>
<table class="summaryTable" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col" width="100%">Field</th>
</tr>
</thead>
<tbody>
<tr class="row0">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#scrollTo">scrollTo</a></b>
<span class="datatype">:{String|Date}</span>
</div>
<div class="description">
Date to scroll the timeline to on load
</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== instance methods summary ======================== -->
<h2>Methods</h2>
<table class="summaryTable" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col" width="100%">Method</th>
</tr>
</thead>
<tbody>
<tr class="row0">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#cancel">cancel</a></b>()
</div>
<div class="description">
Cancel the callback function for this loader.
</div>
</td>
</tr>
<tr class="row1">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#getCallback">getCallback</a></b>(dataset, callback)
</div>
<div class="description">
Get a callback function that can be cancelled.
</div>
</td>
</tr>
<tr class="row0">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#getCallbackName">getCallbackName</a></b>(dataset, callback)
</div>
<div class="description">
Get the name of a callback function that can be cancelled.
</div>
</td>
</tr>
<tr class="row1">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#parse">parse</a></b>()
</div>
<div class="description">
Parser function to turn a string into a JavaScript array
</div>
</td>
</tr>
<tr class="row0">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#preload">preload</a></b>()
</div>
<div class="description">
Function to call on data object before loading
</div>
</td>
</tr>
<tr class="row1">
<td>
</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/TimeMap.loaders.base.html#transform">transform</a></b>()
</div>
<div class="description">
Function to call on a single item data object before loading
</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont membername">
<b>TimeMap.loaders.base</b>(options)
</div>
<table class="summaryTable" cellspacing="0">
<thead>
<tr>
<th scope="table" colspan="3" class="param">Parameters (<span class="optional">optional</span>)</th>
</tr>
</thead>
<tbody>
<tr>
<td class="paramname ">options</td>
<td class="datatype">
{Object}
</td>
<td width="100%">
All options for the loader
</td>
</tr>
<tr>
<td class="paramname optional"><span class="paramconfig">options.</span>parserFunction</td>
<td class="datatype">
{Function}
</td>
<td width="100%">
Parser function to turn a string into a JavaScript array
<div class="defaultvalue">Default: Do nothing</div>
</td>
</tr>
<tr>
<td class="paramname optional"><span class="paramconfig">options.</span>preloadFunction</td>
<td class="datatype">
{Function}
</td>
<td width="100%">
Function to call on data before loading
<div class="defaultvalue">Default: Do nothing</div>
</td>
</tr>
<tr>
<td class="paramname optional"><span class="paramconfig">options.</span>transformFunction</td>
<td class="datatype">
{Function}
</td>
<td width="100%">
Function to call on individual items before loading
<div class="defaultvalue">Default: Do nothing</div>
</td>
</tr>
<tr>
<td class="paramname optional"><span class="paramconfig">options.</span>scrollTo</td>
<td class="datatype">
{String|Date}
</td>
<td width="100%">
Date to scroll the timeline to in the default callback
(see <a href="../symbols/TimeMap.html#parseDate">TimeMap#parseDate</a> for accepted syntax)
<div class="defaultvalue">Default: earliest</div>
</td>
</tr>
</tbody>
</table>
<dl class="detailList">
</dl>
</div>
<!-- ============================== static field details ========================== -->
<!-- ============================== static method details ========================= -->
<!-- ============================== instance field details ========================== -->
<div class="sectionTitle">Field Details</div>
<a name="scrollTo"> </a>
<div class="fixedFont membertitle">
<span class="membername">scrollTo</span>
<span class="datatype">:{String|Date}</span>
</div>
<div class="description">
Date to scroll the timeline to on load
</div>
<dl class="detailList">
<dt>Default Value:</dt>
<dd>"earliest"</dd>
</dl>
<!-- ============================== static method details ========================= -->
<div class="sectionTitle">Method Details</div>
<a name="cancel"> </a>
<div class="fixedFont membertitle">
<span class="membername">cancel</span><span class="membersignature">()</span>
</div>
<div class="description">
Cancel the callback function for this loader.
</div>
<dl class="detailList">
</dl>
<a name="getCallback"> </a>
<div class="fixedFont membertitle">
<span class="membername">getCallback</span><span class="membersignature">(dataset, callback)</span>
<span class="datatype">:{Function}</span>
</div>
<div class="description">
Get a callback function that can be cancelled. This is a convenience function
to be used if the callback name itself is not needed.
</div>
<table class="summaryTable" cellspacing="0">
<thead>
<tr>
<th scope="table" colspan="3" class="param">Parameters (<span class="optional">optional</span>)</th>
</tr>
</thead>
<tbody>
<tr>
<td class="paramname ">dataset</td>
<td class="datatype">
{<a href="../symbols/TimeMapDataset.html">TimeMapDataset</a>}
</td>
<td width="100%">
Dataset to load data into
</td>
</tr>
<tr>
<td class="paramname ">callback</td>
<td class="datatype">
{Function}
</td>
<td width="100%">
User-supplied callback function
</td>
</tr>
</tbody>
</table>
<dl class="detailList">
<dt>Returns:</dt>
<dd><span class="datatype">{Function}</span> The configured callback function</dd>
<dt>See:</dt>
<dd><a href="../symbols/TimeMap.loaders.base.html#getCallbackName">TimeMap.loaders.base#getCallbackName</a></dd>
</dl>
<a name="getCallbackName"> </a>
<div class="fixedFont membertitle">
<span class="membername">getCallbackName</span><span class="membersignature">(dataset, callback)</span>
<span class="datatype">:{String}</span>
</div>
<div class="description">
Get the name of a callback function that can be cancelled. This callback applies the parser,
preload, and transform functions, loads the data, then calls the user callback
</div>
<table class="summaryTable" cellspacing="0">
<thead>
<tr>
<th scope="table" colspan="3" class="param">Parameters (<span class="optional">optional</span>)</th>
</tr>
</thead>
<tbody>
<tr>
<td class="paramname ">dataset</td>
<td class="datatype">
{<a href="../symbols/TimeMapDataset.html">TimeMapDataset</a>}
</td>
<td width="100%">
Dataset to load data into
</td>
</tr>
<tr>
<td class="paramname ">callback</td>
<td class="datatype">
{Function}
</td>
<td width="100%">
User-supplied callback function. If no function
is supplied, the default callback will be used
</td>
</tr>
</tbody>
</table>
<dl class="detailList">
<dt>Returns:</dt>
<dd><span class="datatype">{String}</span> The name of the callback function in TimeMap.loaders.cb</dd>
</dl>
<a name="parse"> </a>
<div class="fixedFont membertitle">
<span class="membername">parse</span><span class="membersignature">()</span>
<span class="datatype">:{Object[]}</span>
</div>
<div class="description">
Parser function to turn a string into a JavaScript array
</div>
<dl class="detailList">
<dt>Returns:</dt>
<dd><span class="datatype">{Object[]}</span> Array of item data</dd>
</dl>
<a name="preload"> </a>
<div class="fixedFont membertitle">
<span class="membername">preload</span><span class="membersignature">()</span>
<span class="datatype">:{Object[]}</span>
</div>
<div class="description">
Function to call on data object before loading
</div>
<dl class="detailList">
<dt>Returns:</dt>
<dd><span class="datatype">{Object[]}</span> Array of item data</dd>
</dl>
<a name="transform"> </a>
<div class="fixedFont membertitle">
<span class="membername">transform</span><span class="membersignature">()</span>
<span class="datatype">:{Object}</span>
</div>
<div class="description">
Function to call on a single item data object before loading
</div>
<dl class="detailList">
<dt>Returns:</dt>
<dd><span class="datatype">{Object}</span> Transformed data for one item</dd>
</dl>
<!-- ============================== event details ========================= -->
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
&copy;2010 Nick Rabinowitz<br />
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sat Aug 06 2011 13:40:07 GMT-0700 (PDT)
</div>
</body>
</html>