setShowCursorLabel()

ICE Data Services -

setShowCursorLabel() preMain Functions

This function controls whether or not the script's return values are displayed in the Advanced Chart cursor window. When setShowCursorLabel(false) is used, it will not display any of the cursor labels for the return values in the cursor window.  If a series index value is specified, only the specified index will be turned off.

Syntax
setShowCursorLabel( Boolean [, nSeriesIndex ] )

Parameters
Parameter: Description:Default:
Boolean Required.  Enter true/false

 

n/anSeriesIndex [Optional]  Series index from return array.

 

n/a
Return Value(s)
N/A

Notes
T
he values returned by the formula will still be plotted on the chart, they just will not be displayed in the cursor window.

If the nSeriesIndex parameter is not specified, then all cursor labels will be turned on/off.


Code Examples
// turn off all cursor labelsfunction preMain() {	setPriceStudy(true);	setCursorLabelName("high", 0);	setCursorLabelName("low", 1);	setShowCursorLabel(false);	  }function main() {	return new Array(high(0), low(0));		}// turn off specific cursor labelsfunction preMain() {	setPriceStudy(true);	setCursorLabelName("high", 0);	setCursorLabelName("low", 1);	setShowCursorLabel(false, 1);	  }function main() {	return new Array(high(0), low(0));		}



See Also
preMain Functions
eSignal Bulletin Board Search Engine
Help Guides
Tutorials