StaffChange

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

class abjad.indicators.StaffChange.StaffChange(staff=None)

Staff change.

Explicit staff change:

>>> staff_group = abjad.StaffGroup()
>>> staff_group.lilypond_type = 'PianoStaff'
>>> rh_staff = abjad.Staff("c'8 d'8 e'8 f'8", name='RHStaff')
>>> lh_staff = abjad.Staff("s2", name='LHStaff')
>>> staff_group.extend([rh_staff, lh_staff])
>>> staff_change = abjad.StaffChange(lh_staff)
>>> abjad.attach(staff_change, rh_staff[2])
>>> abjad.show(staff_group) 

Attributes Summary

__str__ Gets string representation of staff change.
context Gets 'Staff'.
staff Gets staff of staff change.
tweaks Are not implemented on staff change.

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 staff change.

Default staff change:

>>> staff_change = abjad.StaffChange()
>>> print(str(staff_change))
\change Staff = ##f

Explicit staff change:

>>> lh_staff = abjad.Staff("s2", name='LHStaff')
>>> staff_change = abjad.StaffChange(staff=lh_staff)
>>> print(str(staff_change))
\change Staff = LHStaff
Return type:str

Read-only properties

context

Gets 'Staff'.

Default staff change:

>>> staff_change = abjad.StaffChange()
>>> staff_change.context
'Staff'

Explicit staff change:

>>> lh_staff = abjad.Staff("s2", name='LHStaff')
>>> staff_change = abjad.StaffChange(staff=lh_staff)
>>> staff_change.context
'Staff'
Return type:str
staff

Gets staff of staff change.

Default staff change:

>>> staff_change = abjad.StaffChange()
>>> staff_change.staff is None
True

Explicit staff change:

>>> lh_staff = abjad.Staff("s2", name='LHStaff')
>>> staff_change = abjad.StaffChange(staff=lh_staff)
>>> staff_change.staff
Staff('s2', name='LHStaff')

Returns staff or none.

tweaks

Are not implemented on staff change.

Return type:None