CDXYSetBarColorDP < Main

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

_This subroutine sets the color of the bar at the "current" 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:DP
      *        Check for error 
      IF       0CD .XY SET BAR CLR:DP         NE</pre>
---++ Description:

Sets the color of the bars at the "current" 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.

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

If you do not pass the &lt;data_point_no&gt;, then it will try to set the color for the "current" data point. This is only valid after adding a data point via [[CDPointAddNew][.POINT ADD NEW]]. Note that you can set the colors before you add the data by supplying the &lt;data_point_no&gt;. The first data point you add via [[CDPointAddNew][.POINT ADD NEW]] will be 1, the second 2, and so on. If you have used this routine to add the bar colors by data point in advance, then the bars will have those colors when the chart is rendered.

You can set the color for 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]]. See also [[CDXYSetBarColor][.XY SET BAR CLR]].

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: r6 - 2012-02-24 - JeanNeron