1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012 |
- <!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.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.StepDate.html">links.StepDate</a></li>
-
- <li><a href="../symbols/links.Timeline.html">links.Timeline</a></li>
-
- </ul>
- <hr />
- <!-- end publish.classesIndex -->
- </div>
-
- <div id="content">
- <!-- ============================== class title ============================ -->
- <h1 class="classTitle">
-
- Class links.StepDate
- </h1>
- <!-- ============================== class summary ========================== -->
- <p class="description">
-
-
-
- StepDate
- The class StepDate is an iterator for dates. You provide a start date and an
- end date. The class itself determines the best scale (step size) based on the
- provided start Date, end Date, and minimumStep.
- 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
- Alternatively, you can set a scale by hand.
- After creation, you can initialize the class by executing start(). Then you
- can iterate from the start date to the end date via next(). You can check if
- the end date is reached with the function end(). After each step, you can
- retrieve the current date via get().
- The class step has scales ranging from milliseconds, seconds, minutes, hours,
- days, to years.
- Version: 0.9
-
-
- <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.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.StepDate.html#constructor">links.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.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.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.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.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.StepDate.html#getLabelMajor">getLabelMajor</a></b>(optional)
- </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.StepDate.html#getLabelMinor">getLabelMinor</a></b>()
- </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.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.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.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.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.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.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.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.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.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.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">{int}</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">
-
- <span class="light">{string}</span>
- <b>getLabelMajor</b>(optional)
-
- </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">{Date}</span> <b>optional</b>
-
- </dt>
- <dd>custom date. if not provided, current date is taken</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{string}</span> major axislabel</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getLabelMinor"> </a>
- <div class="fixedFont">
-
- <span class="light">{string}</span>
- <b>getLabelMinor</b>()
-
- </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">Returns:</dt>
-
- <dd><span class="light fixedFont">{string}</span> minor axislabel</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="isMajor"> </a>
- <div class="fixedFont">
-
-
- <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>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">{int}</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">{Step.SCALE}</span> <b>newScale</b>
-
- </dt>
- <dd>A scale. Choose from SCALE.MILLISECOND,
- SCALE.SECOND, SCALE.MINUTE, SCALE.HOUR,
- SCALE.DAY, SCALE.MONTH, SCALE.YEAR.</dd>
-
- <dt>
- <span class="light fixedFont">{int}</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 30 2011 11:45:24 GMT+0200 (CEST)
- </div>
- </body>
- </html>
|