docs/Module.html
<!DOCTYPE html>
<html>
<head>
<title>Main Kronicle.Module class</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page">
<a class="source" href="Core.html">
Core.js
</a>
<a class="source" href="EventTypes.html">
EventTypes.js
</a>
<a class="source" href="Kronicle.html">
Kronicle.js
</a>
<a class="source" href="Module.html">
Module.js
</a>
<a class="source" href="ArrayDataSource.html">
ArrayDataSource.js
</a>
<a class="source" href="Component.html">
Component.js
</a>
<a class="source" href="Controller.html">
Controller.js
</a>
<a class="source" href="DataSource.html">
DataSource.js
</a>
<a class="source" href="DataSources.html">
DataSources.js
</a>
<a class="source" href="DataSourcesEvents.html">
DataSourcesEvents.js
</a>
<a class="source" href="View.html">
View.js
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
<h1 id="main-kronicle-module-class">Main Kronicle.Module class</h1>
<p>The Module class is used as the base for all modules that are to be added to the Kronicle app.
The constructor takes an args object that contains one property by default:</p>
<ul>
<li>name - the name of the module.</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre>export <span class="hljs-keyword">class</span> Module {
constructor(args = {name: <span class="hljs-string">""</span>}) {
<span class="hljs-keyword">this</span>.name = args.name;
<span class="hljs-keyword">this</span>.initialize(args);
}</pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<h2 id="initialize-method">initialize method</h2>
<p>This is a no-op that is overriden in an extended Module implementation and is called when the core is initalized</p>
</div>
<div class="content"><div class='highlight'><pre> initialize() {
}
}</pre></div></div>
</li>
</ul>
</div>
</body>
</html>