BarBuilder
BarBuilder functions are used exclusively from Bar Type scripts in order to build custom bar types.
Read more: Bar Type Scripts
Sections
Name |
Description |
Commits the current bar being built and start a new one. |
|
Gets the close of the current bar being built. |
|
Gets the end date/time of the current bar being built. |
|
Gets the high of the current bar being built. |
|
Determines whether the current bar is missing (true) or not (false). |
|
Gets the low of the current bar being built. |
|
Gets the open of the current bar being built. |
|
Gets the open interest of the current bar being built. |
|
Gets the start date/time of the current bar being built. |
|
Gets the volume of the current bar being built. |
|
Merges a specified tick with the current bar being built. |
|
Sets the close of the current bar being built. |
|
Sets the end date/time of the current bar being built. |
|
Sets the high of the current bar being built. |
|
Sets whether the current bar being built is missing. |
|
Sets the low of the current bar being built. |
|
Sets the open of the current bar being built. |
|
Sets the open interest of the current bar being built. |
|
Sets the start date/time of the current bar being built. |
|
Sets the volume of the current bar being built. |
double BarBuilderGetClose() |
Gets the close of the current bar being built. Returns The close of the current bar being built. Scripts BarType |
long BarBuilderGetEndDateTime() |
Gets the end date/time of the current bar being built. Returns The end date/time of the current bar being built. Scripts BarType |
double BarBuilderGetHigh() |
Gets the high of the current bar being built. Returns The high of the current bar being built. Scripts BarType |
bool BarBuilderGetIsMissing() |
Determines whether the current bar is missing (true) or not (false). Returns True if the bar is missing, false otherwise. Scripts BarType |
double BarBuilderGetLow() |
Gets the low of the current bar being built. Returns The low of the current bar being built. Scripts BarType |
double BarBuilderGetOpen() |
Gets the open of the current bar being built. Returns The open of the current bar being built. Scripts BarType |
double BarBuilderGetOpenInterest() |
Gets the open interest of the current bar being built. Returns The open interest of the current bar being built. Scripts BarType |
long BarBuilderGetStartDateTime() |
Gets the start date/time of the current bar being built. Returns The start date/time of the current bar being built. Scripts BarType |
double BarBuilderGetVolume() |
Gets the volume of the current bar being built. Returns The volume of the current bar being built. Scripts BarType |
BarBuilderMergeTick(long dateTime, double price, long size) |
||||||||||||
Merges a specified tick with the current bar being built. Parameters
Scripts BarType |
BarBuilderSetClose(double close) |
||||||
Sets the close of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetEndDateTime(long dateTime) |
||||||
Sets the end date/time of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetHigh(double high) |
||||||
Sets the high of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetIsMissing(bool isMissing) |
||||||
Sets whether the current bar being built is missing. Parameters
Scripts BarType |
BarBuilderSetLow(double low) |
||||||
Sets the low of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetOpen(double open) |
||||||
Sets the open of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetOpenInterest(double openInterest) |
||||||
Sets the open interest of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetStartDateTime(long dateTime) |
||||||
Sets the start date/time of the current bar being built. Parameters
Scripts BarType |
BarBuilderSetVolume(long volume) |
||||||
Sets the volume of the current bar being built. Parameters
Scripts BarType |