OctavationSpanner¶

class abjad.spanners.OctavationSpanner.OctavationSpanner(*, start=1, stop=0)¶

Octavation spanner.

Spans four notes:

>>> staff = abjad.Staff("c'4 d' e' f'")
>>> spanner = abjad.OctavationSpanner(start=1)
>>> abjad.attach(spanner, staff[:])
>>> abjad.show(staff) 

Spans one note:

>>> staff = abjad.Staff("c'4 d' e' f'")
>>> spanner = abjad.OctavationSpanner(start=1)
>>> abjad.attach(spanner, staff[:1])
>>> abjad.show(staff) 

One-note octavation changes are allowed.

Attributes Summary

`start`	Gets octavation start.
`stop`	Gets octavation stop.

Special methods

(Spanner).__contains__(argument)¶

Is true when spanner contains argument.

Return type:	`bool`

(Spanner).__copy__(*arguments)¶

Copies spanner.

Does not copy spanner leaves.

(AbjadObject).__format__(format_specification='')¶

Formats Abjad object.

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

Returns string.

(Spanner).__getitem__(argument)¶

Gets leaf or selection identified by argument.

Return type:	`Union`[`Leaf`, `Selection`]

(Spanner).__iter__()¶

Iterates leaves in spanner.

Return type:	`Iterator`[+T_co]

(Spanner).__len__()¶

Gets number of leaves in spanner.

Return type:	`int`

(Spanner).__lt__(argument)¶

Is true when spanner is less than argument.

Trivial comparison to allow doctests to work.

Return type:	`bool`

(AbjadObject).__repr__()¶

Gets interpreter representation of Abjad object.

Returns string.

Read-only properties

(Spanner).leaves¶

Gets leaves in spanner.

Return type:	`Selection`

start¶

Gets octavation start.

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

>>> spanner.start
1

Return type:	`Optional`[`int`]

stop¶

Gets octavation stop.

>>> staff = abjad.Staff("c'8 d'8 e'8 f'8")
>>> spanner = abjad.OctavationSpanner(start=2, stop=1)
>>> abjad.attach(spanner, staff[:])
>>> abjad.show(staff) 

>>> spanner.stop
1

Return type:	`Optional`[`int`]

(Spanner).tweaks¶

Gets tweaks.

Return type:	`Optional`[`LilyPondTweakManager`]