<!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_theme.js.html">Source: pixi/theme.js</h1> <section> <header> <div class="header content-size"> <h2>pixi/theme.js</h2> </div> </header> <article> <pre id="source-code" class="prettyprint source linenums"><code>/** * Class that represents a PixiJS Theme. * * @example * // Create the theme * const yellow = new Theme({ * fill: 0xfecd2d, * fillActive: 0xfe9727, * strokeActive: 0xfecd2d, * strokeActiveWidth: 4, * textStyle: { * fill: 0x5ec7f8 * }, * textStyleActive: { * fill: 0x5954d3 * }, * textStyleLarge: { * fontSize: 36 * } * }) * * // Create the app and apply the new theme to it * const app = new PIXIApp({ * view: canvas, * width: 450, * height: 150, * theme: yellow * }).setup().run() * * @class * @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/theme.html|DocTest} */ export default class Theme { /** * Creates an instance of a Theme. * * @constructor * @param {object} [opts] - An options object to specify to style and behaviour of the theme. * @param {number} [opts.margin=10] - The outer spacing (distance to other objects) from the border. * @param {number} [opts.padding=10] - The inner spacing (distance from icon and/or label) to the border. * @param {number} [opts.radius=4] - The radius used when drawing a rounded rectangle. * @param {number} [opts.fast=0.25] - The duration of time when it has to be fast. * @param {number} [opts.normal=0.5] - The duration of time when it has to be normal. * @param {number} [opts.slow=1] - The duration of time when it has to be slow. * @param {number} [opts.primaryColor=0x5ec7f8] - The primary color of the theme. * @param {number} [opts.color1=0x282828] - The first color of the theme. For example used for the background. * @param {number} [opts.color2=0xf6f6f6] - The second color of the theme. For example used for the border. * @param {number} [opts.fill=color1] - The color of the background as a hex value. * @param {number} [opts.fillAlpha=1] - The alpha value of the background. * @param {number} [opts.fillActive=color1] - The color of the background when activated. * @param {number} [opts.fillActiveAlpha=1] - The alpha value of the background when activated. * @param {number} [opts.stroke=color2] - The color of the border as a hex value. * @param {number} [opts.strokeWidth=0.6] - The width of the border in pixel. * @param {number} [opts.strokeAlpha=1] - The alpha value of the border. * @param {number} [opts.strokeActive=color2] - The color of the border when activated. * @param {number} [opts.strokeActiveWidth=0.6] - The width of the border in pixel when activated. * @param {number} [opts.strokeActiveAlpha=1] - The alpha value of the border when activated. * @param {number} [opts.iconColor=color2] - The color of the icon (set by the tint property) as a hex value. * @param {number} [opts.iconColorActive=colorPrimary] - The color of the icon when activated. * @param {number} [opts.background=color1] - The color of a background for a component (e.g. at the Modal class). * @param {object} [opts.textStyle={}] - A textstyle object for the styling of text. See PIXI.TextStyle * for possible options. Default object: * @param {string} [opts.textStyle.fontFamily="Avenir Next", "Open Sans", "Segoe UI", ...] - The font family. * @param {string} [opts.textStyle.fontWeight=400] - The font weight. * @param {number} [opts.textStyle.fontSize=16] - The font size. * @param {number} [opts.textStyle.fill=color2] - The fill color. * @param {number} [opts.textStyle.stroke=color1] - The stroke color. * @param {number} [opts.textStyle.strokeThickness=0] - The thickness of the stroke. * @param {number} [opts.textStyle.miterLimit=1] - The meter limit. * @param {string} [opts.textStyle.lineJoin=round] - The line join. * @param {object} [opts.textStyleActive=textStyle + {fill: primaryColor}] - A textstyle object which is used * for actived text. * @param {object} [opts.textStyleSmall=textStyle + {fontSize: -= 3}] - A textstyle object which is used for * small text. * @param {object} [opts.textStyleSmallActive=textStyleSmall + {fill: primaryColor}] - A textstyle object which * is used for small actived text. * @param {object} [opts.textStyleLarge=textStyle + {fontSize: += 3}] - A textstyle object which is used for * large text. * @param {object} [opts.textStyleLargeActive=textStyleLarge + {fill: primaryColor}] - A textstyle object which * is used for large actived text. */ constructor(opts = {}) { const colorPrimary = opts.primaryColor != null ? opts.primaryColor : 0x5ec7f8 // blue const color1 = opts.color1 != null ? opts.color1 : 0x282828 // black const color2 = opts.color2 != null ? opts.color2 : 0xf6f6f6 // white this.opts = Object.assign( {}, { margin: 12, padding: 12, radius: 4, fast: 0.25, normal: 0.5, slow: 1, primaryColor: colorPrimary, color1: color1, color2: color2, fill: color1, fillAlpha: 1, fillActive: color1, fillActiveAlpha: 1, stroke: color2, strokeWidth: 0.6, strokeAlpha: 1, strokeActive: color2, strokeActiveWidth: 0.6, strokeActiveAlpha: 1, iconColor: color2, iconColorActive: colorPrimary, background: color1 }, opts ) // Set textStyle and variants this.opts.textStyle = Object.assign( {}, { fontFamily: '"Avenir Next", "Open Sans", "Segoe UI", "Roboto", "Helvetica Neue", -apple-system, system-ui, BlinkMacSystemFont, Arial, sans-serif !default', fontWeight: '500', fontSize: 18, fill: color2, stroke: color1, strokeThickness: 0, miterLimit: 1, lineJoin: 'round' }, this.opts.textStyle ) this.opts.textStyleSmall = Object.assign( {}, this.opts.textStyle, { fontSize: this.opts.textStyle.fontSize - 3 }, this.opts.textStyleSmall ) this.opts.textStyleLarge = Object.assign( {}, this.opts.textStyle, { fontSize: this.opts.textStyle.fontSize + 3 }, this.opts.textStyleLarge ) this.opts.textStyleActive = Object.assign( {}, this.opts.textStyle, { fill: this.opts.primaryColor }, this.opts.textStyleActive ) this.opts.textStyleSmallActive = Object.assign( {}, this.opts.textStyleSmall, { fill: this.opts.primaryColor }, this.opts.textStyleSmallActive ) this.opts.textStyleLargeActive = Object.assign( {}, this.opts.textStyleLarge, { fill: this.opts.primaryColor }, this.opts.textStyleLargeActive ) Object.assign(this, this.opts) } /** * Factory function * * @static * @param {string} theme=dark - The name of the theme to load. * @return {Theme} Returns a newly created Theme object. */ static fromString(theme) { if (theme && typeof theme === 'object') { return theme } switch (theme) { case 'light': return new ThemeLight() case 'red': return new ThemeRed() default: return new ThemeDark() } } } /** * Class that represents a PixiJS ThemeDark. * * @example * // Create the app with a new dark theme * const app = new PIXIApp({ * view: canvas, * width: 450, * height: 150, * theme: new ThemeDark() * }).setup().run() * * @class * @extends Theme * @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/theme.html|DocTest} */ export class ThemeDark extends Theme {} /** * Class that represents a PixiJS ThemeLight. * The color1 is set to 0xf6f6f6, color2 to 0x282828. * * @example * // Create the app with a new light theme * const app = new PIXIApp({ * view: canvas, * width: 450, * height: 150, * theme: new ThemeLight() * }).setup().run() * * @class * @extends Theme * @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/theme.html|DocTest} */ export class ThemeLight extends Theme { /** * Creates an instance of a ThemeLight. * * @constructor */ constructor() { super({ color1: 0xf6f6f6, color2: 0x282828 }) } } /** * Class that represents a PixiJS ThemeRed. * The primaryColor is set to 0xd92f31. * * @example * // Create the app with a new red theme * const app = new PIXIApp({ * view: canvas, * width: 450, * height: 150, * theme: new ThemeRed() * }).setup().run() * * @class * @extends Theme * @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/theme.html|DocTest} */ export class ThemeRed extends Theme { /** * Creates an instance of a ThemeRed. * * @constructor */ constructor() { super({ primaryColor: 0xd92f31 }) } } </code></pre> </article> </section> <footer class="content-size"> <div class="footer"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Jul 18 2019 12:16:18 GMT+0200 (Mitteleuropäische Sommerzeit) </div> </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/main.js"></script> </body> </html>