Difference between revisions of "MaxPositionProfit"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
Returns a numerical value, indicating the largest gain reached while the specified position was held. | Returns a numerical value, indicating the largest gain reached while the specified position was held. | ||
− | + | == Usage == | |
<syntaxhighlight>MaxPositionProfit(PosBack)</syntaxhighlight> | <syntaxhighlight>MaxPositionProfit(PosBack)</syntaxhighlight> | ||
− | Where | + | Where: |
− | 0 - open position; | + | :'''PosBack''' - a numerical expression, specifying the position: |
+ | |||
+ | ::'''0''' - open position; | ||
− | 1 - one position back (the last position closed); | + | ::'''1''' - one position back (the last position closed); |
− | 2 - two positions back, etc. | + | ::'''2''' - two positions back, etc. |
− | If | + | If '''PosBack''' is not specified, a value for the open position will be returned. |
− | + | == Notes == | |
− | This function can only be used in signals. | + | * This function can only be used in signals. |
− | + | * Use [[MaxPositionLoss]] to get the largest loss for the specified position. | |
− | + | * Use [[MaxContractProfit]] to get the largest gain for a specified position per contract. | |
− | |||
− | |||
− | |||
− | |||
− | |||
+ | == Example == | ||
+ | <syntaxhighlight>MaxPositionProfit</syntaxhighlight> | ||
+ | Will return a value of 0 if the value of the open position has not increased at any time while it was held. | ||
+ | <syntaxhighlight>MaxPositionProfit(1)</syntaxhighlight> | ||
+ | Will return a value of 10 if the most recently closed position has gained in value as much as $10 while it was held. | ||
[[Category:Strategy Position]] | [[Category:Strategy Position]] |
Revision as of 10:00, 9 February 2012
Returns a numerical value, indicating the largest gain reached while the specified position was held.
Usage
MaxPositionProfit(PosBack)
Where:
- PosBack - a numerical expression, specifying the position:
- 0 - open position;
- 1 - one position back (the last position closed);
- 2 - two positions back, etc.
If PosBack is not specified, a value for the open position will be returned.
Notes
- This function can only be used in signals.
- Use MaxPositionLoss to get the largest loss for the specified position.
- Use MaxContractProfit to get the largest gain for a specified position per contract.
Example
MaxPositionProfit
Will return a value of 0 if the value of the open position has not increased at any time while it was held.
MaxPositionProfit(1)
Will return a value of 10 if the most recently closed position has gained in value as much as $10 while it was held.