multimediaobject
Version:
Multimediaobject library
385 lines (137 loc) • 8.85 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>MultimediaObject - 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>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="MultimediaObject.html">MultimediaObject</a></li></ul><h3>Global</h3><ul><li><a href="global.html#add">add</a></li><li><a href="global.html#addAnimationKeyframe">addAnimationKeyframe</a></li><li><a href="global.html#addAnimationProperties">addAnimationProperties</a></li><li><a href="global.html#addDefaultParameters">addDefaultParameters</a></li><li><a href="global.html#addGlobalStyle">addGlobalStyle</a></li><li><a href="global.html#addListener">addListener</a></li><li><a href="global.html#appendElementTo">appendElementTo</a></li><li><a href="global.html#applyAttributes">applyAttributes</a></li><li><a href="global.html#applyBreakpoints">applyBreakpoints</a></li><li><a href="global.html#applyDependencies">applyDependencies</a></li><li><a href="global.html#applyEvents">applyEvents</a></li><li><a href="global.html#applyFunctions">applyFunctions</a></li><li><a href="global.html#applyIteration">applyIteration</a></li><li><a href="global.html#applyStyle">applyStyle</a></li><li><a href="global.html#changeAnimation">changeAnimation</a></li><li><a href="global.html#checkBreakpoints">checkBreakpoints</a></li><li><a href="global.html#checkDep">checkDep</a></li><li><a href="global.html#deactivateEvent">deactivateEvent</a></li><li><a href="global.html#deleteAnimationKeyframe">deleteAnimationKeyframe</a></li><li><a href="global.html#deleteAnimationProperties">deleteAnimationProperties</a></li><li><a href="global.html#dispatchEvent">dispatchEvent</a></li><li><a href="global.html#exportToJSON">exportToJSON</a></li><li><a href="global.html#generate">generate</a></li><li><a href="global.html#getComputedStyle">getComputedStyle</a></li><li><a href="global.html#getSortedSteps">getSortedSteps</a></li><li><a href="global.html#getTotalAnimationTime">getTotalAnimationTime</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#interpolateStep">interpolateStep</a></li><li><a href="global.html#loadFromJSON">loadFromJSON</a></li><li><a href="global.html#preInterpolateStep">preInterpolateStep</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#removeDependencies">removeDependencies</a></li><li><a href="global.html#removeEvent">removeEvent</a></li><li><a href="global.html#removeFunction">removeFunction</a></li><li><a href="global.html#removeListener">removeListener</a></li><li><a href="global.html#removePropertie">removePropertie</a></li><li><a href="global.html#requireDependencies">requireDependencies</a></li><li><a href="global.html#restartAnimation">restartAnimation</a></li><li><a href="global.html#runAnimation">runAnimation</a></li><li><a href="global.html#setAbsoluteAssetURL">setAbsoluteAssetURL</a></li><li><a href="global.html#startAnimation">startAnimation</a></li><li><a href="global.html#stopAnimation">stopAnimation</a></li><li><a href="global.html#transformEvent">transformEvent</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">MultimediaObject</h1>
<section>
<header>
<h2>
MultimediaObject
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="MultimediaObject"><span class="type-signature"></span>new MultimediaObject<span class="signature">(type, name, data, style, attributes, events, animations)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Represents a MultimediaObject</p>
</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>type</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>a JSON representing the object or the DOM type of the MultimediaObject</p></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the name of the MultimediaObject</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>an object representing the datas which can be internally used by the MultimediaObject</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>an object representing the CSS style of the MultimediaObject, applied at creation</p></td>
</tr>
<tr>
<td class="name"><code>attributes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>an object representing the DOM attributes of the MultimediaObject, applied at creation to the DOM Element</p></td>
</tr>
<tr>
<td class="name"><code>events</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>an object representing the Events provided by the object. Supporting only DOM events for the moment.</p></td>
</tr>
<tr>
<td class="name"><code>animations</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>a second separated Object representing the MultimediaObject state over time. Each step contain an object with style values wich will be precompiled and applied over time.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<p class="code-caption">Instanciation</p>
<pre class="prettyprint"><code>new MultimediaObject({
type: 'div',
style: {
position: 'absolute',
translateX: '10%'
},
attributes: {
id: 'multimediaObject',
'data-test': 'test',
},
events: {
click: function(event) {
console.log(this);
console.log(event);
};
}
});</code></pre>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Mar 01 2017 01:47:36 GMT+0100 (Paris, Madrid) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>