<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: image</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: image</h1>
<section>
<header>
<h2>
image
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="image"><span class="type-signature"></span>new image<span class="signature">(id)</span><span class="type-signature"></span></h4>
<div class="description">
Creates an image object
</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>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the dom element containing the image</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="GetAvailHeight"><span class="type-signature"></span>GetAvailHeight<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
gets available height (6.14.06)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line245">line 245</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GetAvailWidth"><span class="type-signature"></span>GetAvailWidth<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
gets available width (6.14.06)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line239">line 239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GetFileInfo"><span class="type-signature"></span>GetFileInfo<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Returns file_info object that contains information about the
displayed image.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GetImRatio"><span class="type-signature"></span>GetImRatio<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Returns the ratio of the available width/height to the original
width/height.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GetNewImage"><span class="type-signature"></span>GetNewImage<span class="signature">(onload_helper)</span><span class="type-signature"></span></h4>
<div class="description">
Fetches a new image based on the URL string or gets a new one at
</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>onload_helper</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">pointer to a helper function that
is called when the image is loaded. Typically, this
will call obj.SetImageDimensions().</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="IsFitImage"><span class="type-signature"></span>IsFitImage<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Returns true if the image is zoomed to the original (fitted) resolution.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line256">line 256</a>
</li></ul></dd>
</dl>
<h4 class="name" id="IsPointVisible"><span class="type-signature"></span>IsPointVisible<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Returns true if (x,y) is viewable.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line261">line 261</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ScaleFrame"><span class="type-signature"></span>ScaleFrame<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Tells the picture to take up the available space in the browser, if it needs it. 6.29.06
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line206">line 206</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ScrollbarsOff"><span class="type-signature"></span>ScrollbarsOff<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Turn off image scrollbars if zoomed in.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ScrollbarsOn"><span class="type-signature"></span>ScrollbarsOn<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Turn on image scrollbars if zoomed in.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line129">line 129</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SetImageDimensions"><span class="type-signature"></span>SetImageDimensions<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Sets the dimensions of the image based on browser setup.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SetOrigImDims"><span class="type-signature"></span>SetOrigImDims<span class="signature">(im)</span><span class="type-signature"></span></h4>
<div class="description">
Retrieves and sets the original image's dimensions (width/height).
</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>im</code></td>
<td class="type">
<span class="param-type"><a href="image.html">image</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="image.js.html">image.js</a>, <a href="image.js.html#line232">line 232</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SlideWindow"><span class="type-signature"></span>SlideWindow<span class="signature">(x, y)</span><span class="type-signature"> → {intarray}</span></h4>
<div class="description">
If (x,y) is not in view, then scroll it into view. Return adjusted
(x,y) point that takes into account the slide offset.
</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>x</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">int</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="image.js.html">image.js</a>, <a href="image.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">intarray</span>
</dd>
</dl>
<h4 class="name" id="Zoom"><span class="type-signature"></span>Zoom<span class="signature">(amt)</span><span class="type-signature"></span></h4>
<div class="description">
Zoom the image given a zoom level (amt) between 0 and inf (or 'fitted').
</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>amt</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">amount of zoom</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="image.js.html">image.js</a>, <a href="image.js.html#line138">line 138</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdjustEvent.html">AdjustEvent</a></li><li><a href="canvas.html">canvas</a></li><li><a href="file_info.html">file_info</a></li><li><a href="image.html">image</a></li></ul><h3>Global</h3><ul><li><a href="global.html#AdjustPolygonButton">AdjustPolygonButton</a></li><li><a href="global.html#CreatePopupBubble">CreatePopupBubble</a></li><li><a href="global.html#CreatePopupBubbleCloseButton">CreatePopupBubbleCloseButton</a></li><li><a href="global.html#DrawCanvasClosePolygon">DrawCanvasClosePolygon</a></li><li><a href="global.html#DrawCanvasMouseDown">DrawCanvasMouseDown</a></li><li><a href="global.html#FinishStartup">FinishStartup</a></li><li><a href="global.html#getQueryVariable">getQueryVariable</a></li><li><a href="global.html#LMgetObjectField">LMgetObjectField</a></li><li><a href="global.html#LMnumberOfObjects">LMnumberOfObjects</a></li><li><a href="global.html#LoadAnnotation404">LoadAnnotation404</a></li><li><a href="global.html#LoadAnnotationSuccess">LoadAnnotationSuccess</a></li><li><a href="global.html#LoadTemplate404">LoadTemplate404</a></li><li><a href="global.html#LoadTemplateSuccess">LoadTemplateSuccess</a></li><li><a href="global.html#SetAllAnnotationsArray">SetAllAnnotationsArray</a></li><li><a href="global.html#StartDrawEvent">StartDrawEvent</a></li><li><a href="global.html#StartEditEvent">StartEditEvent</a></li><li><a href="global.html#StartEditVideoEvent">StartEditVideoEvent</a></li><li><a href="global.html#StartupLabelMe">StartupLabelMe</a></li><li><a href="global.html#StopDrawEvent">StopDrawEvent</a></li><li><a href="global.html#StopEditEvent">StopEditEvent</a></li><li><a href="global.html#UndoCloseButton">UndoCloseButton</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Mar 12 2015 16:00:32 GMT-0700 (PDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>