<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>iwmlib API Documentation</title> <meta name="description" content="The IWM Browser: One Browser for all apps." /> <meta property="og:title" content="iwmlib API Documentation"/> <meta property="og:type" content="website"/> <meta property="og:image" content=""/> <meta property="og:url" content="https://www.iwm-tuebingen.de"/> <meta name="viewport" content="width=device-width, initial-scale=1"> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <script src="scripts/jquery.min.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link href="https://fonts.googleapis.com/css?family=Libre+Franklin:400,700" rel="stylesheet"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> <link type="text/css" rel="stylesheet" href="styles/main.css"> <script> var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"iwmlib","disqus":"","googleAnalytics":"","openGraph":{"title":"iwmlib API Documentation","type":"website","image":"","site_name":"","url":"https://www.iwm-tuebingen.de"},"meta":{"title":"iwmlib API Documentation","description":"The IWM Browser: One Browser for all apps.","keyword":""},"linenums":true,"cleverlinks":true,"default":{"outputSourceFiles":true,"useLongnameInNav":false}}; </script> </head> <body> <div id="wrap" class="clearfix"> <div class="navigation"> <h3 class="applicationName"><a href="index.html">iwmlib</a></h3> <button id="menuToggle" class="btn btn-link btn-lg menu-toggle"> <span class="glyphicon glyphicon-menu-hamburger"></span> </button> <div class="search"> <input id="search" type="text" class="form-control input-md" placeholder="Search..."> </div> <ul class="list"> <li class="item" data-name="global"> <span class="title namespace "> <span class="namespaceTag"> <span class="glyphicon glyphicon-globe"></span> </span> <a href="global.html">Global</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> <span class="subtitle">Typedefs</span> <li class="parent" data-name="actionActiveCallback"><a href="global.html#actionActiveCallback">actionActiveCallback</a></li> <li class="parent" data-name="actionCallback"><a href="global.html#actionCallback">actionCallback</a></li> <li class="parent" data-name="actionCallback"><a href="global.html#actionCallback">actionCallback</a></li> <li class="parent" data-name="afterActionCallback"><a href="global.html#afterActionCallback">afterActionCallback</a></li> <li class="parent" data-name="afterActionCallback"><a href="global.html#afterActionCallback">afterActionCallback</a></li> <li class="parent" data-name="beforeActionCallback"><a href="global.html#beforeActionCallback">beforeActionCallback</a></li> <li class="parent" data-name="beforeActionCallback"><a href="global.html#beforeActionCallback">beforeActionCallback</a></li> <li class="parent" data-name="onCompleteCallback"><a href="global.html#onCompleteCallback">onCompleteCallback</a></li> <li class="parent" data-name="onCompleteCallback"><a href="global.html#onCompleteCallback">onCompleteCallback</a></li> <li class="parent" data-name="onStartCallback"><a href="global.html#onStartCallback">onStartCallback</a></li> <li class="parent" data-name="onStartCallback"><a href="global.html#onStartCallback">onStartCallback</a></li> <li class="parent" data-name="onUpdateCallback"><a href="global.html#onUpdateCallback">onUpdateCallback</a></li> <li class="parent" data-name="onUpdateCallback"><a href="global.html#onUpdateCallback">onUpdateCallback</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="AbstractPopup"> <span class="title "> <a href="AbstractPopup.html">AbstractPopup</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="AbstractPopup#content"><a href="AbstractPopup.html#content">content</a></li> <li class="parent " data-name="AbstractPopup#header"><a href="AbstractPopup.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="AbstractPopup#hide"><a href="AbstractPopup.html#hide">hide</a></li> <li class="parent " data-name="AbstractPopup#layout"><a href="AbstractPopup.html#layout">layout</a></li> <li class="parent " data-name="AbstractPopup#show"><a href="AbstractPopup.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Badge"> <span class="title "> <a href="Badge.html">Badge</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="Badge#content"><a href="Badge.html#content">content</a></li> <li class=" " data-name="Badge#header"><a href="Badge.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="Badge#hide"><a href="Badge.html#hide">hide</a></li> <li class=" " data-name="Badge#layout"><a href="Badge.html#layout">layout</a></li> <li class=" " data-name="Badge#show"><a href="Badge.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="BlurFilter"> <span class="title "> <a href="BlurFilter.html">BlurFilter</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="BlurFilter#blur"><a href="BlurFilter.html#blur">blur</a></li> <li class="parent " data-name="BlurFilter#shape"><a href="BlurFilter.html#shape">shape</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Button"> <span class="title "> <a href="Button.html">Button</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Button#active"><a href="Button.html#active">active</a></li> <li class="parent " data-name="Button#disabled"><a href="Button.html#disabled">disabled</a></li> <li class="parent " data-name="Button#iconColor"><a href="Button.html#iconColor">iconColor</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Button#capture"><a href="Button.html#capture">capture</a></li> <li class="parent " data-name="Button#hide"><a href="Button.html#hide">hide</a></li> <li class="parent " data-name="Button#layout"><a href="Button.html#layout">layout</a></li> <li class="parent " data-name="Button#show"><a href="Button.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ButtonGroup"> <span class="title "> <a href="ButtonGroup.html">ButtonGroup</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="ButtonGroup#disabled"><a href="ButtonGroup.html#disabled">disabled</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="ButtonGroup#hide"><a href="ButtonGroup.html#hide">hide</a></li> <li class="parent " data-name="ButtonGroup#layout"><a href="ButtonGroup.html#layout">layout</a></li> <li class="parent " data-name="ButtonGroup#show"><a href="ButtonGroup.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="DeepZoomImage"> <span class="title "> <a href="DeepZoomImage.html">DeepZoomImage</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="DeepZoomImage#baseSize"><a href="DeepZoomImage.html#baseSize">baseSize</a></li> <li class="parent " data-name="DeepZoomImage#foreground"><a href="DeepZoomImage.html#foreground">foreground</a></li> <li class="parent " data-name="DeepZoomImage#height"><a href="DeepZoomImage.html#height">height</a></li> <li class="parent " data-name="DeepZoomImage#maxScale"><a href="DeepZoomImage.html#maxScale">maxScale</a></li> <li class="parent " data-name="DeepZoomImage#pixelSize"><a href="DeepZoomImage.html#pixelSize">pixelSize</a></li> <li class="parent " data-name="DeepZoomImage#width"><a href="DeepZoomImage.html#width">width</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="DeepZoomImage#_calculateBounds"><a href="DeepZoomImage.html#_calculateBounds">_calculateBounds</a></li> <li class="parent " data-name="DeepZoomImage#_createTiles"><a href="DeepZoomImage.html#_createTiles">_createTiles</a></li> <li class="parent " data-name="DeepZoomImage#activate"><a href="DeepZoomImage.html#activate">activate</a></li> <li class="parent " data-name="DeepZoomImage#addTiles"><a href="DeepZoomImage.html#addTiles">addTiles</a></li> <li class="parent " data-name="DeepZoomImage#allTiles"><a href="DeepZoomImage.html#allTiles">allTiles</a></li> <li class="parent " data-name="DeepZoomImage#bringTilesToFront"><a href="DeepZoomImage.html#bringTilesToFront">bringTilesToFront</a></li> <li class="parent " data-name="DeepZoomImage#calculateBounds"><a href="DeepZoomImage.html#calculateBounds">calculateBounds</a></li> <li class="parent " data-name="DeepZoomImage#changedTiles"><a href="DeepZoomImage.html#changedTiles">changedTiles</a></li> <li class="parent " data-name="DeepZoomImage#deactivate"><a href="DeepZoomImage.html#deactivate">deactivate</a></li> <li class="parent " data-name="DeepZoomImage#destroyObsoleteTiles"><a href="DeepZoomImage.html#destroyObsoleteTiles">destroyObsoleteTiles</a></li> <li class="parent " data-name="DeepZoomImage#destroyTiles"><a href="DeepZoomImage.html#destroyTiles">destroyTiles</a></li> <li class="parent " data-name="DeepZoomImage#destroyTilesAboveLevel"><a href="DeepZoomImage.html#destroyTilesAboveLevel">destroyTilesAboveLevel</a></li> <li class="parent " data-name="DeepZoomImage#destroyUnneededTiles"><a href="DeepZoomImage.html#destroyUnneededTiles">destroyUnneededTiles</a></li> <li class="parent " data-name="DeepZoomImage#ensureAllTiles"><a href="DeepZoomImage.html#ensureAllTiles">ensureAllTiles</a></li> <li class="parent " data-name="DeepZoomImage#ensureTiles"><a href="DeepZoomImage.html#ensureTiles">ensureTiles</a></li> <li class="parent " data-name="DeepZoomImage#levelAndAlphaForScale"><a href="DeepZoomImage.html#levelAndAlphaForScale">levelAndAlphaForScale</a></li> <li class="parent " data-name="DeepZoomImage#levelForScale"><a href="DeepZoomImage.html#levelForScale">levelForScale</a></li> <li class="parent " data-name="DeepZoomImage#neededTiles"><a href="DeepZoomImage.html#neededTiles">neededTiles</a></li> <li class="parent " data-name="DeepZoomImage#populateAllTiles"><a href="DeepZoomImage.html#populateAllTiles">populateAllTiles</a></li> <li class="parent " data-name="DeepZoomImage#populateTiles"><a href="DeepZoomImage.html#populateTiles">populateTiles</a></li> <li class="parent " data-name="DeepZoomImage#setup"><a href="DeepZoomImage.html#setup">setup</a></li> <li class="parent " data-name="DeepZoomImage#setupTiles"><a href="DeepZoomImage.html#setupTiles">setupTiles</a></li> <li class="parent " data-name="DeepZoomImage#thumbnail"><a href="DeepZoomImage.html#thumbnail">thumbnail</a></li> <li class="parent " data-name="DeepZoomImage#tintObsoleteTiles"><a href="DeepZoomImage.html#tintObsoleteTiles">tintObsoleteTiles</a></li> <li class="parent " data-name="DeepZoomImage#transformed"><a href="DeepZoomImage.html#transformed">transformed</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="DeepZoomInfo"> <span class="title "> <a href="DeepZoomInfo.html">DeepZoomInfo</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="DeepZoomInfo#dimensions"><a href="DeepZoomInfo.html#dimensions">dimensions</a></li> <li class="parent " data-name="DeepZoomInfo#getDimensions"><a href="DeepZoomInfo.html#getDimensions">getDimensions</a></li> <li class="parent " data-name="DeepZoomInfo#getNumTiles"><a href="DeepZoomInfo.html#getNumTiles">getNumTiles</a></li> <li class="parent " data-name="DeepZoomInfo#getScale"><a href="DeepZoomInfo.html#getScale">getScale</a></li> <li class="parent " data-name="DeepZoomInfo#imageForURL"><a href="DeepZoomInfo.html#imageForURL">imageForURL</a></li> <li class="parent " data-name="DeepZoomInfo#urlForTile"><a href="DeepZoomInfo.html#urlForTile">urlForTile</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Flippable"> <span class="title "> <a href="Flippable.html">Flippable</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Flippable#flipped"><a href="Flippable.html#flipped">flipped</a></li> <li class="parent " data-name="Flippable#frontSideInFront"><a href="Flippable.html#frontSideInFront">frontSideInFront</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Flippable#layout"><a href="Flippable.html#layout">layout</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="FontInfo"> <span class="title "> <a href="FontInfo.html">FontInfo</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Hypenate"> <span class="title "> <a href="Hypenate.html">Hypenate</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Hypenate.splitLines"><a href="Hypenate.html#.splitLines">splitLines</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="InteractivePopup"> <span class="title "> <a href="InteractivePopup.html">InteractivePopup</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="InteractivePopup#content"><a href="InteractivePopup.html#content">content</a></li> <li class=" " data-name="InteractivePopup#header"><a href="InteractivePopup.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="InteractivePopup#hide"><a href="InteractivePopup.html#hide">hide</a></li> <li class="parent " data-name="InteractivePopup#layout"><a href="InteractivePopup.html#layout">layout</a></li> <li class=" " data-name="InteractivePopup#show"><a href="InteractivePopup.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LabeledGraphics"> <span class="title "> <a href="LabeledGraphics.html">LabeledGraphics</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="LabeledGraphics#clear"><a href="LabeledGraphics.html#clear">clear</a></li> <li class="parent " data-name="LabeledGraphics#debugInfos"><a href="LabeledGraphics.html#debugInfos">debugInfos</a></li> <li class="parent " data-name="LabeledGraphics#ensureLabel"><a href="LabeledGraphics.html#ensureLabel">ensureLabel</a></li> <li class="parent " data-name="LabeledGraphics#getLabel"><a href="LabeledGraphics.html#getLabel">getLabel</a></li> <li class="parent " data-name="LabeledGraphics#hideLabel"><a href="LabeledGraphics.html#hideLabel">hideLabel</a></li> <li class="parent " data-name="LabeledGraphics#removeLabel"><a href="LabeledGraphics.html#removeLabel">removeLabel</a></li> <li class="parent " data-name="LabeledGraphics#truncateLabel"><a href="LabeledGraphics.html#truncateLabel">truncateLabel</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="LabeledGraphics.exports.LabeledGraphics"> <span class="title "> <a href="LabeledGraphics.exports.LabeledGraphics.html">LabeledGraphics.exports.LabeledGraphics</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="List"> <span class="title "> <a href="List.html">List</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="List#innerHeight"><a href="List.html#innerHeight">innerHeight</a></li> <li class="parent " data-name="List#innerWidth"><a href="List.html#innerWidth">innerWidth</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="List#capture"><a href="List.html#capture">capture</a></li> <li class="parent " data-name="List#layout"><a href="List.html#layout">layout</a></li> <li class="parent " data-name="List#resize"><a href="List.html#resize">resize</a></li> <li class="parent " data-name="List#setItems"><a href="List.html#setItems">setItems</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Message"> <span class="title "> <a href="Message.html">Message</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="Message#content"><a href="Message.html#content">content</a></li> <li class=" " data-name="Message#header"><a href="Message.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="Message#hide"><a href="Message.html#hide">hide</a></li> <li class="parent " data-name="Message#layout"><a href="Message.html#layout">layout</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="MessageInteractivePopup"> <span class="title "> <a href="MessageInteractivePopup.html">MessageInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="MessageMessageInteractivePopup"> <span class="title "> <a href="MessageMessageInteractivePopup.html">MessageMessageInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Modal"> <span class="title "> <a href="Modal.html">Modal</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Modal#content"><a href="Modal.html#content">content</a></li> <li class="parent " data-name="Modal#header"><a href="Modal.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Modal#hide"><a href="Modal.html#hide">hide</a></li> <li class="parent " data-name="Modal#layout"><a href="Modal.html#layout">layout</a></li> <li class="parent " data-name="Modal#show"><a href="Modal.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ModalInteractivePopup"> <span class="title "> <a href="ModalInteractivePopup.html">ModalInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ModalModalInteractivePopup"> <span class="title "> <a href="ModalModalInteractivePopup.html">ModalModalInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PIXIApp"> <span class="title "> <a href="PIXIApp.html">PIXIApp</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="PIXIApp#center"><a href="PIXIApp.html#center">center</a></li> <li class="parent " data-name="PIXIApp#size"><a href="PIXIApp.html#size">size</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="PIXIApp#addFpsDisplay"><a href="PIXIApp.html#addFpsDisplay">addFpsDisplay</a></li> <li class="parent " data-name="PIXIApp#checkOrientation"><a href="PIXIApp.html#checkOrientation">checkOrientation</a></li> <li class="parent " data-name="PIXIApp#convertPointFromNodeToPage"><a href="PIXIApp.html#convertPointFromNodeToPage">convertPointFromNodeToPage</a></li> <li class="parent " data-name="PIXIApp#convertPointFromPageToNode"><a href="PIXIApp.html#convertPointFromPageToNode">convertPointFromPageToNode</a></li> <li class="parent " data-name="PIXIApp#draw"><a href="PIXIApp.html#draw">draw</a></li> <li class="parent " data-name="PIXIApp#expandRenderer"><a href="PIXIApp.html#expandRenderer">expandRenderer</a></li> <li class="parent " data-name="PIXIApp#layout"><a href="PIXIApp.html#layout">layout</a></li> <li class="parent " data-name="PIXIApp#loadSprites"><a href="PIXIApp.html#loadSprites">loadSprites</a></li> <li class="parent " data-name="PIXIApp#loadTextures"><a href="PIXIApp.html#loadTextures">loadTextures</a></li> <li class="parent " data-name="PIXIApp#message"><a href="PIXIApp.html#message">message</a></li> <li class="parent " data-name="PIXIApp#modal"><a href="PIXIApp.html#modal">modal</a></li> <li class="parent " data-name="PIXIApp#mutate"><a href="PIXIApp.html#mutate">mutate</a></li> <li class="parent " data-name="PIXIApp#orientation"><a href="PIXIApp.html#orientation">orientation</a></li> <li class="parent " data-name="PIXIApp#orientationChanged"><a href="PIXIApp.html#orientationChanged">orientationChanged</a></li> <li class="parent " data-name="PIXIApp#progress"><a href="PIXIApp.html#progress">progress</a></li> <li class="parent " data-name="PIXIApp#query"><a href="PIXIApp.html#query">query</a></li> <li class="parent " data-name="PIXIApp#resize"><a href="PIXIApp.html#resize">resize</a></li> <li class="parent " data-name="PIXIApp#setup"><a href="PIXIApp.html#setup">setup</a></li> <li class="parent " data-name="PIXIApp#subscribe"><a href="PIXIApp.html#subscribe">subscribe</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Popup"> <span class="title "> <a href="Popup.html">Popup</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="Popup#content"><a href="Popup.html#content">content</a></li> <li class=" " data-name="Popup#header"><a href="Popup.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="Popup#hide"><a href="Popup.html#hide">hide</a></li> <li class=" " data-name="Popup#layout"><a href="Popup.html#layout">layout</a></li> <li class=" " data-name="Popup#show"><a href="Popup.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupInteractivePopup"> <span class="title "> <a href="PopupInteractivePopup.html">PopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupMenu"> <span class="title "> <a href="PopupMenu.html">PopupMenu</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="PopupMenu#content"><a href="PopupMenu.html#content">content</a></li> <li class=" " data-name="PopupMenu#header"><a href="PopupMenu.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="PopupMenu#hide"><a href="PopupMenu.html#hide">hide</a></li> <li class=" " data-name="PopupMenu#layout"><a href="PopupMenu.html#layout">layout</a></li> <li class=" " data-name="PopupMenu#show"><a href="PopupMenu.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupMenuPopupInteractivePopup"> <span class="title "> <a href="PopupMenuPopupInteractivePopup.html">PopupMenuPopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupMenuPopupMenuPopupInteractivePopup"> <span class="title "> <a href="PopupMenuPopupMenuPopupInteractivePopup.html">PopupMenuPopupMenuPopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupMenuPopupMenuPopupPopupInteractivePopup"> <span class="title "> <a href="PopupMenuPopupMenuPopupPopupInteractivePopup.html">PopupMenuPopupMenuPopupPopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupMenuPopupPopupInteractivePopup"> <span class="title "> <a href="PopupMenuPopupPopupInteractivePopup.html">PopupMenuPopupPopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="PopupPopupInteractivePopup"> <span class="title "> <a href="PopupPopupInteractivePopup.html">PopupPopupInteractivePopup</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Progress"> <span class="title "> <a href="Progress.html">Progress</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Progress#progress"><a href="Progress.html#progress">progress</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Progress#hide"><a href="Progress.html#hide">hide</a></li> <li class="parent " data-name="Progress#layout"><a href="Progress.html#layout">layout</a></li> <li class="parent " data-name="Progress#show"><a href="Progress.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Scrollview"> <span class="title "> <a href="Scrollview.html">Scrollview</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Scrollview#layout"><a href="Scrollview.html#layout">layout</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Slider"> <span class="title "> <a href="Slider.html">Slider</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Slider#disabled"><a href="Slider.html#disabled">disabled</a></li> <li class="parent " data-name="Slider#value"><a href="Slider.html#value">value</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Slider#hide"><a href="Slider.html#hide">hide</a></li> <li class="parent " data-name="Slider#layout"><a href="Slider.html#layout">layout</a></li> <li class="parent " data-name="Slider#show"><a href="Slider.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Switch"> <span class="title "> <a href="Switch.html">Switch</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="Switch#active"><a href="Switch.html#active">active</a></li> <li class="parent " data-name="Switch#disabled"><a href="Switch.html#disabled">disabled</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Switch#hide"><a href="Switch.html#hide">hide</a></li> <li class="parent " data-name="Switch#layout"><a href="Switch.html#layout">layout</a></li> <li class="parent " data-name="Switch#show"><a href="Switch.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="TextLabel.TextLabel"> <span class="title "> <a href="TextLabel.TextLabel.html">TextLabel.TextLabel</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Theme"> <span class="title "> <a href="Theme.html">Theme</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Theme.fromString"><a href="Theme.html#.fromString">fromString</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ThemeDark"> <span class="title "> <a href="ThemeDark.html">ThemeDark</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ThemeLight"> <span class="title "> <a href="ThemeLight.html">ThemeLight</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="ThemeRed"> <span class="title "> <a href="ThemeRed.html">ThemeRed</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="TileQuadNode"> <span class="title "> <a href="TileQuadNode.html">TileQuadNode</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="TileQuadNode#link"><a href="TileQuadNode.html#link">link</a></li> <li class="parent " data-name="TileQuadNode#noQuads"><a href="TileQuadNode.html#noQuads">noQuads</a></li> <li class="parent " data-name="TileQuadNode#unlink"><a href="TileQuadNode.html#unlink">unlink</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Tooltip"> <span class="title "> <a href="Tooltip.html">Tooltip</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class=" " data-name="Tooltip#content"><a href="Tooltip.html#content">content</a></li> <li class=" " data-name="Tooltip#header"><a href="Tooltip.html#header">header</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class=" " data-name="Tooltip#hide"><a href="Tooltip.html#hide">hide</a></li> <li class=" " data-name="Tooltip#layout"><a href="Tooltip.html#layout">layout</a></li> <li class=" " data-name="Tooltip#show"><a href="Tooltip.html#show">show</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="UITest"> <span class="title "> <a href="UITest.html">UITest</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li class="parent " data-name="UITest#timeline"><a href="UITest.html#timeline">timeline</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="UITest#clear"><a href="UITest.html#clear">clear</a></li> <li class="parent " data-name="UITest#pan"><a href="UITest.html#pan">pan</a></li> <li class="parent " data-name="UITest#pinch"><a href="UITest.html#pinch">pinch</a></li> <li class="parent " data-name="UITest#restart"><a href="UITest.html#restart">restart</a></li> <li class="parent " data-name="UITest#start"><a href="UITest.html#start">start</a></li> <li class="parent " data-name="UITest#stop"><a href="UITest.html#stop">stop</a></li> <li class="parent " data-name="UITest#tap"><a href="UITest.html#tap">tap</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Volatile"> <span class="title "> <a href="Volatile.html">Volatile</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li class="parent " data-name="Volatile#layout"><a href="Volatile.html#layout">layout</a></li> </ul> <ul class="events itemMembers"> </ul> </li> </ul> </div> <div class="main"> <h1 class="page-title" data-filename="pixi_list.js.html">Source: pixi/list.js</h1> <section> <header> <div class="header content-size"> <h2>pixi/list.js</h2> </div> </header> <article> <pre id="source-code" class="prettyprint source linenums"><code>/* globals */ /* Imports */ import Events from '../events.js' /** * Class that represents a PixiJS List. * * @example * const elephant1 = PIXI.Sprite.fromImage('./assets/elephant-1.jpg') * const elephant2 = PIXI.Sprite.fromImage('./assets/elephant-2.jpg') * * // Create the list * const list = new List([elephant1, elephant2]) * * app.scene.addChild(list) * * @class * @extends PIXI.Container * @see {@link http://pixijs.download/dev/docs/PIXI.Container.html|PixiJS Container} * @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/list.html|DocTest} */ export default class List extends PIXI.Container { /** * Creates an instance of a Flippable. * * @constructor * @param {PIXI.DisplayObject[]} items - An array of PIXI.DisplayObjects. * @param {object} [opts] - An options object which can contain the following properties. * @param {number} [opts.width] - The width of the list. If the items are larger than this width, the overflow * will be hidden. * @param {number} [opts.height] - The height of the list. If the items are larger than this height, the overflow * will be hidden. * @param {number} [opts.padding=10] - The inner spacing (distance from one item to the previous/next item). * @param {number} [opts.margin=10] - The outer spacing (distance from one item to the border). * @param {string} [opts.orientation=vertical] - The orientation of the button group. Can be horizontal or vertical. * @param {string} [opts.align=left] - The horizontal position of the items. Possible values are * left, center and right. * @param {string} [opts.verticalAlign=middle] - The vertical position of the items. Possible values are * top, middle and bottom. * @param {PIXI.Application} [opts.app] - The PixiJS Application. Must be set if you want to use the mousewheel to * scroll your list. */ constructor(items = [], opts = {}) { super() this.opts = Object.assign({}, { padding: 10, margin: 10, orientation: 'vertical', align: 'left', verticalAlign: 'middle', width: null, height: null, app: null }, opts) this.__items = items this.__dragging = false // setup //-------------------- this.setup() } /** * Creates children and instantiates everything. * * @private * @return {List} A reference to the list for chaining. */ setup() { // inner container //-------------------- const container = new PIXI.Container() this.addChild(container) this.container = container // mask //-------------------- const mask = new PIXI.Graphics() this.addChild(mask) this.__mask = mask // add items //-------------------- for(let item of this.__items) { container.addChild(item) } // interaction //-------------------- this.interactive = this.opts.width || this.opts.height this.on('pointerdown', this.onStart.bind(this)) this.on('pointermove', this.onMove.bind(this)) this.on('pointerup', this.onEnd.bind(this)) this.on('pointercancel', this.onEnd.bind(this)) this.on('pointerout', this.onEnd.bind(this)) this.on('pointerupoutside', this.onEnd.bind(this)) this.on('scroll', this.onScroll.bind(this)) // mousewheel //-------------------- if (this.opts.app) { const app = this.opts.app app.view.addEventListener('mousewheel', event => { const bounds = this.mask ? this.mask.getBounds() : this.getBounds() const x = event.clientX - app.view.getBoundingClientRect().left const y = event.clientY - app.view.getBoundingClientRect().top if (bounds.contains(x, y)) { event.preventDefault() this.emit('scroll', event) } }) } this.layout() return this } /** * Replaces the existing items and relayouts the list. * * @param {PIXI.DisplayObject[]} items - An array of PIXI.DisplayObjects. * @return {List} A reference to the list for chaining. */ setItems(items) { this.container.removeChildren() this.__items = items for(let item of this.__items) { this.container.addChild(item) } this.layout() } /** * Should be called to refresh the layout of the list (the width or the height). * * @return {List} A reference to the list for chaining. */ layout() { const margin = this.opts.margin let x = margin let y = margin for (let item of this.__items) { item.x = x item.y = y if (this.opts.orientation === 'vertical') { y += item.height + this.opts.padding } else { x += item.width + this.opts.padding } } // vertical //-------------------- if (this.opts.orientation === 'vertical') { switch (this.opts.align) { case 'center': this.__items.forEach(it => it.x = margin + this.width / 2 - it.width / 2) break case 'right': this.__items.forEach(it => it.x = margin + this.width - it.width) break default: this.__items.forEach(it => it.x = margin) break } if (this.opts.height) { const mask = this.__mask mask.clear() mask.beginFill(0x000) mask.drawRect(0, 0, this.width + 2 * margin, this.opts.height) this.mask = mask this.interactive = this.innerHeight > this.opts.height } } // horizontal //-------------------- if (this.opts.orientation === 'horizontal') { switch (this.opts.verticalAlign) { case 'top': this.__items.forEach(it => it.y = margin) break case 'bottom': this.__items.forEach(it => it.y = margin + this.height - it.height) break default: this.__items.forEach(it => it.y = margin + this.height / 2 - it.height / 2) break } if (this.opts.width) { const mask = this.__mask mask.clear() mask.beginFill(0x000) mask.drawRect(0, 0, this.opts.width, this.height + 2 * margin) this.mask = mask this.interactive = this.innerWidth > this.opts.width } } return this } /** * */ get innerWidth() { let size = 0 this.__items.forEach(it => size += it.width) size += this.opts.padding * (this.__items.length - 1) size += 2 * this.opts.margin return size } /** * */ get innerHeight() { let size = 0 this.__items.forEach(it => size += it.height) size += this.opts.padding * (this.__items.length - 1) size += 2 * this.opts.margin return size } /** * Resizes the list. * * @param {number} widthOrHeight - The new width (if orientation is horizontal) or height (if orientation is vertical) of the list. */ resize(widthOrHeight) { if (this.opts.orientation === 'horizontal') { this.opts.width = widthOrHeight } else { this.opts.height = widthOrHeight } this.layout() } /** * * @private * @param {*} event */ onStart(event) { this.__dragging = true this.capture(event) this.__delta = { x: this.container.position.x - event.data.global.x, y: this.container.position.y - event.data.global.y } TweenLite.killTweensOf(this.container.position, {x: true, y: true}) if (typeof ThrowPropsPlugin != "undefined") { ThrowPropsPlugin.track(this.container.position, 'x,y') } } /** * * @private * @param {*} event */ onMove(event) { if (this.__dragging) { this.capture(event) if (this.opts.orientation === 'horizontal') { this.container.position.x = event.data.global.x + this.__delta.x } else { this.container.position.y = event.data.global.y + this.__delta.y } } } /** * * @private * @param {*} event */ onEnd(event) { if (this.__dragging) { this.__dragging = false this.capture(event) const throwProps = {} if (this.opts.orientation === 'horizontal') { let min = this.opts.width - this.innerWidth min = min > 0 ? 0 : min throwProps.x = { velocity: 'auto', min, max: 0 } } else { let min = this.opts.height - this.innerHeight min = min > 0 ? 0 : min throwProps.y = { velocity: 'auto', min, max: 0 } } if (typeof ThrowPropsPlugin != "undefined") { ThrowPropsPlugin.to(this.container.position, { throwProps, ease: Strong.easeOut, onComplete: () => ThrowPropsPlugin.untrack(this.container.position) }, .8, .4) } } } /** * * @private * @param {*} event */ onScroll(event) { this.capture(event) if (this.opts.orientation === 'horizontal') { this.container.position.x -= event.deltaX if (this.container.position.x > 0) { this.container.position.x = 0 } else if (this.container.position.x + this.innerWidth < this.opts.width) { this.container.position.x = this.opts.width - this.innerWidth } } else { this.container.position.y -= event.deltaY if (this.container.position.y > 0) { this.container.position.y = 0 } else if (this.container.position.y + this.innerHeight < this.opts.height) { this.container.position.y = this.opts.height - this.innerHeight } } } /** * Captures an event to inform InteractionMapper about processed events. * * @param {event|PIXI.InteractionEvent} event - The PIXI event to capture. */ capture(event) { const originalEvent = event.data && event.data.originalEvent ? event.data.originalEvent : event Events.capturedBy(originalEvent, this) } } </code></pre> </article> </section> <footer class="content-size"> <div class="footer"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> on Tue May 14 2019 14:29:52 GMT+0200 (Mitteleuropäische Sommerzeit) </div> </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/main.js"></script> </body> </html>