setShowCursorLabel()

eSignal EFS 2

setShowCursorLabel()

Top  Previous  Next

 

setShowCursorLabel( boolean )

 

This function controls whether or not the script return values are displayed in the eSignal cursor window. When setShowCursorLabel(false) is used, it will suppress the display of the return values in the cursor window. Note that the values returned by the script will still be plotted on the chart, they just will not be displayed in the cursor window.

 

Parameters

 

boolean

true or false

 

Usage

 

function preMain() {

 

       //we want this script to plot its results in the

       //price pane

       setPriceStudy(true);

 

       setStudyTitle("Example Script");

 

       //this script returns 3 values to be plotted on the chart.

       //use setCursorLabelName() to set a name for each return

       //value

 

       setCursorLabelName("EMA", 0);

       setCursorLabelName("SMA", 1 );

       setCursorLabelName("WMA", 2 );

 

       setDefaultBarFgColor( Color.blue, 0 );

       setDefaultBarFgColor( Color.red, 1 );

       setDefaultBarFgColor( Color.green, 2 );

 

       //if we wanted to suppress the display of the 3 return values

       //defined above, we could use the following call

       setShowCursorLabel(false);

 

       setShowTitleParameters( false );

 

 

}