(r12) CDXYAddBarLayer < Main

Tags: view all tags
---+ .XY ADD BAR LAYER

_This subroutine adds a Bar layer to the "current" chart spec._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;data_combine_method&gt;      FIELD            SHARE? N
      PASS         &lt;bar_color_style&gt;          FIELD            SHARE? N
      PASS         &lt;auto_link&gt;                FIELD            SHARE? N
      GOSUB    0CD .XY ADD BAR LAYER
      *        Check for error
      IF       0CD .XY ADD BAR LAYER          NE
</pre>
---++ Description:

This subroutine adds a Bar layer to the "current" chart spec and optionally links the "current" dataset to it, if there is one. You must have initialized the chart as an XY Chart via [[CDChartInitialize][.CHART INITIALIZE]] for this to have any effect.

This subroutine is used to add one or more bar layers to your chart. An XY chart must have at least one Layer.

This routine receives three optional values, a &lt;data_combine_method&gt;, a &lt;bar_color_style&gt; and &lt;auto_link&gt;.

If we are only going to have one data set on our chart, then the &lt;data_combine_method&gt; does not really apply. If we have multiple data sets, then the &lt;data_combine_method&gt; will determine how they will be shown. Valid values are:

side - The data sets are combined by plotting the bars side by side.

stack - The data sets are combined by stacking up the bar segments.

overlay - The data sets are combined similar to stacked bars. However, in overlay, one data set is assumed to already include the other data set. For example, if the data sets are "average" and "peak", the "peak" cannot be stacked on top of "average", because the "peak" already contains "average". In the Overlay style, only "peak - average" is stacked on top of "average", and so the total bar length will be "peak".

percentage - The data sets are combined similar to stacked bars, except that the data in a bar are scaled so that they sum to 100. In other words, all stacked bars will be of the same length. A bar segment within a bar represents the percentage of the data item relative to sum of all the data items in the stacked bar.

If blank or not passed, then each data set will be plotted in it's own layer.

&lt;bar_color_style&gt; must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that each bar can have a different color. You can set each bar via [[CDXYSetBarColor][.XY SET BAR CLR]], but if you don't Chart Director will assign unique colors automatically.

&lt;auto_link&gt; must be one of On, Off, True or False. If not passed, or set to On or True, then if you have created your data set before calling this subroutine, a default data group and data template will be created and linked to your data set automatically. This can be helpful if you only have one dataset to link. If you have multiple data sets, you might find it easier to manually create your data group ([[CDLayerAddDataGroup][.LAYER ADD DATA GROUP]]) and template ([[CDLayerAddDataSetTemplate][.LAYER ADD DATASET TM]]) and then link it ([[CDLayerLinkDataSetTemplate][.LAYER LINK DATASET TM]]). Note that if you plan to repeatedly generate the same chart with different data, the automatic linking will cause problems because when you add the layer on the next iteration, it will link to your previous data set. In this case, you should turn off automatic linking and manage it manually.

See [[CDOverviewDatasetDefinition][Datasets Overview]] for more information on working with Layers, Data Groups, Data Templates, Data Sets and Data Points.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-10-12
Topic revision: r12 - 2012-02-24 - JeanNeron
~~Edit~~
~~Attach~~