CDXYSetPlotAreaBGColor < Main

Tags: view all tags
---+ .XY SET PA BG CLR

_This subroutine sets the background colors of the "current" chart spec._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;color_spec_name&gt;          FIELD            SHARE? N
      *        OR
      PASS         &lt;color_value&gt;              FIELD            SHARE? N
      PASS         &lt;color_spec_name&gt;          FIELD            SHARE? N
      *        OR
      PASS         &lt;color_value&gt;              FIELD            SHARE? N
      GOSUB    0CD .XY SET PA BG CLR
      *        Check for error
      IF       0CD .XY SET PA BG CLR          NE</pre>
---++ Description:

This subroutine set the background colors of the chart area for the "current" chart spec. You must have initialized the chart as an XY Chart via [[CDChartInitialize][.CHART INITIALIZE]] for this to have any effect. This routine receives two, optional values specifying either a &lt;color_spec_name&gt; or a &lt;color_value&gt;.

If a parameter is not received or if the value received is blank, then the background colors of the chart spec are cleared and the default background colors will be rendered. If a second color is passed, it will be alternated with the first color.

If a parameter is received, the system first assumes that the value received is a &lt;color_spec_name&gt; and checks to see if a color spec record has been previously initialized with that name. If a color spec record is found, then that color spec record is used as a prototype to create a color spec for the background color. If a color spec record is not found, then the system assumes that the value received is a literal &lt;color_value&gt; and uses the specified color to create a color spec for the background color.

After setting the background colors, the first background color spec becomes the "current" color spec.

See ColorSpec for more information on working with colors.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2011-10-11
Topic revision: r5 - 2012-02-24 - JeanNeron