mirror of
https://github.com/OCA/web.git
synced 2025-02-22 13:21:25 +02:00
1017 lines
22 KiB
HTML
1017 lines
22 KiB
HTML
<!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>JsDoc Reference - links.Timeline.StepDate</title>
|
|
|
|
<style type="text/css">
|
|
/* default.css */
|
|
body
|
|
{
|
|
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
|
|
width: 800px;
|
|
}
|
|
|
|
.header
|
|
{
|
|
clear: both;
|
|
background-color: #ccc;
|
|
padding: 8px;
|
|
}
|
|
|
|
h1
|
|
{
|
|
font-size: 150%;
|
|
font-weight: bold;
|
|
padding: 0;
|
|
margin: 1em 0 0 .3em;
|
|
}
|
|
|
|
hr
|
|
{
|
|
border: none 0;
|
|
border-top: 1px solid #7F8FB1;
|
|
height: 1px;
|
|
}
|
|
|
|
pre.code
|
|
{
|
|
display: block;
|
|
padding: 8px;
|
|
border: 1px dashed #ccc;
|
|
}
|
|
|
|
#index
|
|
{
|
|
margin-top: 24px;
|
|
float: left;
|
|
width: 160px;
|
|
position: absolute;
|
|
left: 8px;
|
|
background-color: #F3F3F3;
|
|
padding: 8px;
|
|
}
|
|
|
|
#content
|
|
{
|
|
margin-left: 190px;
|
|
width: 600px;
|
|
}
|
|
|
|
.classList
|
|
{
|
|
list-style-type: none;
|
|
padding: 0;
|
|
margin: 0 0 0 8px;
|
|
font-family: arial, sans-serif;
|
|
font-size: 1em;
|
|
overflow: auto;
|
|
}
|
|
|
|
.classList li
|
|
{
|
|
padding: 0;
|
|
margin: 0 0 8px 0;
|
|
}
|
|
|
|
.summaryTable { width: 100%; }
|
|
|
|
h1.classTitle
|
|
{
|
|
font-size:170%;
|
|
line-height:130%;
|
|
}
|
|
|
|
h2 { font-size: 110%; }
|
|
caption, div.sectionTitle
|
|
{
|
|
background-color: #7F8FB1;
|
|
color: #fff;
|
|
font-size:130%;
|
|
text-align: left;
|
|
padding: 2px 6px 2px 6px;
|
|
border: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
div.sectionTitle { margin-bottom: 8px; }
|
|
.summaryTable thead { display: none; }
|
|
|
|
.summaryTable td
|
|
{
|
|
vertical-align: top;
|
|
padding: 4px;
|
|
border-bottom: 1px #7F8FB1 solid;
|
|
border-right: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
/*col#summaryAttributes {}*/
|
|
.summaryTable td.attributes
|
|
{
|
|
border-left: 1px #7F8FB1 solid;
|
|
width: 140px;
|
|
text-align: right;
|
|
}
|
|
|
|
td.attributes, .fixedFont
|
|
{
|
|
line-height: 15px;
|
|
color: #002EBE;
|
|
font-family: "Courier New",Courier,monospace;
|
|
font-size: 13px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription
|
|
{
|
|
text-align: left;
|
|
font-size: 13px;
|
|
line-height: 15px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription, .description
|
|
{
|
|
line-height: 15px;
|
|
padding: 4px;
|
|
padding-left: 4px;
|
|
}
|
|
|
|
.summaryTable { margin-bottom: 8px; }
|
|
|
|
ul.inheritsList
|
|
{
|
|
list-style: square;
|
|
margin-left: 20px;
|
|
padding-left: 0;
|
|
}
|
|
|
|
.detailList {
|
|
margin-left: 20px;
|
|
line-height: 15px;
|
|
}
|
|
.detailList dt { margin-left: 20px; }
|
|
|
|
.detailList .heading
|
|
{
|
|
font-weight: bold;
|
|
padding-bottom: 6px;
|
|
margin-left: 0;
|
|
}
|
|
|
|
.light, td.attributes, .light a:link, .light a:visited
|
|
{
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.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">
|
|
<!-- begin publish.classesIndex -->
|
|
<div align="center"><a href="../index.html">Class Index</a>
|
|
| <a href="../files.html">File Index</a></div>
|
|
<hr />
|
|
<h2>Classes</h2>
|
|
<ul class="classList">
|
|
|
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
|
|
<li><a href="../symbols/Array.html">Array</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.html">links.Timeline</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.ClusterGenerator.html">links.Timeline.ClusterGenerator</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.Item.html">links.Timeline.Item</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.ItemBox.html">links.Timeline.ItemBox</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.ItemDot.html">links.Timeline.ItemDot</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.ItemFloatingRange.html">links.Timeline.ItemFloatingRange</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.ItemRange.html">links.Timeline.ItemRange</a></li>
|
|
|
|
<li><a href="../symbols/links.Timeline.StepDate.html">links.Timeline.StepDate</a></li>
|
|
|
|
</ul>
|
|
<hr />
|
|
<!-- end publish.classesIndex -->
|
|
</div>
|
|
|
|
<div id="content">
|
|
<!-- ============================== class title ============================ -->
|
|
<h1 class="classTitle">
|
|
|
|
Class links.Timeline.StepDate
|
|
</h1>
|
|
|
|
<!-- ============================== class summary ========================== -->
|
|
<p class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br /><i>Defined in: </i> <a href="../symbols/src/timeline.js.html">timeline.js</a>.
|
|
|
|
</p>
|
|
|
|
<!-- ============================== constructor summary ==================== -->
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class links.Timeline.StepDate.">
|
|
<caption>Class Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Constructor Attributes</th>
|
|
<th scope="col">Constructor Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription" >
|
|
<div class="fixedFont">
|
|
<b><a href="../symbols/links.Timeline.StepDate.html#constructor">links.Timeline.StepDate</a></b>(start, end, minimumStep)
|
|
</div>
|
|
<div class="description"></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<!-- ============================== properties summary ===================== -->
|
|
|
|
|
|
<!-- ============================== methods summary ======================== -->
|
|
|
|
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class links.Timeline.StepDate.">
|
|
<caption>Method Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Method Attributes</th>
|
|
<th scope="col">Method Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#addZeros">addZeros</a></b>(value, len)
|
|
</div>
|
|
<div class="description">Add leading zeros to the given value to match the desired length.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#end">end</a></b>()
|
|
</div>
|
|
<div class="description">Check if the end date is reached</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#getCurrent">getCurrent</a></b>()
|
|
</div>
|
|
<div class="description">Get the current datetime</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#getLabelMajor">getLabelMajor</a></b>(options, date)
|
|
</div>
|
|
<div class="description">Returns formatted text for the major axislabel, depending on the current
|
|
date and the scale.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#getLabelMinor">getLabelMinor</a></b>(options, date)
|
|
</div>
|
|
<div class="description">Returns formatted text for the minor axislabel, depending on the current
|
|
date and the scale.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#isMajor">isMajor</a></b>()
|
|
</div>
|
|
<div class="description">Check if the current step is a major step (for example when the step
|
|
is DAY, a major step is each first day of the MONTH)</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#next">next</a></b>()
|
|
</div>
|
|
<div class="description">Do the next step</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#roundToMinor">roundToMinor</a></b>()
|
|
</div>
|
|
<div class="description">Round the current date to the first minor date value
|
|
This must be executed once when the current date is set to start Date</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#setAutoScale">setAutoScale</a></b>(enable)
|
|
</div>
|
|
<div class="description">Enable or disable autoscaling</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#setMinimumStep">setMinimumStep</a></b>(minimumStep)
|
|
</div>
|
|
<div class="description">Automatically determine the scale that bests fits the provided minimum step</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#setRange">setRange</a></b>(start, end, minimumStep)
|
|
</div>
|
|
<div class="description">Set a new range
|
|
If minimumStep is provided, the step size is chosen as close as possible
|
|
to the minimumStep but larger than minimumStep.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#setScale">setScale</a></b>(newScale, newStep)
|
|
</div>
|
|
<div class="description">Set a custom scale.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#snap">snap</a></b>(date)
|
|
</div>
|
|
<div class="description">Snap a date to a rounded value.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/links.Timeline.StepDate.html#start">start</a></b>()
|
|
</div>
|
|
<div class="description">Set the step iterator to the start date.</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">
|
|
<b>links.Timeline.StepDate</b>(start, end, minimumStep)
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>start</b>
|
|
|
|
</dt>
|
|
<dd>The start date, for example new Date(2010, 9, 21)
|
|
or new Date(2010, 9, 21, 23, 45, 00)</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>end</b>
|
|
|
|
</dt>
|
|
<dd>The end date</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Number}</span> <b>minimumStep</b>
|
|
|
|
</dt>
|
|
<dd>Optional. Minimum step size in milliseconds</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<!-- ============================== field details ========================== -->
|
|
|
|
|
|
<!-- ============================== method details ========================= -->
|
|
|
|
<div class="sectionTitle">
|
|
Method Detail
|
|
</div>
|
|
|
|
<a name="addZeros"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{string}</span>
|
|
<b>addZeros</b>(value, len)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Add leading zeros to the given value to match the desired length.
|
|
For example addZeros(123, 5) returns "00123"
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{int}</span> <b>value</b>
|
|
|
|
</dt>
|
|
<dd>A value</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{int}</span> <b>len</b>
|
|
|
|
</dt>
|
|
<dd>Desired final length</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{string}</span> value with leading zeros</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="end"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{boolean}</span>
|
|
<b>end</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Check if the end date is reached
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{boolean}</span> true if the current date has passed the end date</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getCurrent"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{Date}</span>
|
|
<b>getCurrent</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Get the current datetime
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{Date}</span> current The current date</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getLabelMajor"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>getLabelMajor</b>(options, date)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns formatted text for the major axislabel, depending on the current
|
|
date and the scale. For example when scale is MINUTE, the major scale is
|
|
hours, and the hour will be formatted as "hh".
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>options</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>date</b>
|
|
<i>Optional</i>
|
|
</dt>
|
|
<dd>custom date. if not provided, current date is taken</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getLabelMinor"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>getLabelMinor</b>(options, date)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns formatted text for the minor axislabel, depending on the current
|
|
date and the scale. For example when scale is MINUTE, the current time is
|
|
formatted as "hh:mm".
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>options</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>date</b>
|
|
<i>Optional</i>
|
|
</dt>
|
|
<dd>custom date. if not provided, current date is taken</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="isMajor"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{boolean}</span>
|
|
<b>isMajor</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Check if the current step is a major step (for example when the step
|
|
is DAY, a major step is each first day of the MONTH)
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{boolean}</span> true if current date is major, else false.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="next"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>next</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Do the next step
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="roundToMinor"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>roundToMinor</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Round the current date to the first minor date value
|
|
This must be executed once when the current date is set to start Date
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setAutoScale"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>setAutoScale</b>(enable)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Enable or disable autoscaling
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{boolean}</span> <b>enable</b>
|
|
|
|
</dt>
|
|
<dd>If true, autoascaling is set true</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setMinimumStep"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>setMinimumStep</b>(minimumStep)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Automatically determine the scale that bests fits the provided minimum step
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Number}</span> <b>minimumStep</b>
|
|
|
|
</dt>
|
|
<dd>The minimum step size in milliseconds</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setRange"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>setRange</b>(start, end, minimumStep)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Set a new range
|
|
If minimumStep is provided, the step size is chosen as close as possible
|
|
to the minimumStep but larger than minimumStep. If minimumStep is not
|
|
provided, the scale is set to 1 DAY.
|
|
The minimumStep should correspond with the onscreen size of about 6 characters
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>start</b>
|
|
|
|
</dt>
|
|
<dd>The start date and time.</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>end</b>
|
|
|
|
</dt>
|
|
<dd>The end date and time.</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{int}</span> <b>minimumStep</b>
|
|
|
|
</dt>
|
|
<dd>Optional. Minimum step size in milliseconds</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setScale"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>setScale</b>(newScale, newStep)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Set a custom scale. Autoscaling will be disabled.
|
|
For example setScale(SCALE.MINUTES, 5) will result
|
|
in minor steps of 5 minutes, and major steps of an hour.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{links.Timeline.StepDate.SCALE}</span> <b>newScale</b>
|
|
|
|
</dt>
|
|
<dd>A scale. Choose from SCALE.MILLISECOND,
|
|
SCALE.SECOND, SCALE.MINUTE, SCALE.HOUR,
|
|
SCALE.WEEKDAY, SCALE.DAY, SCALE.MONTH,
|
|
SCALE.YEAR.</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Number}</span> <b>newStep</b>
|
|
|
|
</dt>
|
|
<dd>A step size, by default 1. Choose for
|
|
example 1, 2, 5, or 10.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="snap"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>snap</b>(date)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Snap a date to a rounded value. The snap intervals are dependent on the
|
|
current scale and step.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Date}</span> <b>date</b>
|
|
|
|
</dt>
|
|
<dd>the date to be snapped</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="start"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>start</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Set the step iterator to the start date.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== event details ========================= -->
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
<!-- ============================== footer ================================= -->
|
|
<div class="fineprint" style="clear:both">
|
|
|
|
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Wed Mar 04 2015 09:58:28 GMT+0100 (CET)
|
|
</div>
|
|
</body>
|
|
</html>
|