CDPieSetLabelFormat < Main

Tags: view all tags
---+ .PIE SET LBL FORMAT

_This subroutine sets format for pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;lbl_format&gt;               FIELD            SHARE? N    
      PASS         &lt;beg_sect_no&gt;              FIELD            SHARE? N
      PASS         &lt;end_sect_no&gt;              FIELD            SHARE? N
      GOSUB    0CD .PIE SET LBL FORMAT
      *        Check for error
      IF       0CD .PIE SET LBL FORMAT        NE
</pre>
---++ Description:

This subroutine sets the format for the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.

The default label format depends on the label layout method (see [[CDPieSetLabelLayoutMethod][.PIE SET LBL LAYOUT]]). For Circular layout, the default is "{label}&lt;*br*&gt;{percent}%" and for Side layout the default is "{label} ({percent}%)"

As of this writing, you must enclose the template text in quotations, otherwise the chart will not render. For example, set it to "{label}: {value}", not {label}: {value}.

Please refer to Parameter Substitution and Formatting in the Chart Director documentation for all available parameters and how to format them.

If &lt;lbl_format&gt; is not received or is blank, then the "current" pie sector will be rendered with the default format.

If &lt;beg_sect_no&gt; is "ALL" or "0" and &lt;end_sect_no&gt; is not received or is blank, then &lt;lbl_format&gt; applies to all pie
<div id="_mcePaste">sectors.</div>

If &lt;beg_sect_no&gt; and &lt;end_sect_no&gt; are both received and are both numeric integers, then &lt;lbl_format&gt; applies to the range
<div id="_mcePaste">of pie sectors from &lt;beg_sect_no&gt; thru &lt;end_sect_no&gt; and is stored in the corresponding pie sector specs.</div>

If &lt;beg_sect_no&gt; is received and is a numeric integer and &lt;end_sect_no&gt; is not received or is blank, then &lt;lbl_format&gt;
<div id="_mcePaste">applies only to the &lt;beg_sect_no&gt; pie sector and is stored in the &lt;beg_sect_no&gt; pie sector spec.</div>

If &lt;beg_sect_no&gt; and &lt;end_sect_no&gt; are both not received or are blank, then &lt;lbl_format&gt; applies to the "current" pie sector and is stored in the "current" pie sector spec.

Any pie sector specs that are referenced but which do not exist are automatically created and initialized so that the &lt;lbl_format&gt; can be stored.

The last pie sector spec updated becomes the "current" pie sector spec.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-10-06
Topic revision: r3 - 2012-02-24 - JeanNeron