docs/Lateralus.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Lateralus - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Tutorials</li><li class="nav-item"><a href="tutorial-using-lateralus.html">Using Lateralus</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.html">Lateralus</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#.beget">beget</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#.inherit">inherit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#dispose">dispose</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#error">error</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#initRouter">initRouter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#log">log</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#shareWith">shareWith</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#toString">toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.html#warn">warn</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Component.html">Lateralus.Component</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.html#dispose">dispose</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.html#extend">extend</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.html#toString">toString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Component.Collection.html">Lateralus.Component.Collection</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.Collection.html#remove">remove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.Collection.html#toString">toString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Component.Model.html">Lateralus.Component.Model</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.Model.html#destroy">destroy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.Model.html#dispose">dispose</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.Model.html#toString">toString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Component.View.html">Lateralus.Component.View</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#addSubview">addSubview</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#deferredInitialize">deferredInitialize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#dispose">dispose</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#getTemplateRenderData">getTemplateRenderData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#initialize">initialize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#renderTemplate">renderTemplate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Component.View.html#toString">toString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Model.html">Lateralus.Model</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Model.html#onChange">onChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Model.html#toString">toString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Lateralus.Router.html">Lateralus.Router</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.Router.html#toString">toString</a></span></li><li class="nav-heading">Mixins</li><li class="nav-heading"><span class="nav-item-type type-mixin">M</span><span class="nav-item-name"><a href="Lateralus.mixins.html">Lateralus.mixins</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#addComponent">addComponent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#amplify">amplify</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#collect">collect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#collectOne">collectOne</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#delegateLateralusEvents">delegateLateralusEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#emit">emit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#initCollection">initCollection</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#initModel">initModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#listenFor">listenFor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Lateralus.mixins.html#mixin">mixin</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">Lateralus</h1>
<section>
<header>
<h2>
Lateralus
</h2>
<div class="class-description"><p>Lateralus</p></div>
</header>
<article>
<div class="container-overview">
<div class="section-method">
<h2>Constructor</h2>
<h4 class="name" id="Lateralus"><span class="type-signature"></span>new Lateralus<span class="signature">(el)</span><span class="type-signature"></span></h4>
<div class="description">
<p>You should not need to call the Lateralus constructor directly, use <code><a href="Lateralus.html#.beget"><code>Lateralus.beget</code></a></code> instead. To create a new Lateralus app:</p>
<pre class="prettyprint source"><code>var App = Lateralus.beget(function () {
// Don't forget to call the Lateralus constructor!
Lateralus.apply(this, arguments);
});
var app = new App(document.getElementById('app'));</code></pre>
</div>
<dl class="details">
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<li><a href="Lateralus.mixins.html">Lateralus.mixins</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<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>el</code></td>
<td class="type">
<span class="param-type"><code>Element</code></span>
</td>
<td class="description last">
<p>The DOM element that contains the entire Lateralus app.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="Lateralus.Component.html">Component</a></dt>
<dd></dd>
<dt><a href="Lateralus.Model.html">Model</a></dt>
<dd></dd>
<dt><a href="Lateralus.Router.html">Router</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Mixins</h3>
<dl>
<dt><a href="Lateralus.mixins.html">mixins</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<div class="section-members">
<h4 class="name" id="$el"><span class="type-signature"></span>$el<span class="type-signature"> :jQuery</span></h4>
<div class="description">
<p>The jQuery Object that contains <code><a href="Lateralus.html#el"><code>Lateralus#el</code></a></code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>jQuery</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="components"><span class="type-signature"></span>components<span class="type-signature"> :Object.<<a href="Lateralus.Component.html">Lateralus.Component</a>></span></h4>
<div class="description">
<p>The subcomponents belonging to this object. Do not modify this
property directly, it is managed by Lateralus.</p>
</div>
<dl class="details">
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<li><a href="Lateralus.mixins.html#.components">Lateralus.mixins.components</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.mixins.js.html">lateralus.mixins.js</a>, <a href="lateralus.mixins.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object.<<a href="Lateralus.Component.html">Lateralus.Component</a>></code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="el"><span class="type-signature"></span>el<span class="type-signature"> :HTMLElement</span></h4>
<div class="description">
<p>The DOM node that contains this <code><a href="Lateralus.html"><code>Lateralus</code></a></code> instance.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>HTMLElement</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="globalPartials"><span class="type-signature"></span>globalPartials<span class="type-signature"> :Object.<String></span></h4>
<div class="description">
<p>An optional map of template partials to be passed to the
<code>Mustache.render</code> call for all Views belonging to this Lateralus app.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object.<String></code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="globalRenderData"><span class="type-signature"></span>globalRenderData<span class="type-signature"> :Object.<String></span></h4>
<div class="description">
<p>An optional map of template render data to be passed to the
<code>Mustache.render</code> call for all Views belonging to this Lateralus app.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object.<String></code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="lateralusEvents"><span class="type-signature"></span>lateralusEvents<span class="type-signature"> :Object|undefined</span></h4>
<div class="description">
<p>A map of functions or string references to functions that will
handle <a href="http://backbonejs.org/#Events">events</a> dispatched to the
central <code><a href="Lateralus.html"><code>Lateralus</code></a></code> instance.</p>
<pre class="prettyprint source"><code>const ExtendedComponent = Lateralus.Component.extend({
name: 'extended',
lateralusEvents: {
anotherComponentChanged: 'onAnotherComponentChanged',
anotherComponentDestroyed: function () {
// ...
}
},
onAnotherComponentChanged: function () {
// ...
}
});</code></pre>
</div>
<dl class="details">
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<li><a href="Lateralus.mixins.html#.lateralusEvents">Lateralus.mixins.lateralusEvents</a></li>
</ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>undefined</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.mixins.js.html">lateralus.mixins.js</a>, <a href="lateralus.mixins.js.html#line255">line 255</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object</code></span>
|
<span class="param-type"><code>undefined</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="model"><span class="type-signature"></span>model<span class="type-signature"> :<a href="Lateralus.Model.html">Lateralus.Model</a></span></h4>
<div class="description">
<p>Maintains the state of the central <code><a href="Lateralus.html"><code>Lateralus</code></a></code> instance.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code><a href="Lateralus.Model.html">Lateralus.Model</a></code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="modelEvents"><span class="type-signature"></span>modelEvents<span class="type-signature"> :Object|undefined</span></h4>
<div class="description">
<p>A map of functions or string references to functions that will
handle <a href="http://backbonejs.org/#Events">events</a> emitted by
<code>this.model</code>.</p>
<pre class="prettyprint source"><code>const ExtendedComponent = Lateralus.View.extend({
modelEvents: {
changed:someProperty: function (model, someProperty) {
// ...
}
}
});</code></pre>
</div>
<dl class="details">
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<li><a href="Lateralus.mixins.html#.modelEvents">Lateralus.mixins.modelEvents</a></li>
</ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>undefined</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.mixins.js.html">lateralus.mixins.js</a>, <a href="lateralus.mixins.js.html#line317">line 317</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object</code></span>
|
<span class="param-type"><code>undefined</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="provide"><span class="type-signature"></span>provide<span class="type-signature"> :Object|undefined</span></h4>
<div class="description">
<p>A map of functions that will handle <code><a href="Lateralus.mixins.html#collect"><code>Lateralus.mixins#collect</code></a></code>
calls. Each of the functions attached to this Object should return a
value. These functions <strong>must</strong> be completely synchronous.</p>
<pre class="prettyprint source"><code>const App = Lateralus.beget(function () {
Lateralus.apply(this, arguments);
});
_.extend(App.prototype, {
provide: {
demoData: function () {
return 1;
}
}
});
const app = new App();
const ComponentSubclass = Lateralus.Component.extend({
name: 'provider',
provide: {
demoData: function () {
return 2;
}
}
});
app.addComponent(ComponentSubclass);
console.log(app.collect('demoData')); // [1, 2]</code></pre>
</div>
<dl class="details">
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<li><a href="Lateralus.mixins.html#.provide">Lateralus.mixins.provide</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.mixins.js.html">lateralus.mixins.js</a>, <a href="lateralus.mixins.js.html#line282">line 282</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Object</code></span>
|
<span class="param-type"><code>undefined</code></span>
</li>
</ul>
</div>
<h3 class="subsection-title">Methods</h3>
<div class="section-method">
<h4 class="name" id=".beget"><span class="type-signature">(static) </span>beget<span class="signature">(child, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4>
<div class="description">
<p>Create a <code><a href="Lateralus.html"><code>Lateralus</code></a></code> application instance.</p>
<pre class="prettyprint source"><code>var App = Lateralus.beget(function () {
Lateralus.apply(this, arguments);
});</code></pre>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><code>function</code></span>
</td>
<td class="attributes">
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Model</code></td>
<td class="type">
<span class="param-type"><code>LateralusModel</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<p>A <code><a href="Lateralus.Model.html"><code>Lateralus.Model</code></a></code> subclass
constructor to use for <code><code>Lateralus.model</code></code> instead of a standard
<code><a href="Lateralus.Model.html"><code>Lateralus.Model</code></a></code>.</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>function</code></span>
</dd>
</dl>
<div class="param-desc">
<p>The created <code><a href="Lateralus.html"><code>Lateralus</code></a></code>
subclass.</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".inherit"><span class="type-signature">(static) </span>inherit<span class="signature">(child, parent)</span><span class="type-signature"> → {function}</span></h4>
<div class="description">
<p>Set up the prototype chain between two objects.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<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>child</code></td>
<td class="type">
<span class="param-type"><code>function</code></span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type"><code>function</code></span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>function</code></span>
</dd>
</dl>
<div class="param-desc">
<p>A reference to the passed-in <code>child</code> parameter.</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id="dispose"><span class="type-signature"></span>dispose<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Remove this <code><a href="Lateralus.html"><code>Lateralus</code></a></code> app from memory.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line204">line 204</a>
</li></ul></dd>
</dl>
</div>
<div class="section-method">
<h4 class="name" id="error"><span class="type-signature"></span>error<span class="signature">(…Any)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Cross-browser friendly wrapper for <code>console.error</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line167">line 167</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Any</code></td>
<td class="type">
<span class="param-type"><code>any</code></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last">
<p>parameters to pass along to <code>console.error</code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section-method">
<h4 class="name" id="initRouter"><span class="type-signature"></span>initRouter<span class="signature">(Router, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Lateralus.Router.html">Lateralus.Router</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line178">line 178</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Router</code></td>
<td class="type">
<span class="param-type"><code><a href="Lateralus.Router.html">Lateralus.Router</a></code></span>
</td>
<td class="attributes">
</td>
<td class="description last">
<p>A constructor, not an instance.</p>
</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<p>To be passed to the <a href="http://backbonejs.org/#Router-constructor">Router
<code>initialize</code></a> method.</p>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code><a href="Lateralus.Router.html">Lateralus.Router</a></code></span>
</dd>
</dl>
<div class="param-desc">
<p>An instance of the provided Router
constructor.</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id="log"><span class="type-signature"></span>log<span class="signature">(…Any)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Cross-browser friendly wrapper for <code>console.log</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line153">line 153</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Any</code></td>
<td class="type">
<span class="param-type"><code>any</code></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last">
<p>parameters to pass along to <code>console.log</code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section-method">
<h4 class="name" id="shareWith"><span class="type-signature"></span>shareWith<span class="signature">(receiver, providerName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Relay <code><a href="Lateralus.mixins.html#.provide"><code>Lateralus.mixins.provide</code></a></code>d handlers to another <code><a href="Lateralus.html"><code>Lateralus</code></a></code> instance. This is the <code><a href="Lateralus.mixins.html#.provide"><code>Lateralus.mixins.provide</code></a></code> analog
to <code><code>Lateralus.mixins.amplify</code></code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
<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>receiver</code></td>
<td class="type">
<span class="param-type"><code><a href="Lateralus.html">Lateralus</a></code></span>
</td>
<td class="description last">
<p>The <code><a href="Lateralus.html"><code>Lateralus</code></a></code> instance to share
<code><a href="Lateralus.mixins.html#.provide"><code>Lateralus.mixins.provide</code></a></code>d handlers with.</p>
</td>
</tr>
<tr>
<td class="name"><code>providerName</code></td>
<td class="type">
<span class="param-type"><code>string</code></span>
</td>
<td class="description last">
<p>The name of the <code><a href="Lateralus.mixins.html#.provide"><code>Lateralus.mixins.provide</code></a></code>er.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section-method">
<h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Do not override this method, it is used internally.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line217">line 217</a>
</li></ul></dd>
</dl>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>string</code></span>
</dd>
</dl>
<div class="param-desc">
<p>This is <code>"lateralus"</code>.</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id="warn"><span class="type-signature"></span>warn<span class="signature">(…Any)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Cross-browser friendly wrapper for <code>console.warn</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lateralus.js.html">lateralus.js</a>, <a href="lateralus.js.html#line160">line 160</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Any</code></td>
<td class="type">
<span class="param-type"><code>any</code></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last">
<p>parameters to pass along to <code>console.warn</code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.3</a> on Thu Sep 07 2017 15:55:10 GMT-0500 (CDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>