True Range Chart Widget

Beta version

The new Calendar Widgets are still in beta and may be subject to some changes.

The Volatility Ratio Chart Widget displays a chart of the true range data of all occurrences of a calendar event. It contains a picker to change the asset which should be displayed.

Parameters

To learn how to set the widget parameters dynamically, please read this.

event-id

Required.

The recurrent event ID. It can be retrieved using the Economic Calendar API.

Examples

  • 5e5f6e2f-7e6f-404e-bd1a-456558f0de11 - Gross Domestic Product (MoM) - UK
  • 9cdf56fd-99e4-4026-aa99-2b6c0ca92811 - Nonfarm Payrolls - US

culture

Optional.

Sets the language in which the widget should be displayed. The language codes can be found here.

Default: en (English)

timezone-offset

Optional.

Sets the timezone in which the dates and times should be displayed, represented as the time zone difference (in minutes), from the desired timezone to UTC. Please see a list of all timezones, here.

Default: 0 (Coordinated Universal Time - UTC+00:00)

caution

The time-zone offset is the difference, in minutes, from the desired time to UTC. Note that this means that the offset is positive if the local timezone is behind UTC and negative if it is ahead.

For example, for time zone UTC+10:00 (Australian Eastern Standard Time, Vladivostok Time, Chamorro Standard Time), -600 will be correct parameter value.

Usage

<!-- UTC+01:00 -- Central European Time -->
timezone-offset="-60"
<!-- UTC-05:00 -- Central Daylight Time (North America) -->
timezone-offset="300"
<!-- User browser timezone -->
timezone-offset="new Date().getTimezoneOffset()"

assets

Optional.

It is the list of IDs of the assets that should be available in the asset picker, separated by commas. The complete list can be retrieved using the Economic Calendar API.

By default, the chart shows the chart of the first asset in the list. If the list contains only one asset, then the picker is not shown.

Default: fxs-3212164,fxs-3212155,fxs-3212166,fxs-3212322,fxs-321272 (EUR/USD, USD/JPY, GBP/USD, AUD/USD, USD/CAD)

take

Optional.

The maximum number of data points to be shown by default. If the window width is bigger or equal to 768 pixels or zoomable is true, the user can use the zoom feature to see all available data points.

If null, all available data points are fetched, but it is not recommended as the widget will take longer to load the desired data.

Default: 60

zoomable

Optional.

It defines whether the chart should be zoomable (mouse-scroll and zoom-in & zoom-out buttons). If the window width is less than 768 pixels, it is always false.

Default: true

allow-download

Optional.

It defines whether the widget should allow the download of an SVG or PNG image of the chart. If the window width is less than 768 pixels, it is always false.

Default: true