CDLegendKeyInitialize < Main

Tags: view all tags
---+ .LEGEND KEY INTIALIZE

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

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;entry_priority&gt;           FIELD            SHARE? N
      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 INITIALIZE
      *        Check for error
      IF       0CD .LEGEND KEY INITIALIZE     NE
</pre>
---++ Description:

This subroutine adds a new legend key to the "current" Legend Box with the specified priority.

*&lt;entry_priority&gt;* is a required field, and must be an integer between 0-9999999. Key priorities that are added automatically by Chart Director start at 10000 and increment by 10000 for every legend key. Key priorities you add manually via [[CDLegendKeyAddNext][.LEGEND KEY ADD NEXT]] start at 1 and increment by 1. You can also reverse the order with [[CDLegendSetKeyOrder][.LEGEND SET KEY ORDER]]

<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 Draw Area 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.

Parameters other than *&lt;entry_priority&gt;* 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
Topic revision: r3 - 2012-02-19 - JeanNeron