gch_ling
/
kev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
v4.5
main
develop
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da2c0e2a48'
${ noResults }
kev/Drawer/HtmlRoot/rulez.js-master/doc/Rulez.html

1449 lines
14 KiB
HTML
Raw Normal View History Unescape Escape

搬运代码
1 month ago
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Rulez</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">Class: Rulez</h1>
<section>
<header>
<h2>
Rulez
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Rulez"><span class="type-signature"></span>new Rulez<span class="signature">(config)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="~additionalDivisionsAmount"><span class="type-signature">(inner) </span>additionalDivisionsAmount<span class="type-signature"></span></h4>
<div class="description">
amount of additional(redundant) divisions on left and right (top, bottom) side of ruler
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~c"><span class="type-signature">(inner) </span>c<span class="type-signature"></span></h4>
<div class="description">
result config
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~currentPosition"><span class="type-signature">(inner) </span>currentPosition<span class="type-signature"> :number</span></h4>
<div class="description">
Current position of ruler
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~endPosition"><span class="type-signature">(inner) </span>endPosition<span class="type-signature"> :number</span></h4>
<div class="description">
End position of drawing ruler
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~g"><span class="type-signature">(inner) </span>g<span class="type-signature"> :SVGGElement</span></h4>
<div class="description">
main group (g svg element) that contains all divisions and texts
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">SVGGElement</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~scale"><span class="type-signature">(inner) </span>scale<span class="type-signature"> :number</span></h4>
<div class="description">
Scale of ruler
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line99">line 99</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~startPosition"><span class="type-signature">(inner) </span>startPosition<span class="type-signature"> :number</span></h4>
<div class="description">
Start position of drawing ruler
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~texts"><span class="type-signature">(inner) </span>texts<span class="type-signature"> :Array.&lt;Array.&lt;SVGTextElement>></span></h4>
<div class="description">
Array of arrays of all texts
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;Array.&lt;SVGTextElement>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line79">line 79</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getUnitConversionRate"><span class="type-signature"></span>getUnitConversionRate<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line234">line 234</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
how much pixels are in used unit.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Renders ruler inside svg element
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line108">line 108</a>
</li></ul></dd>
</dl>
<h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Updates size with current clientWidth(height) in case it's bigger than previous one.
Only appends more divisions and texts if necessary.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line169">line 169</a>
</li></ul></dd>
</dl>
<h4 class="name" id="saveAsImage"><span class="type-signature"></span>saveAsImage<span class="signature">(saveFinishCallback)</span><span class="type-signature"></span></h4>
<div class="description">
Saves ruler as image.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>saveFinishCallback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#saveFinishCallback">saveFinishCallback</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line194">line 194</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scrollTo"><span class="type-signature"></span>scrollTo<span class="signature">(pos, useUnits)</span><span class="type-signature"></span></h4>
<div class="description">
Scrolls ruler to specified position.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pos</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">left(or top for vertical rulers) position to scroll to.</td>
</tr>
<tr>
<td class="name"><code>useUnits</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">if true pos will be multiplied by unit conversion rate;</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line124">line 124</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setScale"><span class="type-signature"></span>setScale<span class="signature">(scaleValue)</span><span class="type-signature"></span></h4>
<div class="description">
Scales the ruler's text values by specific value.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scaleValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rulez.js.html">rulez.js</a>, <a href="rulez.js.html#line160">line 160</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Rulez.html">Rulez</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Oct 09 2015 14:35:05 GMT-0700 (PDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>