Difference: CDXYAddBarLayer (1 vs. 14)

Revision 142018-10-16 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorXYChartRoutines"

.XY ADD BAR LAYER

Line: 35 to 35
  <bar_color_style> 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 .XY SET BAR CLR, but if you don't Chart Director will assign unique colors automatically.
Changed:
<
<
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET TM) and then link it (.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.
>
>
<auto_link> 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 ( .LAYER ADD DATA GROUP) and template ( .LAYER ADD DATASET TM) and then link it ( .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 Datasets Overview for more information on working with Layers, Data Groups, Data Templates, Data Sets and Data Points.

Comments:

Revision 132013-02-20 - RayPelegrino

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorXYChartRoutines"

.XY ADD BAR LAYER

Revision 122012-02-24 - JeanNeron

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="CDChartDirectorDesignerAPI"
>
>
META TOPICPARENT name="CDChartDirectorXYChartRoutines"
 

.XY ADD BAR LAYER

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

Revision 112011-12-22 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 35 to 35
  <bar_color_style> 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 .XY SET BAR CLR, but if you don't Chart Director will assign unique colors automatically.
Changed:
<
<
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET) and then link it (.LAYER LINK DATASET). 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.
>
>
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET TM) and then link it (.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 Datasets Overview for more information on working with Layers, Data Groups, Data Templates, Data Sets and Data Points.

Comments:

Revision 102011-12-05 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 15 to 15
 

Description:

Changed:
<
<
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 intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect.
>
>
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 .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.

Revision 92011-11-30 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 33 to 33
  If blank or not passed, then each data set will be plotted in it's own layer.
Changed:
<
<
<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you must the color of each bar via .XY SET BAR CLR.
>
>
<bar_color_style> 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 .XY SET BAR CLR, but if you don't Chart Director will assign unique colors automatically.
  <auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET) and then link it (.LAYER LINK DATASET). 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.

Revision 82011-11-11 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 6 to 6
 

Usage:

Changed:
<
<
* Opt PASS         <data_combine_method>      FIELD            SHARE? N
* Opt PASS         <bar_color_style>                           SHARE? N
* Opt PASS         <auto_link>                                 SHARE? N
*     GOSUB    0CD .XY ADD BAR LAYER

>
>
      PASS         <data_combine_method>      FIELD            SHARE? N
      PASS         <bar_color_style>          FIELD            SHARE? N
      PASS         <auto_link>                FIELD            SHARE? N
      GOSUB    0CD .XY ADD BAR LAYER

 
    • Check for error
Changed:
<
<
* IF 0CD .XY ADD BAR LAYER NE
>
>
IF 0CD .XY ADD BAR LAYER NE
 

Description:

Revision 72011-11-09 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 35 to 35
  <bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you must the color of each bar via .XY SET BAR CLR.
Changed:
<
<
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET) and then link it (.LAYER LINK DATASET).
>
>
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET) and then link it (.LAYER LINK DATASET). 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 Datasets Overview for more information on working with Layers, Data Groups, Data Templates, Data Sets and Data Points.

Comments:

Revision 62011-11-08 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 6 to 6
 

Usage:

Changed:
<
<
      PASS         <data_combine_method>          FIELD            SHARE? N
      PASS         <bar_color_style>              FIELD            SHARE? N
      GOSUB    0CD .XY ADD BAR LAYER

>
>
* Opt PASS         <data_combine_method>      FIELD            SHARE? N
* Opt PASS         <bar_color_style>                           SHARE? N
* Opt PASS         <auto_link>                                 SHARE? N
*     GOSUB    0CD .XY ADD BAR LAYER

 
    • Check for error
Changed:
<
<
IF 0CD .XY ADD BAR LAYER NE
>
>
* IF 0CD .XY ADD BAR LAYER NE
 

Description:

Changed:
<
<
This subroutine adds a Bar layer to the "current" chart spec and automatically links the "current" dataset to it, if there is one. You must have intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect.
>
>
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 intialized the chart as an XY Chart via .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.
Changed:
<
<
This routine receives two optional values, a <data_combine_method> and a <bar_color_style>.
>
>
This routine receives three optional values, a <data_combine_method>, a <bar_color_style> and <auto_link>.
  If we are only going to have one data set on our chart, then the <data_combine_method> does not really apply. If we have multiple data sets, then the <data_combine_method> will determine how they will be shown. Valid values are:
Line: 31 to 33
  If blank or not passed, then each data set will be plotted in it's own layer.
Changed:
<
<
<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via .XY SET BAR CLR.
>
>
<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you must the color of each bar via .XY SET BAR CLR.
 
Changed:
<
<
If you have created your data set before calling this subroutine, then a default data group and data template will be created and linked to your data set automatically.
>
>
<auto_link> 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 (.LAYER ADD DATA GROUP) and template (.LAYER ADD DATASET) and then link it (.LAYER LINK DATASET).
  See Datasets Overview for more information on working with Layers, Data Groups, Data Templates, Data Sets and Data Points.

Comments:

Revision 52011-11-04 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 33 to 33
  <bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via .XY SET BAR CLR.
Changed:
<
<
If you have created your data set before calling this subroutine, then a default data group will be created and linked to this layer automatically.
>
>
If you have created your data set before calling this subroutine, then a default data group and data template will be created and linked to your data set automatically.
 
Changed:
<
<
See Datasets Overview for more information on working with Layers, Data Groups, Data Sets and Data Points.
>
>
See 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.

Revision 42011-10-21 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 13 to 13
  IF 0CD .XY ADD BAR LAYER NE

Description:

Changed:
<
<
This subroutine adds a Bar layer to the "current" chart spec and automatically links the "current" dataset to it if there is one. You must have intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect. This subroutine is typically used to add multiple data sets to a single bar layer. A Bar layer is simply a group of data points you want to plot. An XY chart can have one or more Bar layers. For example, if we wanted to plot sales by month for the current year, that would be one layer. If we wanted to show last years sales as well, that would be a second layer, and so on. Normally, multiple layers are shown separately on XY charts, however, if we want to show everything in one layer, we can use this subroutine to create the layer, then add data using fill me in.
>
>
This subroutine adds a Bar layer to the "current" chart spec and automatically links the "current" dataset to it, if there is one. You must have intialized the chart as an XY Chart via .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 two optional values, a <data_combine_method> and a <bar_color_style>.
Changed:
<
<
If we are only going to have one set of data points on our chart, then the <data_combine_method> does not really apply. If we have multiple sets of data points, then the <data_combine_method> will determine how they will be shown. Valid values are:
>
>
If we are only going to have one data set on our chart, then the <data_combine_method> does not really apply. If we have multiple data sets, then the <data_combine_method> will determine how they will be shown. Valid values are:
  side - The data sets are combined by plotting the bars side by side.
Line: 29 to 31
  If blank or not passed, then each data set will be plotted in it's own layer.
Changed:
<
<
<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via fill me in.
>
>
<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via .XY SET BAR CLR.

If you have created your data set before calling this subroutine, then a default data group will be created and linked to this layer automatically.

 
Changed:
<
<
If you have created your data set before calling this subroutine, then your "current' dataset will be linked to the layer automatically.
>
>
See Datasets Overview for more information on working with Layers, Data Groups, Data Sets and Data Points.
 

Comments:

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

Revision 32011-10-13 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 13 to 13
  IF 0CD .XY ADD BAR LAYER NE

Description:

Changed:
<
<
This subroutine adds a Bar layer to the "current" chart spec. You must have intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect. This subroutine is typically used to add multiple data sets to a single bar layer. A Bar layer is simply a group of data points you want to plot. An XY chart can have one or more Bar layers. For example, if we wanted to plot sales by month for the current year, that would be one layer. If we wanted to show last years sales as well, that would be a second layer, and so on. Normally, multiple layers are shown separately on XY charts, however, if we want to show everything in one layer, we can use this subroutine to create the layer, then add data using fill me in.
>
>
This subroutine adds a Bar layer to the "current" chart spec and automatically links the "current" dataset to it if there is one. You must have intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect. This subroutine is typically used to add multiple data sets to a single bar layer. A Bar layer is simply a group of data points you want to plot. An XY chart can have one or more Bar layers. For example, if we wanted to plot sales by month for the current year, that would be one layer. If we wanted to show last years sales as well, that would be a second layer, and so on. Normally, multiple layers are shown separately on XY charts, however, if we want to show everything in one layer, we can use this subroutine to create the layer, then add data using fill me in.
  This routine receives two optional values, a <data_combine_method> and a <bar_color_style>.
Line: 30 to 30
 If blank or not passed, then each data set will be plotted in it's own layer.

<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via fill me in.

Added:
>
>
If you have created your data set before calling this subroutine, then your "current' dataset will be linked to the layer automatically.
 

Comments:

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

Revision 22011-10-13 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

Line: 25 to 25
  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".
Changed:
<
<
percentage - The data sets are combined similar to stacked bars, except that the data in a bar are scaled so that they summed 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.
>
>
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.
 
Changed:
<
<
The default is to plot each data set in it's own layer.
>
>
If blank or not passed, then each data set will be plotted in it's own layer.
  <bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via fill me in.

Comments:

Revision 12011-10-12 - JeanNeron

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="CDChartDirectorDesignerAPI"

.XY ADD BAR LAYER

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


Usage:

      PASS         <data_combine_method>          FIELD            SHARE? N
      PASS         <bar_color_style>              FIELD            SHARE? N
      GOSUB    0CD .XY ADD BAR LAYER
      *        Check for error
      IF       0CD .XY ADD BAR LAYER        NE

Description:

This subroutine adds a Bar layer to the "current" chart spec. You must have intialized the chart as an XY Chart via .CHART INITIALIZE for this to have any effect. This subroutine is typically used to add multiple data sets to a single bar layer. A Bar layer is simply a group of data points you want to plot. An XY chart can have one or more Bar layers. For example, if we wanted to plot sales by month for the current year, that would be one layer. If we wanted to show last years sales as well, that would be a second layer, and so on. Normally, multiple layers are shown separately on XY charts, however, if we want to show everything in one layer, we can use this subroutine to create the layer, then add data using fill me in.

This routine receives two optional values, a <data_combine_method> and a <bar_color_style>.

If we are only going to have one set of data points on our chart, then the <data_combine_method> does not really apply. If we have multiple sets of data points, then the <data_combine_method> 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 summed 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.

The default is to plot each data set in it's own layer.

<bar_color_style> must be either blank or 'multiple'. Blank means that every bar in the layer will be the same color. 'Multiple' means that you will set the color of each bar via fill me in.

Comments:

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


<--/commentPlugin-->

-- JeanNeron - 2011-10-12

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback