BreathMark

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.BreathMark.BreathMark" [URL="../api/abjad/indicators/BreathMark.html#abjad.indicators.BreathMark.BreathMark", color=black, fontcolor=white, label="Breath\nMark", 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.BreathMark.BreathMark"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjad.indicators.BreathMark.BreathMark(*, tweaks=None)

Breath mark.

Attached to a single note:

>>> note = abjad.Note("c'4")
>>> breath_mark = abjad.BreathMark()
>>> abjad.attach(breath_mark, note)
>>> abjad.show(note) 

Attached to notes in a staff:

>>> staff = abjad.Staff("c'8 d' e' f' g' a' b' c''")
>>> abjad.attach(abjad.Beam(), staff[:4])
>>> abjad.attach(abjad.Beam(), staff[4:])
>>> abjad.attach(abjad.BreathMark(), staff[3])
>>> abjad.attach(abjad.BreathMark(), staff[7])
>>> abjad.show(staff) 

Attributes Summary

__str__ Gets string representation of breath mark.
tweaks Gets tweaks

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.

__str__()

Gets string representation of breath mark.

>>> str(abjad.BreathMark())
'\\breathe'
Return type:str

Read-only properties

tweaks

Gets tweaks

>>> note = abjad.Note("c'4")
>>> breath = abjad.BreathMark()
>>> abjad.tweak(breath).color = 'blue'
>>> abjad.attach(breath, note)
>>> abjad.show(note) 
>>> note = abjad.Note("c'4")
>>> breath = abjad.BreathMark(tweaks=[('color', 'blue')])
>>> abjad.attach(breath, note)
>>> abjad.show(note) 
Return type:Optional[LilyPondTweakManager]