+1 888 340 6572

SetPlotBGColor: Difference between revisions

From MultiCharts
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138)
No edit summary
Line 1: Line 1:
Assigns a specified color to the cell background for the indicated study plot for the duration of the current bar.
Assigns a specified [[:Category:Colors|color]] to the cell background for the indicated study plot for the duration of the current bar.  
Use of SetBGPlotColor is effective only for the Scanner.  


==== Usage ====
== Usage ==
<syntaxhighlight>SetPlotBGColor(PlotNumber,PlotColor)</syntaxhighlight>  
<syntaxhighlight>SetPlotBGColor(PlotNumber, PlotColor)</syntaxhighlight>  


==== Parameters ====  
== Parameters ==
[[PlotNumber]] - a numerical expression specifying the plot number; plot numbers range from 1 to 999  
:'''PlotNumber''' - a numerical expression specifying the plot number; plot numbers range from 1 to 999.
:'''PlotColor''' - an expression specifying the cell background color for the indicated plot. Cell background color for the indicated plot can be specified by a numerical expression representing an [[RGB|RGB color number]], a [[LegacyColorValue|legacy color value]], or by one of 17 [[:Category:Colors|base color words]].


[[PlotColor]] - an expression specifying the cell background color for the indicated plot. Cell background color for the indicated plot can be specified by a numerical expression representing an RGB color number, a legacy color value, or by one of 17 base color words.  
== Notes ==
* Use of SetBGPlotColor is effective only for the [[:Category:Real-Time_Market_Scanner|Market Scanner]].
* Use [[GetBackgroundColor]] to get the background color.
* Use [[SetPlotColor]] to change the plot color and [[GetPlotColor]] to get the specified plot's color.
   
   
==== Example ====
== Examples ==
Assign the color of blue to the indicated cell of the plot1 for the duration of the current bar:  
Assign the color of [[Blue|blue]] to the indicated cell of the [[Plot|plot1]] for the duration of the current bar:  


<syntaxhighlight>SetPlotBGColor(1,Blue);</syntaxhighlight>
<syntaxhighlight>SetPlotBGColor(1, Blue);</syntaxhighlight>


Assign RGB color 2138336 (Orange) to the indicated cell of the plot1 for the duration of the current bar:  
Assign [[RGB|RGB color]] 2138336 (Orange) to the indicated cell of the plot1 for the duration of the current bar:  


<syntaxhighlight>SetPlotColor(1,2138336);</syntaxhighlight>
<syntaxhighlight>SetPlotColor(1, 2138336);</syntaxhighlight>


Assign legacy color 4 (Green) to the indicated cell of the plot1 for the duration of the current bar:  
Assign [[LegacyColorValue|legacy color]] 4 (Green) to the indicated cell of the plot1 for the duration of the current bar:  
 
<syntaxhighlight>[LegacyColorValue=True];
SetPlotBGColor(1,4);</syntaxhighlight>


<syntaxhighlight>[LegacyColorValue = True];


SetPlotBGColor(1, 4);</syntaxhighlight>


[[Category:Plotting]]
[[Category:Plotting]]