StaffLinesSpanner

class spannertools.StaffLinesSpanner(lines=5, forbid_restarting=None, overrides=None)

Staff lines spanner.

>>> import abjad
>>> staff = abjad.Staff("c'8 d'8 e'8 f'8")
>>> spanner = abjad.StaffLinesSpanner(lines=1)
>>> abjad.attach(spanner, staff[1:3])
>>> show(staff) 

Stops and restarts staff on first leaf in spanner.

Overrides line-count attribute of LilyPond Staff.StaffSymbol grob on first leaf in spanner.

Stops and restarts staff on last leaf in spanner.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_spannertools { graph [label=spannertools]; "abjad.tools.spannertools.Spanner.Spanner" [color=3, group=2, label=Spanner, shape=box]; "abjad.tools.spannertools.StaffLinesSpanner.StaffLinesSpanner" [color=black, fontcolor=white, group=2, label=<<B>StaffLinesSpanner</B>>, shape=box, style="filled, rounded"]; "abjad.tools.spannertools.Spanner.Spanner" -> "abjad.tools.spannertools.StaffLinesSpanner.StaffLinesSpanner"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.spannertools.Spanner.Spanner"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

components Gets leaves in spanner.
forbid_restarting Is true if staff lines spanner is forbidden from re-stopping and re-starting the staff on its last leaf.
lines Gets line of staff lines spanner.
name Gets spanner name.
overrides Gets overrides.
__contains__(argument) Is true when spanner contains argument.
__copy__(*arguments) Copies spanner.
__eq__(argument) Is true when ID of argument equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__getitem__(argument) Gets item or slice identified by argument.
__hash__() Hashes Abjad object.
__len__() Gets number of components in spanner.
__lt__(argument) Is true when spanner is less than argument.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

(Spanner).components

Gets leaves in spanner.

Returns selection of leaves.

StaffLinesSpanner.forbid_restarting

Is true if staff lines spanner is forbidden from re-stopping and re-starting the staff on its last leaf. Otherwise false.

>>> staff = abjad.Staff("c'8 d'8 e'8 f'8")
>>> spanner = abjad.StaffLinesSpanner(
...     lines=1,
...     forbid_restarting=True,
...     )
>>> abjad.attach(spanner, staff[:])
>>> show(staff) 

This is useful when the final leaf of a score is covered by a staff lines spanner, to prevent unexpected LilyPond typesetting behavior.

Returns true or false.

StaffLinesSpanner.lines

Gets line of staff lines spanner.

>>> staff = abjad.Staff("c'8 d'8 e'8 f'8")
>>> spanner = abjad.StaffLinesSpanner(lines=1)
>>> abjad.attach(spanner, staff[1:3])
>>> show(staff) 
>>> spanner.lines
1

Returns nonnegative integer.

(Spanner).name

Gets spanner name.

Returns string.

(Spanner).overrides

Gets overrides.

Returns dictionary.

Special methods

(Spanner).__contains__(argument)

Is true when spanner contains argument. Otherwise false.

Returns true or false.

(Spanner).__copy__(*arguments)

Copies spanner.

Does not copy spanner components.

Returns new spanner.

(AbjadObject).__eq__(argument)

Is true when ID of argument equals ID of Abjad object. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(Spanner).__getitem__(argument)

Gets item or slice identified by argument.

Returns component.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(Spanner).__len__()

Gets number of components in spanner.

Returns nonnegative integer.

(Spanner).__lt__(argument)

Is true when spanner is less than argument. Otherwise false.

Trivial comparison to allow doctests to work.

Returns true or false.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.