GeneralizedBeam

class spannertools.GeneralizedBeam(durations=None, include_long_duration_notes=False, include_long_duration_rests=False, isolated_nib_direction=None, use_stemlets=False, vertical_direction=None)

Generalized beam.

>>> import abjad
>>> staff = abjad.Staff("r4 c'8 d'16 e'16 r8 fs'8 g'4")
>>> abjad.setting(staff).auto_beaming = False
>>> show(staff) 
>>> beam = abjad.GeneralizedBeam()
>>> abjad.attach(beam, staff[:])
>>> show(staff) 
>>> staff = abjad.Staff("r4 c'8 d'16 e'16 r8 fs'8 g'4")
>>> abjad.setting(staff).auto_beaming = False
>>> show(staff) 
>>> beam = abjad.GeneralizedBeam(
...     isolated_nib_direction=Right,
...     )
>>> abjad.attach(beam, staff[:])
>>> show(staff) 
>>> staff = abjad.Staff("r4 c'8 d'16 e'16 r8 fs'8 g'4")
>>> abjad.setting(staff).auto_beaming = False
>>> show(staff) 
>>> beam = abjad.GeneralizedBeam(use_stemlets=True)
>>> abjad.attach(beam, staff[:])
>>> show(staff) 

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.GeneralizedBeam.GeneralizedBeam" [color=black, fontcolor=white, group=2, label=<<B>GeneralizedBeam</B>>, shape=box, style="filled, rounded"]; "abjad.tools.spannertools.Spanner.Spanner" [color=3, group=2, label=Spanner, shape=box]; "abjad.tools.spannertools.Spanner.Spanner" -> "abjad.tools.spannertools.GeneralizedBeam.GeneralizedBeam"; } 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.
durations Durations to use for span-beam groupings.
include_long_duration_notes True if beam includes long duration notes, otherwise false.
include_long_duration_rests True if beam includes long duration rests, otherwise false.
isolated_nib_direction Direction of isolated nibs.
name Gets spanner name.
overrides Gets overrides.
use_stemlets True if beam uses stemlets, otherwise false.
vertical_direction Vertical direction of the beam.
__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.

GeneralizedBeam.durations

Durations to use for span-beam groupings.

GeneralizedBeam.include_long_duration_notes

True if beam includes long duration notes, otherwise false.

GeneralizedBeam.include_long_duration_rests

True if beam includes long duration rests, otherwise false.

GeneralizedBeam.isolated_nib_direction

Direction of isolated nibs.

(Spanner).name

Gets spanner name.

Returns string.

(Spanner).overrides

Gets overrides.

Returns dictionary.

GeneralizedBeam.use_stemlets

True if beam uses stemlets, otherwise false.

GeneralizedBeam.vertical_direction

Vertical direction of the beam.

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.