Go Back   NinjaTrader Support Forum > NinjaScript Educational Resources > Tips

Tips Official NinjaScript tips and tricks

NinjaTrader
Reply
 
Thread Tools Display Modes
Old 02-23-2008, 06:02 AM   #1
NinjaTrader_JoshP
NinjaTrader Product Manager
 
NinjaTrader_JoshP's Avatar
 
Join Date: May 2007
Location: Denver, CO
Posts: 17,459
Thanks: 1
Thanked 363 times in 106 posts
Default Creating User Defined Input Parameters

Applies to: NinjaTrader 7

You can create user defined input parameters for both NinjaScript Indicators and Strategies. Although user defined input parameters can be specified as part of the initial set up of NinjaScript Indicator or Strategies using the Wizard you may have a requirement to add new parameters at a later point in your development process. To create these parameters you will need to edit your NinjaScript code and follow these steps.
  1. Open your NinjaScript file
  2. Expand the minimized “Variables” section of your code and create a private variable for your parameter
    Code:
    private int period = 5;
    Note: This is also where you set the default value for your parameter.
  3. Scroll down to the bottom of the editor and expand the minimized “Properties” section by clicking on the + sign on the left.
  4. Use the following template code for each parameter you wish to create
    Code:
    [Description("Numbers of bars used for calculations")]
    [GridCategory("Parameters")]
    public int Period
    {
         get { return period; }
         set { period = Math.Max(1, value); }
    }
    Note: In the "get" and "set" lines make sure you use the private variable you created in step 2.
  5. Use the "Description" field to provide a brief description of what the parameter does. Use the “GridCategory” field to group similar parameters together
  6. Pay attention to this line as the object type will vary depending on the type of parameter you wish to make:
    Code:
    public int Period
  7. In the "set" line, simply set it to “value” if you do not wish to create a lower bound for the parameter
    Code:
    set { period = value; }
    Note: If you wish to set an upper bound use Math.Min()
    Code:
    set { period = Math.Min(25, value); }
  8. Now, wherever in your code you want to call the user-definable parameter, just use "Period".
    Code:
    if (SMA(Period)[0] > SMA(Period)[1])
         // Do something
Last edited by NinjaTrader_Jesse; 06-03-2015 at 03:46 PM.
NinjaTrader_JoshP is offline  
Reply With Quote
The following 8 users say thank you to NinjaTrader_JoshP for this post:
Old 06-03-2015, 02:48 PM   #2
NinjaTrader_ZacharyG
NinjaTrader Customer Service
 
NinjaTrader_ZacharyG's Avatar
 
Join Date: Apr 2015
Posts: 1,708
Thanks: 55
Thanked 378 times in 361 posts
Default

Applies to NinjaTrader 8

You can create user defined input parameters for both NinjaScript Indicators and Strategies. Although user defined input parameters can be specified as part of the initial set up of NinjaScript Indicator or Strategies using the Wizard you may have a requirement to add new parameters at a later point in your development process. To create these parameters you will need to edit your NinjaScript code and follow these steps.
  1. Open your NinjaScript file
  2. Inside of the if (State == State.SetDefaults) statement, assign a value to the variable for your parameter
    Code:
    Period = 5;
    Note: This is also where you set the default value for your parameter.
  3. Scroll down to the bottom of the editor and expand the minimized “Properties” section by clicking on the + sign on the left.
  4. Use the following template code for each parameter you wish to create. Please note that the type (int, double, etc) will differ depending on what type of variable you wish to create
    Code:
    [Range(1, int.MaxValue)]
    [NinjaScriptProperty]
    [Display(Name="Period", Description="Numbers of bars used for calculations", Order=1, GroupName="Parameters")]
    public int Period
    { get; set; }
  5. To specify lower and upper bounds, you would modify [Range(1, int.MaxValue)]. For example:
    Code:
    // No upper bound, lower bound of 1
    [Range(1, int.MaxValue)]
    
    // No lower bound, upper bound of 100
    [Range(int.MinValue, 100)]
    
    // No lower or upper bound
    [Range(int.MinValue, int.MaxValue)]
  6. Use the "Description" field to provide a brief description of what the parameter does.
  7. Pay attention to this line as the object type will vary depending on the type of parameter you wish to make:
    Code:
    public int Period
  8. Now, wherever in your code you want to call the user-definable parameter, just use "Period".
    Code:
    if (SMA(Period)[0] > SMA(Period)[1])
         // Do something
Last edited by NinjaTrader_Jesse; 06-11-2015 at 07:16 AM.
NinjaTrader_ZacharyG is offline  
Reply With Quote
The following 2 users say thank you to NinjaTrader_ZacharyG for this post:
Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Creating parameters for user input NinjaTrader_JoshP Indicator Development 13 08-12-2010 02:47 AM
NYSE-TRIN as user defined input alfie Strategy Development 4 10-30-2007 04:44 PM
user defined class? Folls Strategy Development 4 10-16-2007 06:33 PM
Indicator: Creating a user-defined parameter type (enum) NinjaTrader_JoshP Reference Samples 0 09-24-2007 09:12 PM
Maximum number of user defined inputs Folls Indicator Development 1 05-03-2007 07:58 AM


All times are GMT -6. The time now is 11:50 AM.

Futures, foreign currency and options trading contains substantial risk and is not for every investor. An investor could potentially lose all or more than the initial investment. Risk capital is money that can be lost without jeopardizing ones financial security or lifestyle. Only risk capital should be used for trading and only those with sufficient risk capital should consider trading. Past performance is not necessarily indicative of future results. View Full Risk Disclosure.

CFTC Rules 4.41 - Hypothetical or Simulated performance results have certain limitations, unlike an actual performance record, simulated results do not represent actual trading. Also, since the trades have not been executed, the results may have under-or-over compensated for the impact, if any, of certain market factors, such as lack of liquidity. Simulated trading programs in general are also subject to the fact that they are designed with the benefit of hindsight. No representation is being made that any account will or is likely to achieve profit or losses similar to those shown.

This website is hosted and operated by NinjaTrader, LLC (“NT”), a software development company which owns and supports all proprietary technology relating to and including the NinjaTrader trading platform. NT is an affiliated company to NinjaTrader Brokerage (“NTB”), which is a NFA registered introducing broker (NFA #0339976) providing brokerage services to traders of futures and foreign exchange products. This website is intended for educational and informational purposes only and should not be viewed as a solicitation or recommendation of any product, service or trading strategy. No offer or solicitation to buy or sell securities, securities derivative or futures products of any kind, or any type of trading or investment advice, recommendation or strategy, is made, given, or in any manner endorsed by any NT affiliate and the information made available on this Web site is not an offer or solicitation of any kind. Specific questions related to a brokerage account should be sent to your broker directly. The content and opinions expressed on this website are those of the authors and do not necessarily reflect the official policy or position of NT or any of its affiliates. 

Vendors along with their websites, products and services, collectively referred to as (“Vendor Content”), are independent persons or companies that are in no manner affiliated with NT or any if its affiliates. NT or any of its affiliates are not responsible for, do not approve, recommend or endorse any Vendor Content referenced on this website and it’s your sole responsibility to evaluate Vendor Content. Please be aware that any performance information provided by a vendor should be considered hypothetical and must contain the disclosures required by NFA Rule 2-29(c). If you are interested in learning more about, or investigating the quality of, any such Vendor Content you must contact the vendor, provider or seller of such Vendor Content. No person employed by, or associated with, NT or any of its affiliates is authorized to provide any information about any such Vendor Content.