adjust_grid_xrelsizes

Context: plots

Synopsis

Modifies the widths of all columns of plots created by split or grid_objects.

Syntax

adjust_grid_xrelsizes(widths)
adjust_grid_xrelsizes(id, widths)

Description

The function arguments.

Argument	Description
widths	An array containing the relative widths of each column, starting at the left.
id	A ChipsId structure identifying the item.

The adjust_grid_xrelsizes command the size of all columns of plots in a frame created by split or grid_objects using the values supplied for each column in the widths parameter. The relational widths of all columns must be specified. For each column i, the width is calculated as

widths[i] * unit_width

where

available_area = 1 - (left_margin + right_margin + (num_cols -1)*xgapsize)

arraysum = widths[0] + widths[1] + .. + widths[n]

unit_width = available_area / arraysum

Since the columns are adjusted based on ratios of the widths, the scale of the values is not important. The arrays "[100,200,400]", "[.1,.2,.4]", and "[5,10,20]" all produce the same column widths: the columns double in size as they move from left to right.

To change the spacing between the plots, use the adjust_grid_gaps command.

Examples

Example 1

chips> split(3,3)
chips> adjust_grid_xrelsizes([2,1,2])

A split command is issued to create a grid of 9 plots. The adjust_grid_xrelsizes command sets the width of the first and third columns of plots to be double the width of the middle column.

Example 2

chips> grid_objects(2,2,.05,.05,1)
chips> adjust_grid_xrelsizes([32,68])

A grid_objects command creates a grid of 4 plot areas. The adjust_grid_xrelsizes command set the first column to 32 percent of the frame and the second column to 68 percent of the frame.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.