CDXYSetBarColor < Main

Tags: view all tags
---+ .XY SET BAR CLR

_This subroutine sets the color of the bars at the current level or at the data point._

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

Sets the color of the bars at the current level or at the specified data point. You must have initialized the chart as an XY Chart via [[CDChartInitialize][.CHART INITIALIZE]] and added a bar layer via [[CDXYAddBarLayer][.XY ADD BAR LAYER]] for this to have any effect.

This routine receives two optional parameters. The first parameter is either a &lt;color_spec_name&gt; or a &lt;color_value&gt;.
<div id="_mcePaste">The second parameter is the index number of the data point to set the color of.</div>

<div id="_mcePaste">If a data point is passed, the color is set for that bar. If nothing is passed, then the color applies to:</div>

- the current data set template if there is one, or

- the current data group if there is one, or

- the current bar layer, if there is one.

You can set the color for the current data point via [[CDXYSetBarColorDP][.XY SET BAR CLR:DP]], or the current data set template via [[CDXYSetBarColorDS][.XY SET BAR CLR:DS]], or the current data group via [[CDXYSetBarColorDG][.XY SET BAR CLR:DG]] or the current data layer via [[[[CDXYSetBarColorLR][.XY SET BAR CLR:LR]].

After setting the bar color, the bar spec becomes the "current" color spec.

See ColorSpec for more information on working with colors.

See [[CDOverviewDatasetDefinition][Datasets Overview]] for more information on data sets, data groups, and layers.
---++ Comments:

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

<br />%COMMENT%

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