<!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> <li class="parent " data-name="ButtonGroup#maxHeight"><a href="ButtonGroup.html#maxHeight">maxHeight</a></li> <li class="parent " data-name="ButtonGroup#maxWidth"><a href="ButtonGroup.html#maxWidth">maxWidth</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#capture"><a href="ButtonGroup.html#capture">capture</a></li> <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_labeledgraphics.js.html">Source: pixi/labeledgraphics.js</h1> <section> <header> <div class="header content-size"> <h2>pixi/labeledgraphics.js</h2> </div> </header> <article> <pre id="source-code" class="prettyprint source linenums"><code>/** * Defines usefull default text styles. */ export class FontInfo { static get small() { return app.theme.textStyleSmall } static get normal() { return app.theme.textStyle } static get centered() { return Object.assign({}, app.theme.textStyle, { align: 'center' }) } } /** * Static methods to support hyphenation of lines. * * @class Hypenate */ export class Hypenate { static splitPart(part) { let parts = part.split('-') if (parts.length == 1) return [part] let result = [] let last = parts.pop() for (let p of parts) { result.push(p + '-') } result.push(last) return result.filter(p => p.length > 0) } static splitWord(word) { if (typeof language == 'undefined') { if (word.indexOf('-') > -1) { return word.split('-') } return [word] } let parts = language.hyphenate(word) let result = [] for (let part of parts) { for (let splitted of this.splitPart(part)) { result.push(splitted) } } return result } static abbreviateLine(label, style, width) { const pixiStyle = new PIXI.TextStyle(style) let metrics = PIXI.TextMetrics.measureText(label, pixiStyle) while (metrics.width > width && label.length > 3) { label = label.slice(0, label.length - 1) metrics = PIXI.TextMetrics.measureText(label, pixiStyle) } label = label.slice(0, label.length - 1) return label + '…' } static splitLine(line, pixiStyle, width, space, minus) { let x = 0 let result = '' let words = line.split(' ') for (let word of words) { let wordMetrics = PIXI.TextMetrics.measureText(word, pixiStyle) if (x + wordMetrics.width >= width) { let parts = this.splitWord(word) let newWord = '' if (parts.length == 1) { newWord += '\n' + word + ' ' x = wordMetrics.width + space.width } else { let first = true let lastPart = '' for (let part of parts) { let partMetrics = PIXI.TextMetrics.measureText(part, pixiStyle) if (x + partMetrics.width + space.width > width) { newWord += (first || lastPart.endsWith('-') ? '\n' : '-\n') + part x = partMetrics.width } else { newWord += part x += partMetrics.width } lastPart = part first = false } x += space.width } result += newWord + ' ' } else { result += word + ' ' x += wordMetrics.width + space.width } } return result } /** * Main method and entry point for text hyphenation * * @static * @param {*} text * @param {*} style * @param {*} width * @memberof Hypenate * @returns {string} */ static splitLines(text, style, width) { const pixiStyle = new PIXI.TextStyle(style) const lines = text.split('\n') const space = PIXI.TextMetrics.measureText(' ', pixiStyle) const minus = PIXI.TextMetrics.measureText('-', pixiStyle) let result = [] for (let line of lines) { result.push(this.splitLine(line, pixiStyle, width, space, minus)) } return result.join('\n') } } class TextLabel extends PIXI.Text { /** *Creates an instance of TextLabel. * @param {string} text - The string that you would like the text to display * @param {object|PIXI.TextStyle} [style] - The style parameters * @param {canvas} * @memberof TextLabel */ constructor(text, style = null, canvas = null, { minZoom = 0.1, maxZoom = 10 } = {}) { super(text, style, canvas) this.normFontSize = this.style.fontSize this.minZoom = minZoom this.maxZoom = maxZoom } zoom(factor) { let oldValue = parseFloat(this.style.fontSize) / this.normFontSize let value = oldValue * factor this.setZoom(value) } setZoom(value) { let oldValue = parseFloat(this.style.fontSize) / this.normFontSize if (value > this.maxZoom) { value = this.maxZoom } if (value < this.minZoom) { value = this.minZoom } if (value != oldValue) { this.style.fontSize = Math.max(value * this.normFontSize, 1) } } setZoomAndScale(scale) { this.scale.set(1 / scale) this.setZoom(scale) } } /** * A specialization of the PIXI.Graphics class that allows to * resuse and place labels across different layout variants * * @export * @class LabeledGraphics * @extends {PIXI.Graphics} */ export class LabeledGraphics extends PIXI.Graphics { /** * Creates an instance of LabeledGraphics and defines a local label cache. * * @memberof LabeledGraphics */ constructor() { super() this.labels = new Map() } _createText(label, fontInfo) { return new TextLabel(label, fontInfo) } /** * Main additional method. Ensures that a text object is created that is cached * under the given key. * * @param {*} key - The cache key * @param {*} label - The label to show * @param {*} [attrs={}] - Defines attributes of the text object. * align: 'right', 'left', or 'center' * justify: 'top', 'bottom', or 'center' * maxLines: {integer} truncates the text and adds ellipsis * maxHeight: {number} truncates text that needs more space and adds ellipsis * maxWidth: {number} word wraps text using hyphenation if possible * @param {*} [fontInfo=FontInfo.normal] - Defines PIXI.TextStyle attributes * @returns {PIXI.Text} - instance * @memberof LabeledGraphics */ ensureLabel(key, label, attrs = {}, fontInfo = FontInfo.normal) { if (attrs.maxWidth && attrs.maxLines == 1) { label = Hypenate.abbreviateLine(label, fontInfo, attrs.maxWidth) } else { if (attrs.maxWidth) { label = Hypenate.splitLines(label, fontInfo, attrs.maxWidth) } if (attrs.maxLines) { label = this.truncateLabel(label, fontInfo, attrs.maxLines) } if (attrs.maxHeight) { let styleInfo = new PIXI.TextStyle(fontInfo) let metrics = PIXI.TextMetrics.measureText(label, styleInfo) let maxLines = Math.max(attrs.maxHeight / metrics.lineHeight, 1) label = this.truncateLabel(label, fontInfo, maxLines) } } if (!this.labels.has(key)) { let text = this._createText(label, fontInfo) this.labels.set(key, text) this.addChild(text) } let text = this.labels.get(key) for (let k in attrs) { text[k] = attrs[k] } if (label != text.text) text.text = label // We do not follow the flexbox jargon and use align for x and justify for y axis // This deviation is needed to ensure backward compatability switch (attrs.justify || null) { case 'top': text.anchor.y = 0 break case 'bottom': text.anchor.x = 1 break default: text.anchor.y = 0.5 break } switch (attrs.align) { case 'right': text.anchor.x = 1 break case 'center': text.anchor.x = 0.5 break default: text.anchor.x = 0 break } text.visible = true return text } /** * Private method that truncates the text and adds an ellipsis if there are more lines * than wanted * * @param {*} text * @param {*} style * @param {*} [maxLines=Infinity] * @returns {string} * @memberof LabeledGraphics */ truncateLabel(text, style, maxLines = Infinity) { if (maxLines === Infinity) { return text } const { wordWrapWidth } = style const pixiStyle = new PIXI.TextStyle(style) const { lines } = PIXI.TextMetrics.measureText(text, pixiStyle) let newText = text if (lines.length > maxLines) { const truncatedLines = lines.slice(0, maxLines) const lastLine = truncatedLines[truncatedLines.length - 1] const words = lastLine.split(' ') const wordMetrics = PIXI.TextMetrics.measureText(`\u00A0\n...\n${words.join('\n')}`, pixiStyle) const [spaceLength, dotsLength, ...wordLengths] = wordMetrics.lineWidths const { text: newLastLine } = wordLengths.reduce( (data, wordLength, i) => { if (data.length + wordLength + spaceLength >= wordWrapWidth) { return { ...data, length: wordWrapWidth } } return { text: `${data.text}${i > 0 ? ' ' : ''}${words[i]}`, length: data.length + wordLength + spaceLength } }, { text: '', length: dotsLength } ) truncatedLines[truncatedLines.length - 1] = `${newLastLine}...` newText = truncatedLines.join('\n') } return newText } /** * Returns the label for the given key. * * @param {*} key * @returns {Object} * @memberof LabeledGraphics */ getLabel(key) { return this.labels.get(key) } /** * Hides the label with the given key. * @param {*} key * @memberof LabeledGraphics */ hideLabel(key) { let label = this.labels.get(key) if (label) { label.visible = false } } /** * Removes the label with the given key. * @param {*} key * @memberof LabeledGraphics */ removeLabel(key) { let label = this.labels.get(key) this.labels.delete(key) label.destroy() } /** * Ensures that labels are hidden on clear. * * @memberof LabeledGraphics */ clear() { super.clear() for (let key of this.labels.keys()) { this.hideLabel(key) } } /** * Logs debugging infos * * @memberof LabeledGraphics */ debugInfos() { console.log({ size: this.labels.size, labels: this.labels }) } } const labelCache = new Map() function getTexture(label, fontInfo = FontInfo.normal) { let key = label + fontInfo.fontFamily + fontInfo.fontSize if (labelCache.has(key)) { return labelCache.get(key) } let expandedFont = Object.assign({}, fontInfo) expandedFont.fontSize *= window.devicePixelRatio let text = new PIXI.Text(label, expandedFont) text.updateText() labelCache.set(key, text.texture) return text.texture } class SpriteLabel extends PIXI.Sprite { constructor(label, fontInfo) { let texture = getTexture(label, fontInfo) super(texture) this.label = label this.fontInfo = fontInfo this.scale.set(0.8 / window.devicePixelRatio) } set text(label) { this.label = label this.texture = getTexture(label, this.fontInfo) } get text() { return this.label } } export class BitmapLabeledGraphics extends LabeledGraphics { _createText(label, fontInfo) { let texture = getTexture(label, fontInfo) return new SpriteLabel(texture) } } </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 Sep 19 2019 13:38:07 GMT+0200 (Mitteleuropäische Sommerzeit) </div> </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/main.js"></script> </body> </html>