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.
- The Settings dialog
- The User Preferences API
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, accessed via the Settings icon (), provides users with a central interface to manage their application preferences.
Users set a preference using the following procedure:
- Locate the preference in the Settings dialog.
- Click the section headings on the left of the dialog to navigate through the available preferences.
- Change the preference value.
- Click Save to apply changes, or click Cancel to discard changes.
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.
|Preference||Section ID||Preference ID||Description|
Sets the discrete amount by which the adjustment icons ( and ) adjust the value of rate fields and margin fields.
This preference has two options:
Changes to this preference take effect immediately, and apply to all fields in the app.
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.