npm - @elliemae/pui-scripting-object - Versions diffs - 1.51.3 → 1.55.0 - Mend

@elliemae/pui-scripting-object 1.51.3 → 1.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (514) hide show

package/build/docs/api/index.html ADDED Viewed

@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/index" data-has-hydrated="false">
+<head>
+<meta charset="UTF-8">
+<meta name="generator" content="Docusaurus v3.9.2">
+<title data-rh="true">Scripting Object API | Scripting Object</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/scripting-object/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Scripting Object API | Scripting Object"><meta data-rh="true" name="description" content="Interfaces"><meta data-rh="true" property="og:description" content="Interfaces"><link data-rh="true" rel="icon" href="/scripting-object/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/scripting-object/api/"><link data-rh="true" rel="alternate" href="https://pui.ice.com/scripting-object/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/scripting-object/api/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Scripting Object API","item":"https://pui.ice.com/scripting-object/api/"}]}</script><link rel="stylesheet" href="/scripting-object/assets/css/styles.48d5ef50.css">
+<script src="/scripting-object/assets/js/runtime~main.fab082c7.js" defer="defer"></script>
+<script src="/scripting-object/assets/js/main.07dd8413.js" defer="defer"></script>
+</head>
+<body class="navigation-with-keyboard">
+<svg style="display: none;"><defs>
+<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
+</defs></svg>
+<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_eGlE" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/scripting-object/"><div class="navbar__logo"><img src="/scripting-object/img/logo.svg" alt="Scripting Object" class="themedComponent_Q3jx themedComponent--light_BjHx"><img src="/scripting-object/img/logo.svg" alt="Scripting Object" class="themedComponent_Q3jx themedComponent--dark_mxj9"></div><b class="navbar__title text--truncate">Scripting Object</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/scripting-object/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/scripting-object/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_S6Pl colorModeToggle_L96j"><button class="clean-btn toggleButton_Wf77 toggleButtonDisabled_JaY9" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk lightToggleIcon_X2ll"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk darkToggleIcon_kYIm"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk systemToggleIcon_mG1q"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_dSE1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_vmWZ"><div class="docsWrapper_es0q"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_cO8Y" type="button"></button><div class="docRoot_cyW0"><aside class="theme-doc-sidebar-container docSidebarContainer_yHv_"><div class="sidebarViewport_iaL1"><div class="sidebar_Xoux"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_Qdup"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/scripting-object/"><span title="Getting Started" class="linkLabel_Knm1">Getting Started</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/scripting-object/Objects/analytics"><span title="Objects" class="categoryLinkLabel_I_MP">Objects</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--active" aria-current="page" href="/scripting-object/api/"><span title="Scripting Object API" class="categoryLinkLabel_I_MP">Scripting Object API</span></a><button aria-label="Collapse sidebar category &#x27;Scripting Object API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/scripting-object/api/enumerations/EditModes"><span title="enumerations" class="categoryLinkLabel_I_MP">enumerations</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/scripting-object/api/interfaces/IAnalytics"><span title="interfaces" class="categoryLinkLabel_I_MP">interfaces</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/scripting-object/api/type-aliases/AcceptFile"><span title="type-aliases" class="categoryLinkLabel_I_MP">type-aliases</span></a></div></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_qgvB"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Rp9M"><div class="docItemContainer_reKL"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_L00V" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/scripting-object/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_BtgF"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Scripting Object API</span></li></ul></nav><div class="tocCollapsible_tUTH theme-doc-toc-mobile tocMobile_Bfsw"><button type="button" class="clean-btn tocCollapsibleButton_YuJU">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Scripting Object API</h1></header>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="interfaces">Interfaces<a href="#interfaces" class="hash-link" aria-label="Direct link to Interfaces" title="Direct link to Interfaces" translate="no"></a></h2>
+<table><thead><tr><th>Interface</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/scripting-object/api/interfaces/IAnalytics">IAnalytics</a></td><td>Methods to collect various business analytics &amp; performance related events and report the same</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IApplication">IApplication</a></td><td>Allows access to application-level UI elements, behaviors and events</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IAuth">IAuth</a></td><td>Methods to get information about the user and access token</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IEvent">IEvent</a></td><td>base class for events</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IForm">IForm</a></td><td>Methods to get information about the custom form</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IGlobal">IGlobal</a></td><td>The Global object allows for data to be shared between custom forms/tools/plugins within a user&#x27;s session. Unlike the Session scripting object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables, values written to the Global store are visible to all such customizations</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IHttp">IHttp</a></td><td>Provides methods to make call-outs to to external systems via HTTPS. By exposing this object from the host, it ensures that the call will bear the &quot;Origin&quot; header of the host application. This is critical for situations where the guest&#x27;s code is running in a strict-mode sandbox (where the &quot;allowSameOrigin&quot; flag is false).</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/ILoan">ILoan</a></td><td>Methods &amp; Events for interacting with an open loan in the application</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IMemStorage">IMemStorage</a></td><td>Get or set values in host application javascript memory. Values stored in memory are not persisted across sessions.</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IModule">IModule</a></td><td>Exposes MicroApp module specific methods</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IScriptingObject">IScriptingObject</a></td><td>base type for scripting object</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IScriptingObjectProxy">IScriptingObjectProxy</a></td><td>base type for scripting object proxy</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IService">IService</a></td><td>Scripting object to work with service orders, such as launching a service order integration etc.,</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/ISession">ISession</a></td><td>store and retrieves values in host application&#x27;s session storage</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/IStyling">IStyling</a></td><td>Interface for managing dynamic styling of fields and table rows Allows conditional styling based on field values and criteria</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/ITransaction">ITransaction</a></td><td>Provides your applications lender/borrower-facing view with the necessary handles to model your application&#x27;s transactional interaction with the EPC platform. Allows access to an interactive session&#x27;s origination context, create a new transaction, update an existing transaction, create events/messages for a transaction, and more.</td></tr><tr><td><a class="" href="/scripting-object/api/interfaces/ITransactionTemplate">ITransactionTemplate</a></td><td>Provides application&#x27;s administrator-facing view with the necessary handles for enabling Lender administrators to create transaction request templates, which they can associate with a 1-click/automated ordering business condition set.</td></tr></tbody></table>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="enumerations">Enumerations<a href="#enumerations" class="hash-link" aria-label="Direct link to Enumerations" title="Direct link to Enumerations" translate="no"></a></h2>
+<table><thead><tr><th>Enumeration</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/scripting-object/api/enumerations/EditModes">EditModes</a></td><td>List of supported edit modes</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/FormType">FormType</a></td><td>type of the form</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/LoanCollection">LoanCollection</a></td><td>Loan collection names</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/LoanLevelActions">LoanLevelActions</a></td><td>Loan level actions</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/LogLevels">LogLevels</a></td><td>Log levels</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/ModalSize">ModalSize</a></td><td>size of the modal</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/ModalType">ModalType</a></td><td>type of the modal</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/NavigationType">NavigationType</a></td><td>areas in the application where the user can navigate to</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/OpenMode">OpenMode</a></td><td>module open mode</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/OpenType">OpenType</a></td><td>type of the item to open</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/OriginContext">OriginContext</a></td><td>user type context</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/RecordActions">RecordActions</a></td><td>loan record actions</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/RecordViewType">RecordViewType</a></td><td>loan record view types</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/SCOPE">SCOPE</a></td><td>product scopes</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/ScriptingObjectNames">ScriptingObjectNames</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/ServiceSetupCategory">ServiceSetupCategory</a></td><td>type of service setup categories</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/ToastType">ToastType</a></td><td>toast message type</td></tr><tr><td><a class="" href="/scripting-object/api/enumerations/TokenType">TokenType</a></td><td>token type</td></tr></tbody></table>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="type-aliases">Type Aliases<a href="#type-aliases" class="hash-link" aria-label="Direct link to Type Aliases" title="Direct link to Type Aliases" translate="no"></a></h2>
+<table><thead><tr><th>Type Alias</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/scripting-object/api/type-aliases/AcceptFile">AcceptFile</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ActionInfo">ActionInfo</a></td><td>Action information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ActionResponse">ActionResponse</a></td><td>Return type for action execution</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/AdditionalServices">AdditionalServices</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/AppInfo">AppInfo</a></td><td>additional information about the application</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationActionCompletedListener">ApplicationActionCompletedListener</a></td><td>event handler that handles action completed event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationContext">ApplicationContext</a></td><td>application context</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationEvents">ApplicationEvents</a></td><td>events related to the application</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationInfo">ApplicationInfo</a></td><td>Selected application related information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationLoginListener">ApplicationLoginListener</a></td><td>event handler that handles user login event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ApplicationNavigationStartListener">ApplicationNavigationStartListener</a></td><td>event handler that handles navigation start event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/AssignLoanTeamMember">AssignLoanTeamMember</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/AusTracking">AusTracking</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/BAEvent">BAEvent</a></td><td>Business analytics event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/BorrowerContacts">BorrowerContacts</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/BusinessContacts">BusinessContacts</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/BusinessRules">BusinessRules</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Capabilities">Capabilities</a></td><td>capabilities exposed by the application</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ChangeExpectedDate">ChangeExpectedDate</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/CommitInfo">CommitInfo</a></td><td>Loan commit event parameters</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/CompanySettingsQueryOptions">CompanySettingsQueryOptions</a></td><td>set of query options to get company settings</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/CompanyUserSetup">CompanyUserSetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ConditionOperator">ConditionOperator</a></td><td>Condition operators for style criteria matching</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ConditionType">ConditionType</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Contacts">Contacts</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ContactSetup">ContactSetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/CurrentApplicationOptions">CurrentApplicationOptions</a></td><td>options for setting current application</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Dashboard">Dashboard</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/DeliveryConditions">DeliveryConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/DescriptorInfo">DescriptorInfo</a></td><td>metadata about the application descriptor</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/DisclosureTracking">DisclosureTracking</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/DocsSetup">DocsSetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Documents">Documents</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/DynamicDataManagement">DynamicDataManagement</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EDisclosures">EDisclosures</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EditComment">EditComment</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EditModeOptions">EditModeOptions</a></td><td>options for setting loan edit mode</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EFolderHistory">EFolderHistory</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EFolderSetup">EFolderSetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EncompassWebServices">EncompassWebServices</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EnhancedConditions">EnhancedConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EntityOptions">EntityOptions</a></td><td>entity options (used by EPC)</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Environment">Environment</a></td><td>environment details</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EVault">EVault</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EVaultPortal">EVaultPortal</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/EventObjects">EventObjects</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Events">Events</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ExportServices">ExportServices</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FieldOptions">FieldOptions</a></td><td>option name and its value</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FieldOptionsParam">FieldOptionsParam</a></td><td>Parameters for getting field options</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FileContacts">FileContacts</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FilterOperator">FilterOperator</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FilterOption">FilterOption</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FinishMilestone">FinishMilestone</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Form">Form</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FormDescriptor">FormDescriptor</a></td><td>metadata about the form descriptor</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FormEvents">FormEvents</a></td><td>events that notifies the form&#x27;s lifecycle</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FormInfo">FormInfo</a></td><td>metadata about the form</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FormLoadListener">FormLoadListener</a></td><td>event handler for form load event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/FormUnloadListener">FormUnloadListener</a></td><td>event handler for form unload event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/GlobalChangeListener">GlobalChangeListener</a></td><td>event handler for global state change event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/GlobalEvents">GlobalEvents</a></td><td>events fired from Global scripting object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/GrantWriteAccess">GrantWriteAccess</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/GseServices">GseServices</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ImportLoan">ImportLoan</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LaunchCategoryOptions">LaunchCategoryOptions</a></td><td>options to launch service order integration by category</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LaunchProviderOptions">LaunchProviderOptions</a></td><td>options to launch service order integration by specific service provider</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LaunchServiceSetupOptions">LaunchServiceSetupOptions</a></td><td>options to launch service order integration by specific service setup</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LIB_NAME">LIB_NAME</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Listener">Listener</a></td><td>callback for event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanApplicationSelectedListener">LoanApplicationSelectedListener</a></td><td>event handler for loan application selected event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanChangeEventInfo">LoanChangeEventInfo</a></td><td>Loan change event parameters</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanChangeListener">LoanChangeListener</a></td><td>Event handler for loan data change event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanCloseListener">LoanCloseListener</a></td><td>event handler for loan close event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanCollectionObject">LoanCollectionObject</a></td><td>Loan collection object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanCommittedListener">LoanCommittedListener</a></td><td>Event handler for loan commited event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanEditModeChangeListener">LoanEditModeChangeListener</a></td><td>event handler for loan edit mode change event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanEditModeEventInfo">LoanEditModeEventInfo</a></td><td>Loan edit mode change event info</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanEvents">LoanEvents</a></td><td>Event types available for loan-related operations.</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanFieldChangeSyncListener">LoanFieldChangeSyncListener</a></td><td>Event handler for synchronous loan field change event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanMilestoneCompletedListener">LoanMilestoneCompletedListener</a></td><td>event handler for loan milestone completed event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanObject">LoanObject</a></td><td>v3 loan object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanOpenListener">LoanOpenListener</a></td><td>event handler for loan open event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanPreCommitListener">LoanPreCommitListener</a></td><td>Event handler for loan precommit event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanPreMilestoneCompleteListener">LoanPreMilestoneCompleteListener</a></td><td>event handler for loan pre milestone complete event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanRecord">LoanRecord</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanSetup">LoanSetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanSyncListener">LoanSyncListener</a></td><td>Event handler for loan sync event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoanTeam">LoanTeam</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LoConnectTasks">LoConnectTasks</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/LogMessage">LogMessage</a></td><td>log message</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ManageServiceProviders">ManageServiceProviders</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Milestone">Milestone</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/MilestoneInfo">MilestoneInfo</a></td><td>Milestone related information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/MilestoneWorkflowManagement">MilestoneWorkflowManagement</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModalContent">ModalContent</a></td><td>content for warning / success / error / info modal types</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModalOptions">ModalOptions</a></td><td>modal options</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleCloseInfo">ModuleCloseInfo</a></td><td>module close event info</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleCloseListener">ModuleCloseListener</a></td><td>event handler that handles module close event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleEvents">ModuleEvents</a></td><td>events that notifies the module&#x27;s lifecycle</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleOpenInfo">ModuleOpenInfo</a></td><td>module open event info</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleOpenListener">ModuleOpenListener</a></td><td>event handler that handles module open event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleParameters">ModuleParameters</a></td><td>MicroApp module specific parameters</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleUnloadInfo">ModuleUnloadInfo</a></td><td>module unload event info</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ModuleUnLoadingListener">ModuleUnLoadingListener</a></td><td>event handler that handles module unload event</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/MoveFrom">MoveFrom</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/MoveLoans">MoveLoans</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/MoveTo">MoveTo</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/NavigationOptions">NavigationOptions</a></td><td>navigation options</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/NavigationStartInfo">NavigationStartInfo</a></td><td>navigation start event info</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/OpenOptions">OpenOptions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/OriginDetails">OriginDetails</a></td><td>transaction origination context</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PerfMark">PerfMark</a></td><td>Performance mark</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PersonalTemplates">PersonalTemplates</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Personas">Personas</a></td><td>Personas information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Pipeline">Pipeline</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PipelineView">PipelineView</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PluginInfo">PluginInfo</a></td><td>Plugin information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PostClosingConditions">PostClosingConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PreliminaryConditions">PreliminaryConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Print">Print</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PrintOptions">PrintOptions</a></td><td>Options for printing the document</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/PurchaseConditions">PurchaseConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/RecordOptions">RecordOptions</a></td><td>options for updating records</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/RemotingScriptingObject">RemotingScriptingObject</a></td><td>serialized scripting object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ResourceDetails">ResourceDetails</a></td><td>details of the transaction resource</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ResourceOptions">ResourceOptions</a></td><td>name of the document to be uploaded</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ReturnFile">ReturnFile</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Role">Role</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Role2">Role2</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Route">Route</a></td><td>navigation type</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ScriptingObjectTypes">ScriptingObjectTypes</a></td><td>list of scripting object names and their types</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/SecondarySetup">SecondarySetup</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Service">Service</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ServiceSetup">ServiceSetup</a></td><td>details of a service setup</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/StandardWebForm">StandardWebForm</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/StateInfo">StateInfo</a></td><td>state information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/StyleOptions">StyleOptions</a></td><td>CSS style properties that can be applied to fields and table rows All color values should be valid CSS color strings (hex, rgb, named colors, etc.)</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/SystemAdministration">SystemAdministration</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TableRowCriteria">TableRowCriteria</a></td><td>Criteria for conditional styling of table rows Maps table column name/key to condition operators that determine when styles should be applied</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TableRowStyleOptions">TableRowStyleOptions</a></td><td>Style configuration for table rows with conditional criteria Styles are applied to rows that match all specified criteria</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TablesAndFees">TablesAndFees</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TimingOptions">TimingOptions</a></td><td>additional details related to the timing measure</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/ToastOptions">ToastOptions</a></td><td>options for toast message</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TokenInfo">TokenInfo</a></td><td>Token information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Tool">Tool</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoCompanyDetails">TpoCompanyDetails</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoConnectSiteSettings">TpoConnectSiteSettings</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoContacts">TpoContacts</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoFees">TpoFees</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoInformation">TpoInformation</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TpoOrganizationSettings">TpoOrganizationSettings</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TqlServices">TqlServices</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/Trades">Trades</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionDetails">TransactionDetails</a></td><td>details about the transaction</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionEvent">TransactionEvent</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionInfo">TransactionInfo</a></td><td>details about the transaction that is created / updated</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionRequest">TransactionRequest</a></td><td>Transaction request object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionResource">TransactionResource</a></td><td>file attachment information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/TransactionTemplateDetails">TransactionTemplateDetails</a></td><td>Transaction Template object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/UnAuthorizedError">UnAuthorizedError</a></td><td>Error thrown when the microapp / customization is not authorized to receive child token</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/UnderwritingCenter">UnderwritingCenter</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/UnderwritingConditions">UnderwritingConditions</a></td><td>-</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/User">User</a></td><td>User information</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/UserAccessRights">UserAccessRights</a></td><td>user access rights object</td></tr><tr><td><a class="" href="/scripting-object/api/type-aliases/UserInfo">UserInfo</a></td><td>User information</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_x8Bu"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_xpf_" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_QUoF"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/scripting-object/Objects/transactiontemplate"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">TransactionTemplate</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/scripting-object/api/enumerations/EditModes"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">EditModes</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_YLGy thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a></li><li><a href="#enumerations" class="table-of-contents__link toc-highlight">Enumerations</a></li><li><a href="#type-aliases" class="table-of-contents__link toc-highlight">Type Aliases</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/scripting-object/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://icemortgagetechnology.slack.com/archives/C01M49EGP6Z" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 ICE.</div></div></div></footer></div>
+</body>
+</html>

package/build/docs/api/interfaces/IAnalytics/index.html ADDED Viewed

@@ -0,0 +1,133 @@
+<!doctype html>
+<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/interfaces/IAnalytics" data-has-hydrated="false">
+<head>
+<meta charset="UTF-8">
+<meta name="generator" content="Docusaurus v3.9.2">
+<title data-rh="true">IAnalytics | Scripting Object</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/scripting-object/api/interfaces/IAnalytics"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="IAnalytics | Scripting Object"><meta data-rh="true" name="description" content="Methods to collect various business analytics &amp; performance related events and report the same"><meta data-rh="true" property="og:description" content="Methods to collect various business analytics &amp; performance related events and report the same"><link data-rh="true" rel="icon" href="/scripting-object/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/scripting-object/api/interfaces/IAnalytics"><link data-rh="true" rel="alternate" href="https://pui.ice.com/scripting-object/api/interfaces/IAnalytics" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/scripting-object/api/interfaces/IAnalytics" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Scripting Object API","item":"https://pui.ice.com/scripting-object/api/"},{"@type":"ListItem","position":2,"name":"IAnalytics","item":"https://pui.ice.com/scripting-object/api/interfaces/IAnalytics"}]}</script><link rel="stylesheet" href="/scripting-object/assets/css/styles.48d5ef50.css">
+<script src="/scripting-object/assets/js/runtime~main.fab082c7.js" defer="defer"></script>
+<script src="/scripting-object/assets/js/main.07dd8413.js" defer="defer"></script>
+</head>
+<body class="navigation-with-keyboard">
+<svg style="display: none;"><defs>
+<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
+</defs></svg>
+<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_eGlE" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/scripting-object/"><div class="navbar__logo"><img src="/scripting-object/img/logo.svg" alt="Scripting Object" class="themedComponent_Q3jx themedComponent--light_BjHx"><img src="/scripting-object/img/logo.svg" alt="Scripting Object" class="themedComponent_Q3jx themedComponent--dark_mxj9"></div><b class="navbar__title text--truncate">Scripting Object</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/scripting-object/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/scripting-object/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_S6Pl colorModeToggle_L96j"><button class="clean-btn toggleButton_Wf77 toggleButtonDisabled_JaY9" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk lightToggleIcon_X2ll"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk darkToggleIcon_kYIm"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk systemToggleIcon_mG1q"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_dSE1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_vmWZ"><div class="docsWrapper_es0q"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_cO8Y" type="button"></button><div class="docRoot_cyW0"><aside class="theme-doc-sidebar-container docSidebarContainer_yHv_"><div class="sidebarViewport_iaL1"><div class="sidebar_Xoux"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_Qdup"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/scripting-object/"><span title="Getting Started" class="linkLabel_Knm1">Getting Started</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/scripting-object/Objects/analytics"><span title="Objects" class="categoryLinkLabel_I_MP">Objects</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--active" href="/scripting-object/api/"><span title="Scripting Object API" class="categoryLinkLabel_I_MP">Scripting Object API</span></a><button aria-label="Collapse sidebar category &#x27;Scripting Object API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/scripting-object/api/enumerations/EditModes"><span title="enumerations" class="categoryLinkLabel_I_MP">enumerations</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/scripting-object/api/interfaces/IAnalytics"><span title="interfaces" class="categoryLinkLabel_I_MP">interfaces</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/scripting-object/api/interfaces/IAnalytics"><span title="IAnalytics" class="linkLabel_Knm1">IAnalytics</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IApplication"><span title="IApplication" class="linkLabel_Knm1">IApplication</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IAuth"><span title="IAuth" class="linkLabel_Knm1">IAuth</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IEvent"><span title="IEvent" class="linkLabel_Knm1">IEvent</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IForm"><span title="IForm" class="linkLabel_Knm1">IForm</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IGlobal"><span title="IGlobal" class="linkLabel_Knm1">IGlobal</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IHttp"><span title="IHttp" class="linkLabel_Knm1">IHttp</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/ILoan"><span title="ILoan" class="linkLabel_Knm1">ILoan</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IMemStorage"><span title="IMemStorage" class="linkLabel_Knm1">IMemStorage</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IModule"><span title="IModule" class="linkLabel_Knm1">IModule</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IScriptingObject"><span title="IScriptingObject" class="linkLabel_Knm1">IScriptingObject</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IScriptingObjectProxy"><span title="IScriptingObjectProxy" class="linkLabel_Knm1">IScriptingObjectProxy</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IService"><span title="IService" class="linkLabel_Knm1">IService</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/ISession"><span title="ISession" class="linkLabel_Knm1">ISession</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/IStyling"><span title="IStyling" class="linkLabel_Knm1">IStyling</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/ITransaction"><span title="ITransaction" class="linkLabel_Knm1">ITransaction</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/scripting-object/api/interfaces/ITransactionTemplate"><span title="ITransactionTemplate" class="linkLabel_Knm1">ITransactionTemplate</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/scripting-object/api/type-aliases/AcceptFile"><span title="type-aliases" class="categoryLinkLabel_I_MP">type-aliases</span></a></div></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_qgvB"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Rp9M"><div class="docItemContainer_reKL"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_L00V" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/scripting-object/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_BtgF"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/scripting-object/api/"><span>Scripting Object API</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">interfaces</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">IAnalytics</span></li></ul></nav><div class="tocCollapsible_tUTH theme-doc-toc-mobile tocMobile_Bfsw"><button type="button" class="clean-btn tocCollapsibleButton_YuJU">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>IAnalytics</h1></header>
+<p>Methods to collect various business analytics &amp; performance related events and report the same</p>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="extends">Extends<a href="#extends" class="hash-link" aria-label="Direct link to Extends" title="Direct link to Extends" translate="no"></a></h2>
+<ul>
+<li class=""><a class="" href="/scripting-object/api/interfaces/IScriptingObject"><code>IScriptingObject</code></a></li>
+</ul>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="methods">Methods<a href="#methods" class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods" translate="no"></a></h2>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="_dispose">_dispose()?<a href="#_dispose" class="hash-link" aria-label="Direct link to _dispose()?" title="Direct link to _dispose()?" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token plain">optional </span><span class="token function" style="color:#d73a49">_dispose</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>void</code></p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="inherited-from">Inherited from<a href="#inherited-from" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
+<p><a class="" href="/scripting-object/api/interfaces/IScriptingObject"><code>IScriptingObject</code></a>.<a class="" href="/scripting-object/api/interfaces/IScriptingObject#_dispose"><code>_dispose</code></a></p>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="_tojson">_toJSON()<a href="#_tojson" class="hash-link" aria-label="Direct link to _toJSON()" title="Direct link to _toJSON()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">_toJSON</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> RemotingScriptingObject</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-1">Returns<a href="#returns-1" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><a class="" href="/scripting-object/api/type-aliases/RemotingScriptingObject"><code>RemotingScriptingObject</code></a></p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="inherited-from-1">Inherited from<a href="#inherited-from-1" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
+<p><a class="" href="/scripting-object/api/interfaces/IScriptingObject"><code>IScriptingObject</code></a>.<a class="" href="/scripting-object/api/interfaces/IScriptingObject#_tojson"><code>_toJSON</code></a></p>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="deletetimingeventsamplingratio">deleteTimingEventSamplingRatio()<a href="#deletetimingeventsamplingratio" class="hash-link" aria-label="Direct link to deleteTimingEventSamplingRatio()" title="Direct link to deleteTimingEventSamplingRatio()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">deleteTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">names</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>Remove sampling configuration for timing events
+Falls back to default sampling ratio (0.25)</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="names">names<a href="#names" class="hash-link" aria-label="Direct link to names" title="Direct link to names" translate="no"></a></h5>
+<p><code>string</code>[]</p>
+<p>array of timing event names</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-2">Returns<a href="#returns-2" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>void</code></p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token plain">analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">deleteTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">&#x27;api-call&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;user-interaction&#x27;</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="endtiming">endTiming()<a href="#endtiming" class="hash-link" aria-label="Direct link to endTiming()" title="Direct link to endTiming()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">start</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> PerfMark</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> options</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> TimingOptions</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Promise</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token keyword" style="color:#00009f">void</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>end timing measure</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters-1">Parameters<a href="#parameters-1" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="start">start<a href="#start" class="hash-link" aria-label="Direct link to start" title="Direct link to start" translate="no"></a></h5>
+<p>name used to start timing measure or return value of the startTiming method</p>
+<p><code>string</code> | <a class="" href="/scripting-object/api/type-aliases/PerfMark"><code>PerfMark</code></a></p>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no"></a></h5>
+<p><a class="" href="/scripting-object/api/type-aliases/TimingOptions"><code>TimingOptions</code></a></p>
+<p>additional details related to the measurement</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-3">Returns<a href="#returns-3" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
+<p>a promise that resolves when the timing measurement is ended</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="example-1">Example<a href="#example-1" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> longTaskMeasurement </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;LongTask&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;myApp&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;https://myapp.com&#x27;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// do some work</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">longTaskMeasurement</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;myApp&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;https://myapp.com&#x27;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> longTaskMeasurement </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;LongTask&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;myApp&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;https://myapp.com&#x27;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// do some work</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;LongTask&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;loanApp&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;https://loanApp.com&#x27;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="getalltimingeventsamplingratios">getAllTimingEventSamplingRatios()<a href="#getalltimingeventsamplingratios" class="hash-link" aria-label="Direct link to getAllTimingEventSamplingRatios()" title="Direct link to getAllTimingEventSamplingRatios()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">getAllTimingEventSamplingRatios</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>Get all configured timing event sampling ratios</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-4">Returns<a href="#returns-4" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>Record</code>&lt;<code>string</code>, <code>number</code>&gt;</p>
+<p>object with timing event names and their sampling ratios</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="example-2">Example<a href="#example-2" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> ratios </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">getAllTimingEventSamplingRatios</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">ratios</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// { &#x27;api-call&#x27;: 0.1, &#x27;user-interaction&#x27;: 0.5 }</span><br></span></code></pre></div></div>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="gettimingeventsamplingratio">getTimingEventSamplingRatio()<a href="#gettimingeventsamplingratio" class="hash-link" aria-label="Direct link to getTimingEventSamplingRatio()" title="Direct link to getTimingEventSamplingRatio()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">getTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">names</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">undefined</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>Get sampling ratios for timing events</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters-2">Parameters<a href="#parameters-2" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="names-1">names<a href="#names-1" class="hash-link" aria-label="Direct link to names" title="Direct link to names" translate="no"></a></h5>
+<p><code>string</code>[]</p>
+<p>array of timing event names</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-5">Returns<a href="#returns-5" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>Record</code>&lt;<code>string</code>, <code>number</code> | <code>undefined</code>&gt;</p>
+<p>object with ratios for each event (undefined if using default)</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="example-3">Example<a href="#example-3" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> ratios </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">getTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">&#x27;api-call&#x27;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;user-interaction&#x27;</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">ratios</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// { &#x27;api-call&#x27;: 0.1, &#x27;user-interaction&#x27;: 0.5 }</span><br></span></code></pre></div></div>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="sendbaevent">sendBAEvent()<a href="#sendbaevent" class="hash-link" aria-label="Direct link to sendBAEvent()" title="Direct link to sendBAEvent()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> BAEvent</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Promise</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token keyword" style="color:#00009f">void</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>send business analytics event</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters-3">Parameters<a href="#parameters-3" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="event">event<a href="#event" class="hash-link" aria-label="Direct link to event" title="Direct link to event" translate="no"></a></h5>
+<p><a class="" href="/scripting-object/api/type-aliases/BAEvent"><code>BAEvent</code></a></p>
+<p>event to be sent</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-6">Returns<a href="#returns-6" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="settimingeventsamplingratio">setTimingEventSamplingRatio()<a href="#settimingeventsamplingratio" class="hash-link" aria-label="Direct link to setTimingEventSamplingRatio()" title="Direct link to setTimingEventSamplingRatio()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">setTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">ratios</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>Set sampling ratios for timing events</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters-4">Parameters<a href="#parameters-4" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="ratios">ratios<a href="#ratios" class="hash-link" aria-label="Direct link to ratios" title="Direct link to ratios" translate="no"></a></h5>
+<p><code>Record</code>&lt;<code>string</code>, <code>number</code>&gt;</p>
+<p>object with timing event names and their sampling ratios (0 to 1)</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-7">Returns<a href="#returns-7" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>void</code></p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="example-4">Example<a href="#example-4" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
+<div class="language-typescript codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-typescript codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token plain">analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">setTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token string-property property" style="color:#36acaa">&#x27;api-call&#x27;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token string-property property" style="color:#36acaa">&#x27;user-interaction&#x27;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.5</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token string-property property" style="color:#36acaa">&#x27;page-load&#x27;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.8</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="starttiming">startTiming()<a href="#starttiming" class="hash-link" aria-label="Direct link to startTiming()" title="Direct link to startTiming()" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">name</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> options</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> TimingOptions</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Promise</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">PerfMark</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<p>start timing measure</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="parameters-5">Parameters<a href="#parameters-5" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="name">name<a href="#name" class="hash-link" aria-label="Direct link to name" title="Direct link to name" translate="no"></a></h5>
+<p><code>string</code></p>
+<p>unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced</p>
+<h5 class="anchor anchorTargetStickyNavbar_UXZL" id="options-1">options<a href="#options-1" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no"></a></h5>
+<p><a class="" href="/scripting-object/api/type-aliases/TimingOptions"><code>TimingOptions</code></a></p>
+<p>additional details related to the measurement</p>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="returns-8">Returns<a href="#returns-8" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
+<p><code>Promise</code>&lt;<a class="" href="/scripting-object/api/type-aliases/PerfMark"><code>PerfMark</code></a>&gt;</p>
+<p>a promise that resolves to a performance mark object</p>
+<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" translate="no"></a></h2>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">readonly</span><span class="token plain"> id</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="inherited-from-2">Inherited from<a href="#inherited-from-2" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
+<p><a class="" href="/scripting-object/api/interfaces/IScriptingObject"><code>IScriptingObject</code></a>.<a class="" href="/scripting-object/api/interfaces/IScriptingObject#id"><code>id</code></a></p>
+<hr>
+<h3 class="anchor anchorTargetStickyNavbar_UXZL" id="objecttype">objectType<a href="#objecttype" class="hash-link" aria-label="Direct link to objectType" title="Direct link to objectType" translate="no"></a></h3>
+<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">readonly</span><span class="token plain"> objectType</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
+<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="inherited-from-3">Inherited from<a href="#inherited-from-3" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
+<p><a class="" href="/scripting-object/api/interfaces/IScriptingObject"><code>IScriptingObject</code></a>.<a class="" href="/scripting-object/api/interfaces/IScriptingObject#objecttype"><code>objectType</code></a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_x8Bu"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/IAnalytics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_xpf_" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_QUoF"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/scripting-object/api/enumerations/TokenType"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">TokenType</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/scripting-object/api/interfaces/IApplication"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">IApplication</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_YLGy thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#extends" class="table-of-contents__link toc-highlight">Extends</a></li><li><a href="#methods" class="table-of-contents__link toc-highlight">Methods</a><ul><li><a href="#_dispose" class="table-of-contents__link toc-highlight">_dispose()?</a></li><li><a href="#_tojson" class="table-of-contents__link toc-highlight">_toJSON()</a></li><li><a href="#deletetimingeventsamplingratio" class="table-of-contents__link toc-highlight">deleteTimingEventSamplingRatio()</a></li><li><a href="#endtiming" class="table-of-contents__link toc-highlight">endTiming()</a></li><li><a href="#getalltimingeventsamplingratios" class="table-of-contents__link toc-highlight">getAllTimingEventSamplingRatios()</a></li><li><a href="#gettimingeventsamplingratio" class="table-of-contents__link toc-highlight">getTimingEventSamplingRatio()</a></li><li><a href="#sendbaevent" class="table-of-contents__link toc-highlight">sendBAEvent()</a></li><li><a href="#settimingeventsamplingratio" class="table-of-contents__link toc-highlight">setTimingEventSamplingRatio()</a></li><li><a href="#starttiming" class="table-of-contents__link toc-highlight">startTiming()</a></li></ul></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#id" class="table-of-contents__link toc-highlight">id</a></li><li><a href="#objecttype" class="table-of-contents__link toc-highlight">objectType</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/scripting-object/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://icemortgagetechnology.slack.com/archives/C01M49EGP6Z" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://git.elliemae.io/platform-ui/pui-scripting-object.git" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 ICE.</div></div></div></footer></div>
+</body>
+</html>