CDLegendSetKeyTemplate < Main

Tags: view all tags
---+ .LEGEND SET TEMPLATE

_This subroutine sets the template for the style for the "current" legend._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;template&gt;                 FIELD            SHARE? N
      GOSUB    0CD .LEGEND SET TEMPLATE
      *        Check for error
      IF       0CD .LEGEND SET TEMPLATE       NE
</pre>
---++ Description:

This subroutine sets a template for the current legend text.

<div id="_mcePaste">The default template is "{dataSetName}", which means the name of the data set will be used as the legend text. The legend key text can be modified to include other information. For example, in a pie chart, "{label}: {value}" means the legend text will consist of the sector label followed by the sector value.</div>

If you are using CDML in your template, we recommend that you enclose the template text in quotations, otherwise there is a chance that some characters might be interpreted literally instead of as CDML. 

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

The parameter is optional, if blank or not passed, it will be reset to the default.

You have to define a Legend box via [[CDChartSetLegendBox][.CHART SET LEGEND BOX]] for this subroutine to have any effect.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-09-27
Topic revision: r4 - 2012-02-19 - JeanNeron