Menu
Menu functions are used for creating a menu to be displayed in the toolbar of a chart.
Sections
Name |
Description |
Adds a checkbox menu item to a specified menu/submenu with two possible options to be displayed based on whether the checkbox is checked or not. |
|
Adds a checkbox menu item to a specified menu/submenu with two possible options to be displayed based on whether the checkbox is checked or not. |
|
Adds a combobox menu item to a specified menu/submenu with multiple possible values that can be selected. |
|
Adds a combobox menu item to a specified menu/submenu with multiple possible values that can be selected. |
|
Adds a heading below a specified menu/submenu item. |
|
Adds an integer picker menu item to a specified menu/submenu. |
|
Adds an integer picker menu item to a specified menu/submenu. |
|
Adds a decimal number picker menu item to a specified menu/submenu. |
|
Adds a decimal number picker menu item to a specified menu/submenu. |
|
Adds a separator below a specified menu item. |
|
Creates a submenu to the top menu or to another submenu. |
|
Creates a submenu to the top menu or to another submenu. |
|
Adds a text item below a specified menu item. |
|
Adds a text item below a specified menu item. |
|
Creates the top menu object to be displayed in the toolbar. |
|
Creates the top menu object to be displayed in the toolbar. |
|
Deletes a specified menu item. |
|
Gets the selected value of a specified checkbox. |
|
Gets the selected value of a specified combobox. |
|
Gets the value from a specified integer picker. |
|
Gets the number value from a specified number picker. |
|
Gets the parent menu item of a specified menu item or -1 if the menu item has no parent or doesn't exist. |
|
Determines whether a specified menu item is visible or not. Returns true if the menu item is visible, false otherwise. |
|
Indicates whether the menu has been initialized. |
|
Sets whether a specified menu item is visible or not. |
int MenuAddCheckbox(int parentMenuItemId, string label, string option1Label, int option1Value, string option2Label, int option2Value, bool autoRebuild, int defaultOptionValue) |
|||||||||||||||||||||||||||
Adds a checkbox menu item to a specified menu/submenu with two possible options to be displayed based on whether the checkbox is checked or not. Returns The ID of the newly created checkbox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddCheckboxRGB(int parentMenuItemId, string label, string option1Label, int option1Value, string option2Label, int option2Value, bool autoRebuild, int defaultOptionValue, int[] labelColorRGBA, int[] option1LabelColorRGBA, int[] option2LabelColorRGBA) |
||||||||||||||||||||||||||||||||||||
Adds a checkbox menu item to a specified menu/submenu with two possible options to be displayed based on whether the checkbox is checked or not. Returns The ID of the newly created checkbox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddCombobox(int parentMenuItemId, string label, string[] options, int[] values, int defaultValue, bool autoRebuild) |
|||||||||||||||||||||
Adds a combobox menu item to a specified menu/submenu with multiple possible values that can be selected. Returns The ID of the newly created combobox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddComboboxRGB(int parentMenuItemId, string label, string[] options, int[] values, int defaultValue, bool autoRebuild, int[] labelColorRGBA) |
||||||||||||||||||||||||
Adds a combobox menu item to a specified menu/submenu with multiple possible values that can be selected. Returns The ID of the newly created combobox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddHeader(int parentMenuItemId, string heading) |
|||||||||
Adds a heading below a specified menu/submenu item. Returns The ID of the newly created header. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddInteger(int parentMenuItemId, string label, int defaultValue, int min, int max) |
||||||||||||||||||
Adds an integer picker menu item to a specified menu/submenu. Returns The ID of the newly created integer picker menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddIntegerRGB(int parentMenuItemId, string label, int defaultValue, int min, int max, int[] labelColorRGBA) |
|||||||||||||||||||||
Adds an integer picker menu item to a specified menu/submenu. Returns The ID of the newly created integer picker menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddNumber(int parentMenuItemId, string label, double defaultValue, double min, double max) |
||||||||||||||||||
Adds a number picker menu item to a specified menu/submenu. Returns The ID of the newly created number picker menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddNumberRGB(int parentMenuItemId, string label, double defaultValue, double min, double max, int[] labelColorRGBA) |
|||||||||||||||||||||
Adds a number picker menu item to a specified menu/submenu. Returns The ID of the newly created number picker menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddSeparator(int parentMenuItemId) |
||||||
Adds a separator below a specified menu item. Returns The ID of the newly created separator. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddSubMenu(int parentMenuItemId, string label) |
|||||||||
Creates a submenu to the top menu or to another submenu. Returns The ID of the newly created submenu. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddSubMenuRGB(int parentMenuItemId, string label, int[] labelColorRGB) |
||||||||||||
Creates a submenu to the top menu or to another submenu. Returns The ID of the newly created submenu. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddText(int parentMenuItemId, string text, bool autoRebuild) |
||||||||||||
Adds a text item below a specified menu item. Returns The ID of the newly created text item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuAddTextRGB(int parentMenuItemId, string text, bool autoRebuild, int[] textColorRGBA) |
|||||||||||||||
Adds a text item below a specified menu item. Returns The ID of the newly created text item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuCreate(string label) |
||||||
Creates the top menu object to be displayed in the toolbar. Returns The ID of the newly created menu object. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuCreateRGB(string label, int[] labelColorRGBA) |
|||||||||
Creates the top menu object to be displayed in the toolbar. Returns The ID of the newly created menu object. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
MenuDelete(int menuItemId) |
||||||
Deletes a specified menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuGetCheckboxValue(int menuItemId) |
||||||
Gets the selected value of a specified checkbox. Returns The checkbox value of the specified checkbox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuGetComboboxValue(int menuItemId) |
||||||
Gets the selected value of a specified combobox. Returns The combobox value of the specified combobox menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuGetIntegerValue(int menuItemId) |
||||||
Gets the value from a specified integer picker. Returns The value of the specified integer menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuGetNumberValue(int menuItemId) |
||||||
Gets the value from a specified number picker. Returns The value of the specified number menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
int MenuGetParentMenuId(int menuItemId) |
||||||
Gets the parent menu item of a specified menu item or -1 if the menu item has no parent or doesn't exist. Returns The parent menu id of the specified menu item. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
bool MenuGetVisibility(int menuItemId) |
||||||
Determines whether a specified menu item is visible or not. Returns true if the menu item is visible, false otherwise. Returns True if the menu is visible, false otherwise. Parameters
Scripts Indicator, Signal, Pattern, Drawing |
MenuIsInitialized() |
Indicates whether the menu has been initialized. Returns True if the menu has been initialized, false otherwise. Scripts Indicator, Signal, Pattern, Drawing |
MenuSetVisibility(int menuItemId, bool visible) |
|||||||||
Sets whether a specified menu item is visible or not. Parameters
Scripts Indicator, Signal, Pattern, Drawing |