Supported Runtime Functions and Objects
When replacing non-secure functions in a mashup, you must review and update function expressions. To avoid mashup run-time issues and unexpected behaviors with the new standard functions, you must remove any references to objects and functions that are listed in the following table.
Deprecated Objects and Functions
|
Object or Function Name
|
Example
|
||
|---|---|---|---|
|
location
|
• location.reload();
• location.hostName !== ‘localhost’;
|
||
|
widget
|
• widget.getProperty('DisplayName') === ‘ptcs-grid2’;
• widget.mashup.rootWidget.getProperty('remoteAccessibleThing') == null; widget.mashup.rootWidget.getWidgets()[1].getProperty('SelectedText') == null;
|
||
|
history
|
• history.back();
|
||
|
TW.Runtime.<any object>.(<any function>)
|
• Output = TW.Runtime.Widgets.PTC_SCA_SCO_CustomFunctions.isSecure();
• TW.Runtime.showHideDataFilterWidgets($(\body"), false);
• Output = TW.Runtime.Widgets.PTC_SCA_SCO_CustomFunctions.getURLParameter(“mashup",url);
• TW.Runtime.Widgets.AssetMonitor.refreshNeeded(isSelected,selectedTreeNode,selectedContext);
• TW.Runtime.AssetMonitor.assetPropertyTitles(widget);
• TW.Runtime.AssetMonitor.assetPropertyTitles(widget);
|
||
|
jqElement
|
• widget.jqElement.triggerHandler('Changed');
|
||
|
screen
|
• screen.width
• screen.height
• screen.availHeight
• screen.availWidth
|
||
|
self
|
• const displayName = self['DisplayName'];
|
||
|
sessionStorage
|
• sessionStorage.setItem('key', ‘value’);
|
 |
Deprecated functions and objects are only supported in the non-secure functions.
|
Supported Objects and Functions
The following table lists supported objects and functions in the latest standard versions of the Validator and Expression functions:
|
Category
|
Objects and Functions
|
Examples
|
||
|---|---|---|---|---|
|
Location
|
• TW.location.hash
• TW.location.host
• TW.location.hostname
• TW.location.href
• TW.location.origin
• TW.location.pathname
• TW.location.port
• TW.location.protocol
• TW.location.search
• TW.location.reload()
|
TW.location.reload();
TW.location.hostName !== ‘localhost’;
|
||
|
Localization
|
• TW.Runtime.convertLocalizableString('[[token name]]')
|
Output = TW.Runtime.convertLocalizableString(“[[userName”]]);
|
||
|
Logging
|
• TW.log.info()
• TW.log.debug()
• TW.log.warning()
• TW.log.error()
|
TW.log.debug('Logging to mashup console');
|
||
|
Runtime Root Mashup
|
• TW.Runtime.pageMashupName
• TW.Runtime.actualMasterName
• TW.Runtime.RootMashup.ConfigurationTables
• TW.Runtime.RootMashup.CustomMashupCss
• TW.Runtime.RootMashup.Data
• TW.Runtime.RootMashup.DataBindings
• TW.Runtime.RootMashup.Events
• TW.Runtime.RootMashup.UI
• TW.Runtime.RootMashup.mashupName
|
Output = TW.Runtime.RootMashup.mashupName;
Output = TW.Runtime.Workspace.Mashups.Current.UI.Widgets[0].Properties.Id;
Output = TW.Runtime.Workspace.Mashups.Current.Events[0].EventHandlerService;
Output = TW.Runtime.Workspace.Mashups.Current.Data.Session.UserExtension.Services[0].APIMethod;
Output = TW.Runtime.RootMashup.UI.Widgets[1].properties.SelectedText;
|
||
|
Runtime Workspace
|
• TW.Runtime.Workspace.Mashups.CurrentMashupName
• TW.Runtime.Workspace.Mashups.CurrentParameters
• TW.Runtime.Workspace.Mashups.Current.ConfigurationTables
• TW.Runtime.Workspace.Mashups.Current.CustomMashupCss
• TW.Runtime.Workspace.Mashups.Current.Data
• TW.Runtime.Workspace.Mashups.Current.DataBindings
• TW.Runtime.Workspace.Mashups.Current.Events
• TW.Runtime.Workspace.Mashups.Current.UI
• TW.Runtime.Workspace.Mashups.Current.mashupName
|
Output = TW.Runtime.Workspace.Mashups.CurrentMashupName;
|
||
|
Runtime Screen Height and Width
|
• TW.screen.width
• TW.screen.height
• TW.screen.availHeight
• TW.screen.availWidth
|
Output = TW.screen.width
|
||
|
Runtime Document Title
|
TW.Runtime.updateDocumentTitle('')
|
TW.Runtime.updateDocumentTitle('Title')
|
||
|
HTTP Requests
|
XMLHttpRequest
|
let xhr = new XMLHttpRequest(); xhr.open('GET', 'http://localhost:9000/Thingworx/Users/Administrator/Properties', true); xhr.onload = function () { console.log('the value is '+ xhr.responseText); }; xhr.send();
|
||
|
Session Storage
|
TW.sessionStorage.getItem()
TW.sessionStorage.setItem()
TW.sessionStorage.removeItem()
TW.sessionStorage.clear()
|
|||
|
Timeout
|
TW.setTimeout
|
TW.setTimeout(() => {
TW.log.info("Delayed for 1 second.") }, "1000"); |