CDXYPackPlotArea < Main

Tags: view all tags
---+ .XY PACK PLOT AREA

_This subroutine adjusts the size and position of the plot area for an XY type chart._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;left_x&gt;                   FIELD            SHARE? N
      PASS         &lt;top_y&gt;                    FIELD            SHARE? N
      PASS         &lt;right_x&gt;                  FIELD            SHARE? N
      PASS         &lt;bottom_y&gt;                 FIELD            SHARE? N
      PASS         &lt;min_width&gt;                FIELD            SHARE? N
      PASS         &lt;min_height&gt;               FIELD            SHARE? N
      GOSUB    0CD .XY PACK PLOT AREA
      *        Check for error
      IF       0CD .XY PACK PLOT AREA         NE
</pre>
---++ Description:

This subroutine adjusts the plot area size and position to fit the plot area and the axis labels in a bounding box. You must have initialized the chart as an XY Chart via [[CDChartInitialize][.CHART INITIALIZE]] for this to have any effect.

The first 4 parameters are required. If not passed, the subroutine will cancel. If passed, the values must be between 0-99999 pixels.

<div id="_mcePaste">In some charts, the axis labels may vary widely and can be very short or very long. It may be difficult to determine the plot area position and size so as to reserve reasonable and sufficient space for the axis labels.</div>

<div id="_mcePaste">This subroutine adjusts the size and position of the plot area, so that the plot area, together with the axis labels can fit within a given bounding box.</div>

<div id="_mcePaste">Note that this subroutine only adjusts for the thickness of the primary and secondary axes, and assumes they are at the border of the plot area.</div>

<div id="_mcePaste">Furthermore, the labels generated by auto-scaling depend on the number of labels that can fit on the axis, which in turn depends on the plot area size. So even if the final plot area size is determined by this subroutine, the [[CDXYSetPlotArea][.XY SET PLOT AREA]] routine must still be used to set a reasonable initial plot area size.</div>

&lt;left_x&gt; the left x coordinate of the bounding box.

&lt;top_y&gt; the top y coordinate of the bounding box.

&lt;right_x&gt; the right x coordinate of the bounding box.

&lt;bottom_y&gt; the bottom y coordinate of the bounding box.

&lt;min_width&gt; the minimum width the plot area can adjust to (Optional).

&lt;min_height&gt; the minimum height the plot area can adjust to (Optional).

<div id="_mcePaste">To adjust only the plot area width and horizontal position, and leave the height and vertical position unchanged, simply use a bounding box with zero height (eg. set both &lt;top_y&gt; and &lt;bottom_y&gt; to 0). Similarly, to adjust only the height and vertical position, use a bounding box with zero width.</div>

---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-03-15
Topic revision: r2 - 2012-03-15 - JeanNeron