stacked-tree-zoom-by-factor

stacked-tree-zoom-by-factor Function

Summary

Zoom the horizontal scale of a stacked-tree.

Package

capi

Signature

stacked-tree-zoom-by-factor stacked-tree factor => width-ratio

Arguments

`stacked-tree`⇩	A stacked-tree.
`factor`⇩	A non-negative real.

Values

width-ratio⇩

A real.

Description

The function stacked-tree-zoom-by-factor expands the horizontal dimension of stacked-tree by factor. If factor is between 0 and 1, the horizontal dimension contracts.

This is the same operation as is done by the keyboard gestures Ctrl--, Ctrl-+, Ctrl-i and Ctrl-o and you can use it to implement your own gestures.

The returned width-ratio is the value returned by stacked-tree-width-ratio.

Notes

Evaluating the form:

(stacked-tree-zoom-by-factor stacked-tree factor)

is equivalent to:

(setf (stacked-tree-width-ratio stacked-tree)
      (* (stacked-tree-width-ratio stacked-tree)
         factor))