OptimusFLOW
  • Welcome to OptimusFLOW Help
  • Getting started
    • First Time Users
    • Control center
    • Workspaces, Binds, Groups
    • Templates
    • Set as Default
    • Symbols lookup
    • Table management
    • Backup & restore manager
    • General settings
  • Connections
    • Connections manager
    • Connection to Optimus Futures
    • Connection to Paper to Trader dxFeed
    • Connection to Rithmic
    • Connection to Rithmic Prop
    • Connection to CQG
    • Connection to OANDA
  • Trading Journal
  • Analytics panels
    • Chart
      • Chart types
        • Renko
        • Heiken Ashi
        • Kagi
        • Points & Figures
        • Range bars
        • Line break
        • Volume Bars
      • Chart overlays
      • Technical indicators
        • Oscillators
          • Aroon Indicator
          • Moving Average Convergence/Divergence
          • Awesome Oscillator
          • Accelerator Oscillator
          • %R Larry Williams
          • Momentum
          • Rate of Change
          • Commodity Channel Index
        • Moving averages
          • Exponential Moving Average
          • Simple moving average
        • Volatility
          • Average True Range
          • Standard deviation
        • Trend
          • ZigZag
        • Volume
          • Delta Flow
      • Drawing tools
      • Volume Analysis Tools | Volume Profiles | Footprint chart | VWAP
        • Cluster chart
        • Volume profiles
        • Time statistics
        • Time histogram
        • Historical Time & Sales
      • Power Trades
      • VWAP | Volume Weighted Average Price
    • Watchlist
    • Time & Sales
    • Price Statistic
    • DOM Surface
    • Option Analytics
    • TPO Profile Chart
  • Trading panels
    • Order Entry
      • Order Types
    • DOM Trader
    • Market depth
    • Trading simulator
    • Market Replay (History Player)
    • FX Cell
  • Portfolio panels
    • Positions
    • Working Orders
    • Trades
    • Orders History
    • Synthetic Symbols
    • Historical Symbols
  • Information panels
    • Account info
    • Symbol Info
    • Event Log
    • RSS
    • Reports
  • Miscellaneous
    • History Exporter
    • Market heat map
    • Stat matrix
    • Exchange times
    • Quote Board
    • Excel and RTD function
  • Algo
    • Introduction
    • Install for Visual Studio
    • Simple Indicator
    • Input Parameters
    • Built-In indicators access
    • Indicator with custom painting (GDI)
    • Using markers with indicators
    • Adding a custom indicator to Watchlist
    • Downloading history
    • Simple strategy
    • Access to trading portfolio
    • Trading operations
    • Example: Simple Moving Average
Powered by GitBook
On this page
  • General
  • What is input parameter?
  • Types of Input Parameters
  • Text
  • Boolean
  • Number
  • Symbol
  • Account
  • DateTime
  • Color
  • List with options
  • Conclusion

Was this helpful?

  1. Algo

Input Parameters

Modify your indicators or strategies behavior using a set of Input parameters

PreviousSimple IndicatorNextBuilt-In indicators access

Last updated 5 years ago

Was this helpful?

General

In the previous topic, we showed you using Visual Studio with OptimusFLOW Algo extension and use it on the chart in the trading platform. We created a Simple Moving Average indicator with hardcoded parameters. But what if we need to change these parameters? For example, we want to use Open prices instead of Close or use another Period. It is not very convenient to recompile your indicator each time and we provide you a possibility of easy tuning your scripts via so-called Input Parameters.

What is input parameter?

After adding an indicator on the chart you can find Setting menu item on it displaying "Settings" window. Indicators usually have some common settings, for customizing lines, and specific settings, that related to their algorithm or calculations.

You can create any amount of input parameters, needed in your scripts. They can be used both for indicators and strategies.

From a technical point of view, Input Parameter is a usual variable marked with a special attribute. At the moment we support main basic types: string, number, date time, account, symbol, a list of options and others.

We will show in details how to declare each type of input parameters and how to customize them.

Types of Input Parameters

Text

Sometimes you may need a user to provide some text information, for example for displaying on the chart. For this, you need to declare a string variable and mark it as InputAttribute. You need to specify the name of an input parameter, which will be displayed in Settings screen:

[InputParameter("Text")]
public string text;

If you call settings screen you will see text box, which you can use to enter a value. That's all - your first input parameter is ready:

If you have a few input parameters and want to arrange them in an appropriate order, you can apply SortIndex parameter for each InputParameter:

[InputParameter("First text", 1)]
public string firstText;

[InputParameter("Second text", 2)]
public string secondText;

[InputParameter("Third text", 3)]
public string thirdText;

As you can see, parameters displayed in specified order:

Boolean

In case you need a simple switcher, for example, to enable an option, you can use bool variable with an InputParameter attribute:

[InputParameter("Boolean")]
public bool boolean;

Number

One of the most important types of input parameters is numbers. Input parameters can be applied to int, double, long and decimal variables:

[InputParameter("Integer")]
public int intNumber;

You can specify additional parameters - minimum/maximum value, increment, and decimal places.

[InputParameter("Double", 0, 0.00001, 10, 0.00001, 5)]
public double doubleNumber;

Symbol

Sometimes you may need possibility so select symbol, for example in case of calculation of correlation between symbol from the chart and another symbol. And again - all you need just declare variable and mark in with InputParameter attribute:

[InputParameter("Symbol")]
public Symbol symbol;

Account

If your script is executing some trading operation you need to provide an account setting. Use a variable of Account type for this:

[InputParameter("Account")]
public Account account;

DateTime

Usually, DateTime settings are using to specify some range of history, for example, left and right border of downloaded history:

[InputParameter("Date")]
public DateTime dateTime;

Color

Color Input Parameters store color value in an RGB format:

[InputParameter("Color")]
public Color color;

List with options

List with options Input parameter allows to select the value from the predefined list of possible states

[InputParameter("Simple price types list", 1, variants: new object[]{
    "Close", PriceType.Close,
    "Open", PriceType.Open,
    "High", PriceType.High,
    "Low", PriceType.Low,
    "Typical", PriceType.Typical,
    "Median", PriceType.Median,
    "Weighted", PriceType.Weighted
})]

Conclusion

To summarize all said above, we gathered all types of Input Parameters to show you how they can look in settings screen:

These basic types of Input parameters are enough to create complex indicators and strategies with a wide list of settings. Despite this, we are constantly adding new Input Parameter types. Feel free to contact us and propose your variants — we are open to our users' feedback.

how to create a basic indicator
An example of text input parameter in indicator "Settings" screen
Sorted Input Parameters
All type of Input Parameters