Changes between Version 12 and Version 18 of Ticket #2100


Ignore:
Timestamp:
10/07/10 16:37:57 (9 years ago)
Author:
jason
Comment:

Updating description to reflect changes in the patch.

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #2100

    • Property Status changed from new to needs_review
    • Property Authors changed from to Jason Grout
  • Ticket #2100 – Description

    v12 v18  
    11We have two concepts of "aspect ratio" that we'd like to expose to the user.
    22
    3  * Figure aspect ratio -- controls the final image size, including  any text labels, etc.  This will be set using the following options:
    4    * figsize
    5      * single number - use this as a base size for fig_aspect_ratio calculations (i.e., bigger numbers = bigger figures)
    6      * two numbers - an actual figure size in inches
    7      * None - use the default size
    8    * fit_tight
    9      * if True, clip or extend the resulting figure to the plot objects (so the resulting figure will probably not have figsize dimensions
    10      * if False, the resulting figure has exactly figsize dimensions, but items in the plot may be clipped or there may be excessive padding around drawn objects
    11  * Pixel aspect ratio
    12    * aspect_ratio -- the aspect ratio of a pixel in the image (or of a  unit square in data coordinates, for example).  The default here will  change depending on the type of plot
    13      * 'equal' or 1 -- square pixels.  This will be the default for most things
    14      * 'auto' -- plot the given data limits in the given (or computed) figsize, filling the figure
    15      * number -- ratio of height to width.
    16    * aspect_ratio_adjust -- what should we adjust to  achieve the desired aspect ratio for the items drawn?  Note that by  default, the axes limits are enlarged slightly; to eliminate this, set  axes_pad=0
    17      * 'box' (default) -- the frame axes
    18      * 'datalim' -- the data limits
     3This patch exposes the following behavior:
     4
     5{{{
     6    * Figure aspect ratio -- controls the final image size, including any text labels, etc. This will be set using the following options:
     7          o figsize
     8                + single number - use this as a base size for the width of the figure canvas
     9                + two numbers - an actual figure size in inches
     10                + None - use the default size in Matplotlib
     11          o fit_tight
     12                + if True, clip or extend the resulting figure to the plot objects (so the resulting figure will probably not have figsize dimensions
     13                + if False, the resulting figure has exactly figsize dimensions, but items in the plot may be clipped or there may be excessive padding around drawn objects
     14    * Pixel aspect ratio
     15          o aspect_ratio -- the ratio height/width for a unit square
     16                + 'equal' or 1 -- a unit square appears to have equal height and width.  This will be the default for Graphics objects (so if a default is not explicitly set, the default is this.)
     17                + 'auto' -- plot the given data limits in the given (or computed) figsize, filling the figure (default for plot and list_plot)
     18                + number -- ratio of height to width.
     19}}}