CDLegendSetKeyGap < Main

---+ .LEGEND SET KEY GAP

_This subroutine sets the horizontal gap between two legend entries for horizontal legend layout and the vertical gap (line spacing) between the legend keys for the "current" Legend Box_

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

This subroutine sets the horizontal gap between two legend entries for horizontal legend layout and the vertical gap (line spacing) between the legend keys for the "current" Legend Box. The horizontal gap is only applicable if you have used [[CDLegendSetKeyLayout][.LEGEND SET KEY LAYOUT]] to set the layout to 'Flow'.

The parameters are optional, and if supplied must be unsigned integers in the range 0-999. If not received or blank, the size will be set to their default values.

<div id="_mcePaste">In horizontal legend layout, the legend entries will flow from left to right, top to bottom, with a horizontal gap between two legend entries. In vertical legend layout, the legend entries will flow from top to bottom, with one entry per line. By default, the horizontal gap and the line spacing is automatically determined based on font size. This subroutine can be used to set the horizontal gap and line spacing in pixels.</div>

These can also be set individually via [[CDLegendSetKeyGapHoriz][.LEGEND SET KEY GAP:H]] or [[CDLegendSetKeyGapVert][.LEGEND SET KEY GAP:V]]

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-26
This topic: Main > WebHome > APPX510Features > CDChartDirectorDesignerAPI > CDChartDirectorBaseChartRoutines > CDLegendSetKeyGap
Topic revision: r4 - 2012-02-19 - JeanNeron