Next / Previous / Contents / Shipman's homepage

6.21. leader()

The purpose of this function is to produce a leader element. This may appear as empty whitespace, as a row of dots, as a solid underline, or a number of other patterns.

leader(s, length=None, pattern=None)
s

The sox.Sox instance to which output will be written.

length

Specifies the length of the leader to be generated. If omitted, the leader will be able to stretch to any length. However, it will not be stretched unless other attributes force it to be stretched. For an example, see Section 6.18, “staticContent().

pattern

May have many values; refer to the standard for the possibilities. Common values include space for whitespace; dots for equally-spaced dots; and rule for a horizontal ruled line. Default is space.

This function writes a complete element and does not return a value.