SetPlotColor: Difference between revisions
From MultiCharts
(→Usage) |
No edit summary |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Assigns a specified color to the specified plot for the duration of the current bar. | Assigns a specified [[:Category:Colors|color]] to the specified [[Plot|plot]] for the duration of the current bar. | ||
== Usage == | |||
<syntaxhighlight>SetPlotColor(PlotNumber, PlotColor)</syntaxhighlight> | |||
== Parameters == | |||
:'''PlotNumber''' - a numerical expression specifying the plot number; plot numbers range from 1 to 999. | |||
:'''PlotColor''' - an expression specifying the plot color. | |||
[[ | Plot color can be specified by a numerical expression representing an [[RGB|RGB color number]] or a [[LegacyColorValue|legacy color value]], or by one of 17 [[:Category:Colors|base color words]]. | ||
== Notes == | |||
* Use [[GetPlotColor]] to get the color of a specified [[Plot|plot]]. | |||
* Use [[SetPlotBGColor]] to set the color of a plot, and refer to the [[GetBackgroundColor]] function to get the background [[:Category:Colors|color]]. | |||
== | == Examples == | ||
Assign the color of blue to plot1 for the duration of the current bar: | Assign the color of [[Blue|blue]] to plot1 for the duration of the current bar: | ||
<syntaxhighlight>SetPlotColor(1,Blue);</syntaxhighlight> | <syntaxhighlight>SetPlotColor(1, Blue);</syntaxhighlight> | ||
Assign RGB color 2138336 (Orange) to plot1 for the duration of the current bar: | Assign [[RGB|RGB color]] 2138336 (Orange) to plot1 for the duration of the current bar: | ||
<syntaxhighlight>SetPlotColor(1,2138336);</syntaxhighlight> | <syntaxhighlight>SetPlotColor(1, 2138336);</syntaxhighlight> | ||
Assign legacy color 4 (Green) to plot1 for the duration of the current bar: | Assign [[LegacyColorValue|legacy color]] 4 (Green) to plot1 for the duration of the current bar: | ||
<syntaxhighlight>[LegacyColorValue=True]; | <syntaxhighlight>[LegacyColorValue = True]; | ||
SetPlotColor(1, 4);</syntaxhighlight> | |||
[[Category:Plotting]] | [[Category:Plotting]] | ||
Latest revision as of 13:50, 19 February 2012
Assigns a specified color to the specified plot for the duration of the current bar.
Usage
SetPlotColor(PlotNumber, PlotColor)Parameters
- PlotNumber - a numerical expression specifying the plot number; plot numbers range from 1 to 999.
- PlotColor - an expression specifying the plot color.
Plot color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.
Notes
- Use GetPlotColor to get the color of a specified plot.
- Use SetPlotBGColor to set the color of a plot, and refer to the GetBackgroundColor function to get the background color.
Examples
Assign the color of blue to plot1 for the duration of the current bar:
SetPlotColor(1, Blue);Assign RGB color 2138336 (Orange) to plot1 for the duration of the current bar:
SetPlotColor(1, 2138336);Assign legacy color 4 (Green) to plot1 for the duration of the current bar:
[LegacyColorValue = True];
SetPlotColor(1, 4);