Difference between revisions of "Portfolio CalcMaxPotentialLossForEntry"
Jump to navigation
Jump to search
(→Usage) |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Calculates and returns maximum potential loss (not including margin, | + | Calculates and returns the maximum potential loss (not including margin, commission or slippage) if the user entered the position with the number of [[Contracts]] and [[EntryPrice|Price of entry]]. |
| − | + | == Usage == | |
| + | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (Side <,Contracts <,Price>>);</syntaxhighlight> | ||
| − | + | Parameters inside the angled brackets are optional - if these aren't defined, the default is used. | |
| − | Side | + | == Parameters == |
| + | :'''Side''' - a numerical expression specifying the entry type (e.g. 1 Long entry or -1 Short entry). | ||
| + | :'''Contracts''' - an optional parameter specifying the number of contracts. | ||
| + | ::If the Contracts parameter is not specified then the number of contracts indicated in the [[Portfolio Settings|Format Settings]] dialog window under the '''Properties''' tab is used by default. | ||
| + | :'''Price''' - an optional parameter specifying the price value. | ||
| + | ::If the Price parameter is not specified, then the [[Close]] price value of the current bar will be used by default. This parameter can be rounded down if entered a Short position or rounded up if entered a Long position. | ||
| − | + | == Notes == | |
| + | This function can only be used in signals intended to be used with the Portfolio Trader. | ||
| − | + | The value is returned in the currency specified in Portfolio Trader: '''Portfolio Settings -> Base Currency.''' | |
| − | == | + | == Examples == |
| − | + | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (0, 25, High)</syntaxhighlight> | |
| − | + | Will return a value of 0, since the parameter ''Side'' is 0. | |
| − | + | ||
| − | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (0, 25, High) | + | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (1, 100, Close)</syntaxhighlight> |
| − | Side | + | Will return the maximum potential loss (not including margin, commission or slippage) if user entered a Long position for 100 contracts at the Close price. |
| + | |||
| + | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (-1, 5, Open)</syntaxhighlight> | ||
| + | Will return the maximum potential loss (not including margin, commission or slippage) if user entered a Short position for 5 contracts at the Open price. | ||
| − | Portfolio_CalcMaxPotentialLossForEntry (1 | + | <syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (1)</syntaxhighlight> |
| − | (not including margin, | + | Will return the maximum potential loss (not including margin, commission or slippage) if the user entered a Long position for a number of contracts indicated in the Format Settings dialog window under the Properties tab at the Close price. |
| − | the Close price. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category:Portfolio Strategy Position]] | [[Category:Portfolio Strategy Position]] | ||
Latest revision as of 18:57, 24 July 2014
Calculates and returns the maximum potential loss (not including margin, commission or slippage) if the user entered the position with the number of Contracts and Price of entry.
Contents
Usage
Portfolio_CalcMaxPotentialLossForEntry (Side <,Contracts <,Price>>);
Parameters inside the angled brackets are optional - if these aren't defined, the default is used.
Parameters
- Side - a numerical expression specifying the entry type (e.g. 1 Long entry or -1 Short entry).
- Contracts - an optional parameter specifying the number of contracts.
- If the Contracts parameter is not specified then the number of contracts indicated in the Format Settings dialog window under the Properties tab is used by default.
- Price - an optional parameter specifying the price value.
- If the Price parameter is not specified, then the Close price value of the current bar will be used by default. This parameter can be rounded down if entered a Short position or rounded up if entered a Long position.
Notes
This function can only be used in signals intended to be used with the Portfolio Trader.
The value is returned in the currency specified in Portfolio Trader: Portfolio Settings -> Base Currency.
Examples
Portfolio_CalcMaxPotentialLossForEntry (0, 25, High)
Will return a value of 0, since the parameter Side is 0.
Portfolio_CalcMaxPotentialLossForEntry (1, 100, Close)
Will return the maximum potential loss (not including margin, commission or slippage) if user entered a Long position for 100 contracts at the Close price.
Portfolio_CalcMaxPotentialLossForEntry (-1, 5, Open)
Will return the maximum potential loss (not including margin, commission or slippage) if user entered a Short position for 5 contracts at the Open price.
Portfolio_CalcMaxPotentialLossForEntry (1)
Will return the maximum potential loss (not including margin, commission or slippage) if the user entered a Long position for a number of contracts indicated in the Format Settings dialog window under the Properties tab at the Close price.
