CDLegendSetKeyGapHoriz < Main

---+ .LEGEND SET KEY GAP:H

_This subroutine sets the horizontal gap between two legend entries for horizontal legend layout for the "current" Legend Box._

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

This subroutine sets the horizontal gap between two legend entries for horizontal legend layout 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 parameter is optional, and if supplied must be an unsigned integer in the range 0-999. If not received or blank, the gap will be automatically determined.

In horizontal legend layout, the legend entries will flow from left to right, top to bottom, with a horizontal gap between two legend entries. 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.

This can also be set along with vertical spacing via [[CDLegendSetKeyGap][.LEGEND SET KEY GAP]] or you can set the vertical spacing directly via [[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 > CDLegendSetKeyGapHoriz
Topic revision: r4 - 2012-02-19 - JeanNeron