plasma-banner-scripts
Version:
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
826 lines (190 loc) • 10.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: Initiators/FlipClock/Faces</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">Namespace: Initiators/FlipClock/Faces</h1>
<section>
<header>
<h2>Initiators/FlipClock/Faces</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>FlipClock.js has a fully extendible API to create any clock face you need.
More clock faces will be added over time, so be sure to fork the code and make a pull request
if you want to see your clock face appear in the core library.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="DailyCounterFace"><span class="type-signature"></span>DailyCounterFace<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Transform default counter to Plasma standard counter with day counter</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
<h4 class="name" id="HourlyCounterFace"><span class="type-signature"></span>HourlyCounterFace<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Transform default counter to Plasma standard counter without day counter</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".getPlasmaDailyLabels"><span class="type-signature">(static) </span>getPlasmaDailyLabels<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Generate array with translate labels for Daily face</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>translate labels for Daily face</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id=".getPlasmaHourlyCounter"><span class="type-signature">(static) </span>getPlasmaHourlyCounter<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Generate array with current time for Hourly face</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>current time for Hourly face</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id=".getPlasmaHourlyCounter"><span class="type-signature">(static) </span>getPlasmaHourlyCounter<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Generate array with current time for Daily face</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>current time for Daily face</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id=".getPlasmaHourlyLabels"><span class="type-signature">(static) </span>getPlasmaHourlyLabels<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Generate array with translate labels for Hourly face</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>translate labels for Hourly face</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id=".numberize"><span class="type-signature">(static) </span>numberize<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Formats any array of numbers into a valid array of numbers</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="initiators_flipclock_extension_faces.js.html">initiators/flipclock/extension/faces.js</a>, <a href="initiators_flipclock_extension_faces.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>current time for Daily face</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Initiators.Promotion.html">Promotion</a></li><li><a href="Initiators_Analytics.TagManager.html">TagManager</a></li><li><a href="Initiators_FlipClock.FlipClockInitiator.html">FlipClockInitiator</a></li><li><a href="Initiators_UI.UiBanner.html">UiBanner</a></li><li><a href="Initiators_UI.UiPopup.html">UiPopup</a></li><li><a href="Utils.Parameters.html">Parameters</a></li></ul><h3>Namespaces</h3><ul><li><a href="Initiators.html">Initiators</a></li><li><a href="Initiators_Analytics.html">Initiators/Analytics</a></li><li><a href="Initiators_FlipClock.html">Initiators/FlipClock</a></li><li><a href="Initiators_FlipClock_Faces.html">Initiators/FlipClock/Faces</a></li><li><a href="Initiators_FlipClock_Language.html">Initiators/FlipClock/Language</a></li><li><a href="Initiators_UI.html">Initiators/UI</a></li><li><a href="Main.html">Main</a></li><li><a href="Utils.html">Utils</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addClass">addClass</a></li><li><a href="global.html#attr">attr</a></li><li><a href="global.html#data">data</a></li><li><a href="global.html#dispatch">dispatch</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#getAll">getAll</a></li><li><a href="global.html#hasClass">hasClass</a></li><li><a href="global.html#prepend">prepend</a></li><li><a href="global.html#removeAttribute">removeAttribute</a></li><li><a href="global.html#removeClass">removeClass</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jun 18 2019 11:40:32 GMT+0300 (Eastern European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>