Synopsis
Modifies the height of one row of plots created by split or grid_objects.
Syntax
adjust_grid_yrelsize(row, size) adjust_grid_yrelsize(id, row, size)
Description
The function arguments.
Argument | Description |
---|---|
row | The row number to change, where the rows are numbered from top to bottom, starting at 1. |
size | The new height of the row given as a ratio to the other rows, so size=1 means the same size, size=2 is twice as tall. |
id | A ChipsId structure identifying the item. |
The adjust_grid_yrelsize command changes the size of a row of plots relative to the other rows in the frame created by split or grid_objects.
The height of the specified row is set to "size * unit_height". All other rows are set to unit_height.
The following is used to determine the height of the columns:
available_area = 1 - (top_margin + bottom_margin + (num_rows -1)*ygapsize)
unit_height = available_area / ((num_rows-1) + size)
To change the spacing between the plots, use the adjust_grid_gaps command.
Examples
Example 1
chips> split(3,3) chips> adjust_grid_yrelsize(2,.5)
A split command is issued to create a grid of 9 plots. The adjust_grid_yrelsize command sets the width of the center row to be half as tall as the other rows.
Example 2
chips> grid_objects(2,2,.05,.05,1) chips> adjust_grid_yrelsize(1,3)
A grid_objects command creates a grid of 4 plot areas. The adjust_grid_yrelsize command makes the first row of plots three times as tall as the other row.
Bugs
See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.
See Also
- limits
- get_plot_range
- plots
- add_plot, adjust_grid_gaps, adjust_grid_xrelsize, adjust_grid_xrelsizes, adjust_grid_yrelsizes, clear_plot, current_plot, delete_plot, display_plot, get_plot, grid_objects, hide_plot, move_plot, reposition_plot, set_data_aspect_ratio, set_plot, set_plot_aspect_ratio, split, strip_chart, swap_object_positions