CDLegendKeyAddNext < Main

---+ .LEGEND KEY ADD NEXT

_This subroutine adds a new legend key to the "current" Legend Box._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;legend_text&gt;      FIELD            SHARE? N
      PASS         &lt;color_spec_name&gt;  FIELD            SHARE? N
      *        OR
      PASS         &lt;color_value&gt;      FIELD            SHARE? N
      PASS         &lt;line_width&gt;       FIELD            SHARE? N             
      PASS         &lt;draw_area&gt;        FIELD            SHARE? N
      GOSUB    0CD .LEGEND KEY ADD NEXT
      *        Check for error
      IF       0CD .LEGEND KEY ADD NEXT     NE</pre>
---++ Description:

This subroutine adds a new legend key to the "current" Legend Box. Normally legend keys are added automatically when the data is added. This subroutine adds an entry with a legend entry priority of 1 (followed by 2, 3, 4, ... for repeated calls). This has higher priority than entries added automatically by the system for representing data sets. As a result, by default, the custom entry will appear before the automatic entries, unless you reverse the order with [[CDLegendSetKeyOrder][.LEGEND SET KEY ORDER]]

To add a legend key at a specific priority, see [[CDLegendKeyInitialize][.LEGEND KEY INITIALIZE]]

<strong>&lt;legend_text&gt; </strong>is the text you want added to the legend

*&lt;color_spec_name&gt;* or *&lt;color_value&gt;* is the color that should be used to render the text.

*&lt;line_width&gt;* is the line width for legend entry that represents lines in line charts. Must be an unsigned integer between 0-999.

*&lt;draw_area&gt;* is a DrawArea containing the data symbol that represents the legend entry. This is primarily used for legend entries in line charts with data symbols, or in scatter charts.

All parameters are optional and will default to blank or zero.

After adding the legend key, the color_spec spec becomes the "current" color spec and the legend key will become the "current" legend key.

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

See ColorSpec for more information on working with colors.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-09-28
This topic: Main > WebHome > APPX510Features > CDChartDirectorDesignerAPI > CDLegendKeyAddNext
Topic revision: r1 - 2011-09-28 - JeanNeron