Getting Started
Platform Basics
Writing Strategies
Development Tools
Backtesting System
Advanced Topics
Data and Research
Integrations
Interface Parameter Types
| Variable (naming example) | Description | Type | Default Value (description) | Component Configuration (description) | Remarks |
|---|---|---|---|---|---|
| pNum | Description of parameter pNum | Numeric (number) | Example: Set default value to 100; f64 in Rust strategies | Used to set the interface control bound to the current parameter: component type, minimum value, maximum value, grouping, filters, etc. | Remarks for parameter pNum, the value of pNum is numeric type |
| pBool | Description of parameter pBool | Boolean (true/false) | Use switch control to set default value, optional control not supported | Same as above | Remarks for parameter pBool, the value of pBool is boolean type |
| pStr | Description of parameter pStr | String (string) | Example: Set default value to abc | Same as above | Remarks for parameter pStr, the value of pStr is string type |
| pCombox | Description of parameter pCombox | Dropdown (selected) | Set one or more options from the options | Same as above | Remarks for parameter pCombox, the value of pCombox may have various forms |
| pSecretStr | Description of parameter pSecretStr | Encrypted string (string) | Example: Set default value to xyz | Same as above | Remarks for parameter pSecretStr, the value of pSecretStr is string type |
Interface parameters are configured in the strategy parameters area below the code editor on the strategy editing page. Please note the following:
- In the default value option of parameter settings, the "Optional" control is optional by default. You can change the state of this control to set the current parameter as required. After setting a parameter as required, if the parameter is not set during backtesting or live trading, backtesting cannot be performed or live trading cannot be started.
- Variable names for interface parameters in strategy code should not use reserved words (keywords) of the current programming language.
- In the backtesting or live trading interface, hovering the mouse over the control bound to a parameter will display the parameter's remarks.
- The "Description" of a parameter is the display name of the control bound to the parameter.
- The "Variable" of a parameter refers to those in the table above:
pNum,pBool,pStr,pCombox,pSecretStr. They exist as global variables in the strategy code, so the values of strategy parameters can be modified in the code (except in Rust, where parameters are global constants and cannot be modified). - For "Encrypted string" and "String" type parameters, no quotes are needed when entering default values; all input is treated as strings. "Encrypted string" parameters are used the same way as "String" parameters, but encrypted strings are transmitted encrypted and not sent in plain text.
- If a "String" type parameter is set to "Optional", when no parameter is filled in the control bound to the parameter, the value of the parameter variable is empty string;
Similarly, the value of a "Numeric" parameter is null;
Similarly, the value of a "Dropdown" parameter is null;
Similarly, the value of an "Encrypted string" parameter is null.
InRuststrategies, an optional parameter that is left empty has the zero value of its type:0for numbers, an empty string for strings and encrypted strings,falsefor booleans. - For dropdown type interface parameters (e.g., variable name
pCombox), when "Support multiple selection" is not enabled in "Component Configuration", the value of pCombox is the index or specific data of the currently selected option (when data is bound to options).
If "Support multiple selection" is enabled, the value of pCombox is an array containing the indices or specific data of all currently selected options (when data is bound to options).