global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="TZ"><span class="type-signature"></span>TZ<span class="type-signature"></span></h4>


<div class="description">
    Time zone selector, blank means "system time zone", "UTC" means UTC. These are the only recognised values.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line48">line 48</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="TZOffset"><span class="type-signature"></span>TZOffset<span class="type-signature"></span></h4>


<div class="description">
    Computed (real) time zone offset in ms, result may differ from Date.prototype.TZOffset() (in min).
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line50">line 50</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="addedTime"><span class="type-signature"></span>addedTime<span class="type-signature"></span></h4>


<div class="description">
    The quantum of milliseconds to add or subtract by clicking + or - button.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line348">line 348</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="askedOptions"><span class="type-signature"></span>askedOptions<span class="type-signature"></span></h4>


<div class="description">
    asked display options for Intl.DateTimeFormat.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line52">line 52</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="calendars"><span class="type-signature"></span>calendars<span class="type-signature"></span></h4>


<div class="description">
    Array of available custom calendars.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line42">line 42</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="calendrical"><span class="type-signature">(constant) </span>calendrical<span class="type-signature"></span></h4>


<div class="description">
    Prefix for all calendrical-javascript imported objects. The calendar classes also imported from calendars.js are not described here, as they may change.
</div>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pldrDOM</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Private Locale Data Repository as a domain.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>TimeUnits</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The time units in milliseconds.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>ExtDate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Extends legacy Date object.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>ExtDateTimeFormat</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Extends Intl.DateTimeFormat.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-init.js.html">calendrical-init.js</a>, <a href="calendrical-init.js.html#line42">line 42</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="cusAskedOptions"><span class="type-signature"></span>cusAskedOptions<span class="type-signature"></span></h4>


<div class="description">
    resolved display options for ExtDateTimeFormat, with the calendar specified by the user.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line60">line 60</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="customCalIndex"><span class="type-signature"></span>customCalIndex<span class="type-signature"></span></h4>


<div class="description">
    Index of custom calendar currently used.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line44">line 44</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="dayOffset"><span class="type-signature"></span>dayOffset<span class="type-signature"></span></h4>


<div class="description">
    The quantum of decimal days to add or subtract by clicking + or - button.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line304">line 304</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="extAskedOptions"><span class="type-signature"></span>extAskedOptions<span class="type-signature"></span></h4>


<div class="description">
    asked display options for ExtDateTimeFormat.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line56">line 56</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="extUsedOptions"><span class="type-signature"></span>extUsedOptions<span class="type-signature"></span></h4>


<div class="description">
    resolved display options for ExtDateTimeFormat.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line58">line 58</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="loadCalendrical"><span class="type-signature">(constant) </span>loadCalendrical<span class="type-signature"></span></h4>


<div class="description">
    This promise aggregates all calendrical-javascript imports and initialisations.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-init.js.html">calendrical-init.js</a>, <a href="calendrical-init.js.html#line45">line 45</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="switchingDate"><span class="type-signature"></span>switchingDate<span class="type-signature"></span></h4>


<div class="description">
    The first date where the Gregorian calendar was enforced, as set by the user.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line40">line 40</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="targetDate"><span class="type-signature"></span>targetDate<span class="type-signature"></span></h4>


<div class="description">
    The date (instant) to be displayed, initially now.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line46">line 46</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="usedOptions"><span class="type-signature"></span>usedOptions<span class="type-signature"></span></h4>


<div class="description">
    resolved display options for Intl.DateTimeFormat.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line54">line 54</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="addTime"><span class="type-signature"></span>addTime<span class="signature">(sign)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Add or subtract a quantum of time to targetDate.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sign</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last">add if +1, subtract if -1, erroneous if other value.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line363">line 363</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="calcCustom"><span class="type-signature"></span>calcCustom<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Compute date from field values of current custom calendar.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line242">line 242</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="calcTime"><span class="type-signature"></span>calcTime<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Set local or UTC time, after global TZ, in same day.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line333">line 333</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="calcWeek"><span class="type-signature"></span>calcWeek<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Compute date from week field values of current custom calendar.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line267">line 267</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="changeAddTime"><span class="type-signature"></span>changeAddTime<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Change value of addedTime.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line350">line 350</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="changeDayOffset"><span class="type-signature"></span>changeDayOffset<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Change value of dayOffset.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line307">line 307</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="compLocalePresentationCalendar"><span class="type-signature"></span>compLocalePresentationCalendar<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Recompute all Intl.DateTimeFormat and ExtDateTimeFormat objects after a change in display parameters.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line128">line 128</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getMode"><span class="type-signature"></span>getMode<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Initiate TZ variable (time zone mode) after value in HTML document.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line373">line 373</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setCalend"><span class="type-signature"></span>setCalend<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Set current custom calendar to new value and compute fields.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line236">line 236</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setDateToNow"><span class="type-signature"></span>setDateToNow<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Set date to present instant, with the selected user calendar.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line387">line 387</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setDayOffset"><span class="type-signature"></span>setDayOffset<span class="signature">(sign)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Add or subtract a quantum of days to targetDate.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sign</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last">add if +1, subtract if -1, erroneous if other value.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line321">line 321</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setDisplay"><span class="type-signature"></span>setDisplay<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Recompute and display all date elements and parameters after a change of targetDate or of display parameters.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line63">line 63</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setUTCHoursFixed"><span class="type-signature"></span>setUTCHoursFixed<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Set a simple UTC hour at same date. The date is computed after TZ value.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="calendrical-demo.js.html">calendrical-demo.js</a>, <a href="calendrical-demo.js.html#line377">line 377</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-calendars.html">calendars</a></li><li><a href="module-chronos.html">chronos</a></li><li><a href="module-customcalendarmodel.html">customcalendarmodel</a></li><li><a href="module-extdate.html">extdate</a></li><li><a href="module-extdatetimeformat.html">extdatetimeformat</a></li><li><a href="module-fetchdom.html">fetchdom</a></li><li><a href="module-pldr.html">pldr</a></li><li><a href="module-time-units.html">time-units</a></li></ul><h3>Namespaces</h3><ul><li><a href="window.html">window</a></li></ul><h3>Classes</h3><ul><li><a href="module-calendars.FrenchRevCalendar.html">FrenchRevCalendar</a></li><li><a href="module-calendars.GregorianCalendar.html">GregorianCalendar</a></li><li><a href="module-calendars.JulianCalendar.html">JulianCalendar</a></li><li><a href="module-calendars.MilesianCalendar.html">MilesianCalendar</a></li><li><a href="module-calendars.Persian33Calendar.html">Persian33Calendar</a></li><li><a href="module-calendars.ProlepticGregorianCalendar.html">ProlepticGregorianCalendar</a></li><li><a href="module-chronos.Cbcce.html">Cbcce</a></li><li><a href="module-chronos.IsoCounter.html">IsoCounter</a></li><li><a href="module-chronos.WeekClock.html">WeekClock</a></li><li><a href="module-extdate.html">extdate</a></li><li><a href="module-extdatetimeformat.html">extdatetimeformat</a></li></ul><h3>Global</h3><ul><li><a href="global.html#TZ">TZ</a></li><li><a href="global.html#TZOffset">TZOffset</a></li><li><a href="global.html#addTime">addTime</a></li><li><a href="global.html#addedTime">addedTime</a></li><li><a href="global.html#askedOptions">askedOptions</a></li><li><a href="global.html#calcCustom">calcCustom</a></li><li><a href="global.html#calcTime">calcTime</a></li><li><a href="global.html#calcWeek">calcWeek</a></li><li><a href="global.html#calendars">calendars</a></li><li><a href="global.html#calendrical">calendrical</a></li><li><a href="global.html#changeAddTime">changeAddTime</a></li><li><a href="global.html#changeDayOffset">changeDayOffset</a></li><li><a href="global.html#compLocalePresentationCalendar">compLocalePresentationCalendar</a></li><li><a href="global.html#cusAskedOptions">cusAskedOptions</a></li><li><a href="global.html#customCalIndex">customCalIndex</a></li><li><a href="global.html#dayOffset">dayOffset</a></li><li><a href="global.html#extAskedOptions">extAskedOptions</a></li><li><a href="global.html#extUsedOptions">extUsedOptions</a></li><li><a href="global.html#getMode">getMode</a></li><li><a href="global.html#loadCalendrical">loadCalendrical</a></li><li><a href="global.html#setCalend">setCalend</a></li><li><a href="global.html#setDateToNow">setDateToNow</a></li><li><a href="global.html#setDayOffset">setDayOffset</a></li><li><a href="global.html#setDisplay">setDisplay</a></li><li><a href="global.html#setUTCHoursFixed">setUTCHoursFixed</a></li><li><a href="global.html#switchingDate">switchingDate</a></li><li><a href="global.html#targetDate">targetDate</a></li><li><a href="global.html#usedOptions">usedOptions</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Sun Jun 23 2024 19:20:55 GMT+0200 (heure d’été d’Europe centrale)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>