User Preferences

The User Preferences feature provides users with a Settings dialog to set application preferences. Preferences are stored centrally by Transformer's Persistence Service, and are available between sessions and environments.

For developers, the User Preferences service exposes an API to set and retrieve preference values, and an API for adding new preferences to the Settings dialog. For more information, see the User Preferences API.

Contents:

Requirements

User Preferences requires Transformer's Persistence Service. See Activating the Persistence Service.

The Settings icon () is enabled by default. To hide the icon, set the property CAPLIN.USERPREFERENCES.ENABLED in AppConfig.js to false.

The Settings dialog

The Settings dialog, accessed via the Settings icon (), provides users with a central interface to manage their application preferences.

Setting preferences

Users set a preference using the following procedure:

  1. Click 
  2. Locate the preference in the Settings dialog.
    1. Click the section headings on the left of the dialog to navigate through the available preferences.
  3. Change the preference value.
  4. Click Save to apply changes, or click Cancel to discard changes.

Preferences available in the dialog

The Settings dialog arranges preferences into sections. By default, the Settings dialog comes with one section: Trading.

In the table below, the Section ID and Preference ID columns contain identifiers required to get and set preference values using the User Preferences API.

Section: Trading
Preference Section ID Preference ID Description
Incrementer precision trading incrementer-precision

Sets the discrete amount by which the adjustment icons ( and ) adjust the value of rate fields and margin fields.

This preference has two options:

  • Last Digit: [Default] The unit of adjustment is the place-value of the right-most digit of the rate or margin.
    • Rate example: raising an ask rate of 1.20050 by a single increment results in a new ask rate of 1.20051.
    • Margin example: raising an ask margin of 1.1 pips by a single increment results in a new ask margin of 1.2 pips.
  • One Pip: The unit of adjustment is one pip.
    • Rate example: raising an ask rate of 1.20050 by a single increment results in a new ask rate of 1.20060.
    • Margin example: raising an ask margin of 1.1 pips by a single increment results in a new ask margin of 2.1 pips.

Changes to this preference take effect immediately, and apply to all fields in the app.

The User Preferences API

You can use the the User Preferences API to retrieve and set preference values, and to add new preferences to the Settings dialog. For more information, see the User Preferences API.