2.3Framework properties

The framework provides the following properties. All of these are read-only.

Property

Description

RELEASE

See introduction

isReady

Indicates whether the framework is ready for use. Always immediately true in scripts and UDIXes. Not immediately true in widgets.

id

Unique ID for this instance of the widget/script/UDIX. This changes each time your code is loaded. For widgets loaded into the MyTrader page container, it is not a persistent ID across reloads of the widget's page, or across the user logging out and back in. It changes on each load of the widget.

type

Not applicable to scripts and UDIXes. For widgets, a unique category allocated to your widget. Can be used for displaying a widget as its own dialog.

_parentWidget

Not applicable to scripts and UDIXes. For widgets, the ID of the widget's parent/creator

inWindow

Not applicable to scripts and UDIXes. Boolean indicating whether a widget has been loaded into a pop-up browser window rather than the main window.

inPageContainer

Not applicable to scripts and UDIXes. Boolean indicating whether a widget has been loaded into the main MyTrader page container, or whether it is a temporary dialog or floating panel.

isDialog

Not applicable to scripts and UDIXes. Boolean indicating whether a widget is being displayed as a dialog or floating panel rather than being persistently loaded into the MyTrader page container.

fullScreen

Not applicable to scripts and UDIXes. Boolean indicating whether a widget is being displayed in full-screen mode on a small device such as mobile phone.

privateSettings

See the section about settings and state storage

categorySettings

See the section about settings and state storage

context

Any context of market and/or timeframe selection, for a widget which is loaded in the MyTrader page container.