@caspingus/lt

Version:

A utility library of helpers and extensions useful when working with Learnosity APIs.

michaelsharman.github.io/LT/

3 lines • 46.5 kB

HTML

<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="./src/assets/images/favicon.ico"><meta name="author" content="Michael Sharman"><meta name="description" content="A utility library of helper modules and extensions that may be useful if you're developing with Learnosity APIs."><title>Module: activity</title><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://michaelsharman.github.io/LT/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="logo"><a href="/LT/index.html"><img src="./src/assets/docs/images/lt-logo.svg" alt="Learnosity Toolkit logo"></a><span class="sr-only">Learnosity Toolkit</span></div><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-authoring core"><div>Authoring Core</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Authoring_App.html">app</a></div><div class="sidebar-section-children"><a href="module-Authoring_Diagnostics.html">diagnostics</a></div><div class="sidebar-section-children"><a href="module-Authoring_Navigation.html">navigation</a></div><div class="sidebar-section-children"><a href="module-Authoring_Widgets.html">widgets</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-authoring extensions"><div>Authoring Extensions</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Authoring_contentTabs.html">contentTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_createTags.html">createTags</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_dynamicContent.html">dynamicContent</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_essayMaxLength.html">essayMaxLength</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_imageUploader.html">imageUploader</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_languageTextDirection.html">languageTextDirection</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_nativeTabs.html">nativeTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_renderPDF.html">renderPDF</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_requiredTags.html">requiredTags</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_singleQuestion.html">singleQuestion</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment core"><div>Assessment Core</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Assessment_Activity.html">activity</a></div><div class="sidebar-section-children"><a href="module-Assessment_App.html">app</a></div><div class="sidebar-section-children"><a href="module-Assessment_Diagnostics.html">diagnostics</a></div><div class="sidebar-section-children"><a href="module-Assessment_Items.html">items</a></div><div class="sidebar-section-children"><a href="module-Assessment_Player.html">player</a></div><div class="sidebar-section-children"><a href="module-Assessment_Questions.html">questions</a></div><div class="sidebar-section-children"><a href="module-Assessment_Sections.html">sections</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment extensions"><div>Assessment Extensions</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Assessment_ariaCountOnNav.html">ariaCountOnNav</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_blockGrammarChecks.html">blockGrammarChecks</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_blueLightFilter.html">blueLightFilter</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_checkAnswerValidation.html">checkAnswerValidation</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_columnResizer.html">columnResizer</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_contentTabs.html">contentTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_disableOnValidate.html">disableOnValidate</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_essayLimitByCharacter.html">essayLimitByCharacter</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_events.html">events</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_hideAlternatives.html">hideAlternatives</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_keyboardShortcuts.html">keyboardShortcuts</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_magnifier.html">magnifier</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_mcqLabelPrefix.html">mcqLabelPrefix</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_networkStatus.html">networkStatus</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_readingMask.html">readingMask</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_renderPDF.html">renderPDF</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_resetResponse.html">resetResponse</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_resources_periodicTable.html">periodicTable</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_toggleTimer.html">toggleTimer</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_whiteNoise.html">whiteNoise</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment themes"><div>Assessment Themes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Assessment_themes_canvas.html">canvas</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_themes_juniorQuest.html">juniorQuest</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/michaelsharman/LT" target="">Github</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/@caspingus/lt" target="">npm</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Assessment/Activity-title" class="has-anchor">Assessment/Activity</h1></header><article><div class="container-overview"><div class="description"><p>Everything relating to the activity currently loaded by Items API.</p></div></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activity">activity<span class="signature">()</span><span class="type-signature"> → {object}</span></h3></div><div class="description"><p>The activity configuration object, including anything overridden at runtime if using activity templates.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">object</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activityId">activityId<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The activity id used for this activity instance used to group related sessions.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activitySubTitle">activitySubTitle<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The visible subtitle from the configuration object.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activityTags">activityTags<span class="signature">()</span><span class="type-signature"> → {array}</span></h3></div><div class="description"><p>All tags that have been set against items in the activity. Requires <code>retrieve_tags</code> to be set to <code>true</code> in the Items API configuration.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.9.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">array</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activityTemplateId">activityTemplateId<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The <code>activity_template_id</code> if templates are used. Returns '' if templates aren't being used.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".activityTitle">activityTitle<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The visible title from the configuration object.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".adaptiveType">adaptiveType<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The adaptive type as defined in the configuration. Returns '' if the activity isn't adaptive.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".annotationsConfig">annotationsConfig<span class="signature">()</span><span class="type-signature"> → {object}</span></h3></div><div class="description"><p>The annotations configuration object.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">object</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".autoSaveConfig">autoSaveConfig<span class="signature">()</span><span class="type-signature"> → {boolean|object}</span></h3></div><div class="description"><p>The auto-save configuration object. Returns <code>true</code> or an object based on what was in the configuration.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span> |<wbr> <span class="param-type">object</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".elapsedTime">elapsedTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h3></div><div class="description"><p>The current elapsed time for the session. Returns whether the timer is visible or not.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.6.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">number</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasActivityTemplate">hasActivityTemplate<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity was loaded from an activity template.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasAnnotations">hasAnnotations<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether annotations have been configured with this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasAnswerMasking">hasAnswerMasking<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity contains answer masking enabled.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.15.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasAutoSave">hasAutoSave<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether auto-save is configured with this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasEvents">hasEvents<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether events have been configured with this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasItemPool">hasItemPool<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether an item pool has been configured with this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasLineReader">hasLineReader<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity contains the line reader at the player level.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.15.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasReadingMode">hasReadingMode<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether reading_mode was configured with this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">3.0.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasResourceItems">hasResourceItems<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity contains resource item(s).</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasSections">hasSections<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity contains sections.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasShuffledItems">hasShuffledItems<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether items have been shuffled within this activity.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".hasTryAgain">hasTryAgain<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether the activity has try again enabled.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">1.4.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".isAdaptive">isAdaptive<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether this activity is adaptive.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".isResuming">isResuming<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether the user is resuming the session.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".isVerticalLayout">isVerticalLayout<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3></div><div class="description"><p>Whether the activity is rendered using the vertical layout. In which case, things like <code>items.item()</code> are not available.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">3.0.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">boolean</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".itemBank">itemBank<span class="signature">()</span><span class="type-signature"> → {number|null}</span></h3></div><div class="description"><p>The global <code>organisation_id</code> used for this activity instance.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">number</span> |<wbr> <span class="param-type">null</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".itemPool">itemPool<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The <code>item_pool_id</code> used for this activity instance.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".maxTime">maxTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h3></div><div class="description"><p>The maximum time allowed for this session. If <code>0</code>, it means unlimited time.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.6.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">number</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".region">region<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>Which UI region the session was set up with. Values include:</p><ul><li><code>main</code></li><li><code>horizontal</code></li><li><code>horizontal-fixed</code></li></ul><p><code>undefined</code> will mean that no <code>regions</code> key was found in the Items API configuration, meaning the player defaults to the legacy UI region (not recommended).</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">1.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".resourceItems">resourceItems<span class="signature">()</span><span class="type-signature"> → {array}</span></h3></div><div class="description"><p>The resource item references used for this activity instance.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">array</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".sessionId">sessionId<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The <code>session_id</code> used for this activity instance.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".state">state<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The current <code>state</code> of this activity instance. Possible values:</p><ul><li><code>initial</code></li><li><code>resume</code></li><li><code>review</code></li><li><code>preview</code></li></ul></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".timeRemaining">timeRemaining<span class="signature">()</span><span class="type-signature"> → {number|null}</span></h3></div><div class="description"><p>The time remaining in the session. If <code>max_time</code> hasn't been set, the session is unlimited, so this returns <code>null</code>.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">2.6.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">number</span> |<wbr> <span class="param-type">null</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".totalItems">totalItems<span class="signature">()</span><span class="type-signature"> → {number}</span></h3></div><div class="description"><p>The total number of items in the activity, including items within sections if relevant.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">number</span></dd></dl></div></dl><hr class="lt-divider"><div class="lt-details"><h3 class="name has-anchor details-item-container" id=".userId">userId<span class="signature">()</span><span class="type-signature"> → {string}</span></h3></div><div class="description"><p>The <code>user_id</code> as defined in the configuration.</p></div><dl class="details bg-none"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since">0.1.0</dd></div></dl><dl class="details bg-none"><div class="details-item-container"><dl class="param-type" style="margin-bottom:0;padding-bottom:0"><dt>Returns: </dt><dd><span class="param-type">string</span></dd></dl></div></dl><hr class="lt-divider"></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="logo"><a href="/LT/index.html"><img src="./src/assets/docs/images/lt-logo.svg" alt="Learnosity Toolkit logo"></a><span class="sr-only">Learnosity Toolkit</span></div><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/michaelsharman/LT" target="">Github</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/@caspingus/lt" target="">npm</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-authoring core"><div>Authoring Core</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Authoring_App.html">app</a></div><div class="sidebar-section-children"><a href="module-Authoring_Diagnostics.html">diagnostics</a></div><div class="sidebar-section-children"><a href="module-Authoring_Navigation.html">navigation</a></div><div class="sidebar-section-children"><a href="module-Authoring_Widgets.html">widgets</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-authoring extensions"><div>Authoring Extensions</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Authoring_contentTabs.html">contentTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_createTags.html">createTags</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_dynamicContent.html">dynamicContent</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_essayMaxLength.html">essayMaxLength</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_imageUploader.html">imageUploader</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_languageTextDirection.html">languageTextDirection</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_nativeTabs.html">nativeTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_renderPDF.html">renderPDF</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_requiredTags.html">requiredTags</a></div><div class="sidebar-section-children"><a href="module-Extensions_Authoring_singleQuestion.html">singleQuestion</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment core"><div>Assessment Core</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Assessment_Activity.html">activity</a></div><div class="sidebar-section-children"><a href="module-Assessment_App.html">app</a></div><div class="sidebar-section-children"><a href="module-Assessment_Diagnostics.html">diagnostics</a></div><div class="sidebar-section-children"><a href="module-Assessment_Items.html">items</a></div><div class="sidebar-section-children"><a href="module-Assessment_Player.html">player</a></div><div class="sidebar-section-children"><a href="module-Assessment_Questions.html">questions</a></div><div class="sidebar-section-children"><a href="module-Assessment_Sections.html">sections</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment extensions"><div>Assessment Extensions</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Assessment_ariaCountOnNav.html">ariaCountOnNav</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_blockGrammarChecks.html">blockGrammarChecks</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_blueLightFilter.html">blueLightFilter</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_checkAnswerValidation.html">checkAnswerValidation</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_columnResizer.html">columnResizer</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_contentTabs.html">contentTabs</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_disableOnValidate.html">disableOnValidate</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_essayLimitByCharacter.html">essayLimitByCharacter</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_events.html">events</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_hideAlternatives.html">hideAlternatives</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_keyboardShortcuts.html">keyboardShortcuts</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_magnifier.html">magnifier</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_mcqLabelPrefix.html">mcqLabelPrefix</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_networkStatus.html">networkStatus</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_readingMask.html">readingMask</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_renderPDF.html">renderPDF</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_resetResponse.html">resetResponse</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_resources_periodicTable.html">periodicTable</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_toggleTimer.html">toggleTimer</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_whiteNoise.html">whiteNoise</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-assessment themes"><div>Assessment Themes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Extensions_Assessment_themes_canvas.html">canvas</a></div><div class="sidebar-section-children"><a href="module-Extensions_Assessment_themes_juniorQuest.html">juniorQuest</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>