StopTextSpan

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.indicators" { graph [label="abjad.indicators"]; node [color=1]; "abjad.indicators.StopTextSpan.StopTextSpan" [URL="../api/abjad/indicators/StopTextSpan.html#abjad.indicators.StopTextSpan.StopTextSpan", color=black, fontcolor=white, label="Stop\nText\nSpan", target=_top]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=2]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/indicators/../system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjad/indicators/../system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.indicators.StopTextSpan.StopTextSpan"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjad.indicators.StopTextSpan.StopTextSpan(command='\stopTextSpan', *, leak=None)

LilyPond \stopTextSpan command.

>>> abjad.StopTextSpan()
StopTextSpan(command='\\stopTextSpan')

Attributes Summary

command Gets command.
enchained Is true.
leak Is true when stop text span leaks LilyPond <> empty chord.
spanner_stop Is true.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Read-only properties

command

Gets command.

Return type:str
enchained

Is true.

Return type:bool
leak

Is true when stop text span leaks LilyPond <> empty chord.

Without leak:

>>> staff = abjad.Staff("c'4 d' e' r")
>>> command = abjad.StartTextSpan(
...     left_text=abjad.Markup('pont.').upright(),
...     right_text=abjad.Markup('tasto').upright(),
...     style='dashed_line_with_arrow',
...     )
>>> abjad.tweak(command).staff_padding = 2.5
>>> abjad.attach(command, staff[0])
>>> command = abjad.StopTextSpan()
>>> abjad.attach(command, staff[-2])
>>> abjad.show(staff) 

With leak:

>>> staff = abjad.Staff("c'4 d' e' r")
>>> command = abjad.StartTextSpan(
...     left_text=abjad.Markup('pont.').upright(),
...     right_text=abjad.Markup('tasto').upright(),
...     style='dashed_line_with_arrow',
...     )
>>> abjad.tweak(command).staff_padding = 2.5
>>> abjad.attach(command, staff[0])
>>> command = abjad.StopTextSpan(leak=True)
>>> abjad.attach(command, staff[-2])
>>> abjad.show(staff) 

REGRESSION. Leaked contributions appear last in postevent format slot:

>>> staff = abjad.Staff("c'8 d' e' f' r2")
>>> abjad.attach(abjad.Beam(), staff[:4])
>>> abjad.attach(abjad.Slur(), staff[:4])
>>> command = abjad.StartTextSpan(
...     left_text=abjad.Markup('pont.').upright(),
...     right_text=abjad.Markup('tasto').upright(),
...     style='dashed_line_with_arrow',
...     )
>>> abjad.tweak(command).staff_padding = 2.5
>>> abjad.attach(command, staff[0])
>>> command = abjad.StopTextSpan(leak=True)
>>> abjad.attach(command, staff[3])
>>> abjad.show(staff) 

The leaked text spanner above does not inadvertantly leak the beam or slur.

Return type:Optional[bool]
spanner_stop

Is true.

Return type:bool