Common
The following section documents methods and properties available to every NinjaScript type that access various forms of data including bar data, price data, and statistical forms of data. The Common section is broken into several categories pertaining to distinct NinjaScript objects or concepts. An index of topics under the Common section can be found below:
| Category | Description |
|---|---|
| Attributes | Documents both .NET native and NinjaScript custom attributes which are commonly used to define the behavior of a NinjaScript property or object |
| Alert, Debug, Share | Documents methods for triggering alerts, printing debug messages, and using Share Services |
| Analytical | Documents methods and properties useful for analyzing and identifying specific conditions within Series\<t\> collections |
| Bars | Represents the data returned from the historical data repository |
| Charts | Covers information related to accessing chart related data |
| Drawing | Documents the drawing of custom shapes, lines, text and colors on your price and indicator panels from both Indicators and Strategies |
| Instrument | Represents an instance of a Master Instrument |
ISeries\<t\> | Documents the interface that is implemented by all NinjaScript classes that manage historical data as an ISeries\<double\> used for indicator input, and other object data |
| OnBarUpdate() | An event driven method which is called whenever a bar is updated |
| OnFundamentalData() | An event driven method which is called for every change in fundamental data |
| OnMarketDepth() | An event driven method which is called and guaranteed to be in the correct sequence for every change in level two market data |
| OnStateChange() | An event driven method which is called whenever the script enters a new State |
| SessionIterator | An interface which allows you to traverse through various trading hours data elements which apply to a segment of bars |
| System Indicator Methods | Documents syntax and return values for system indicator methods |
| TradingHours | Represents the Trading Hours information returned from the current bars series |
| Name | Determines the listed name of the NinjaScript object |
| IsVisible | Determines if the current NinjaScript object should be visible on the chart |
| DisplayName | Determines the text display on the chart panel |
| Description | Text which is used on the UI’s information box to be display to a user when configuration a NinjaScript object |
| Clone() | Used to override the default NinjaScript Clone() method which is called any time an instance of a NinjaScript object is created |
| TriggerCustomEvent() | Provides a way to use your own custom events (such as a Timer object) so that internal NinjaScript indexes and pointers are correctly set prior to processing user code triggered by your custom event |