Articulation

class indicatortools.Articulation(name=None, direction=None)

Articulation.

Example 1. Initializes from name:

>>> Articulation('staccato')
Articulation('staccato')

Example 2. Initializes from abbreviation:

>>> Articulation('.')
Articulation('.')

Example 3. Initializes from other articulation:

>>> articulation = Articulation('staccato')
>>> Articulation(articulation)
Articulation('staccato')

Example 4. Initializes with direction:

>>> Articulation('staccato', Up)
Articulation('staccato', Up)

Example 5. Use attach() to attach articulations to notes, rests or chords:

>>> note = Note("c'4")
>>> articulation = Articulation('staccato')
>>> attach(articulation, note)
>>> show(note) 

Todo

Simplify initializer. Allow only initialization from name. Implement new from_abbreviation() and from_articulation() methods to replace existing initializer polymorphism.

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.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.Articulation.Articulation" [color=black, fontcolor=white, group=2, label=<<B>Articulation</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.Articulation.Articulation"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

default_scope Gets default scope of articulation.
direction Gets direction of articulation.
name Gets name of articulation.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats articulation.
__hash__() Hashes Abjad value object.
__illustrate__() Illustrates articulation.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of articulation.

Read-only properties

Articulation.default_scope

Gets default scope of articulation.

>>> articulation = Articulation('staccato')
>>> articulation.default_scope is None
True

Returns none.

Articulation.direction

Gets direction of articulation.

Example 1. Without direction:

>>> articulation = Articulation('staccato')
>>> articulation.direction is None
True

Example 2. With direction:

>>> articulation = Articulation('staccato', direction=Up)
>>> articulation.direction
Up

Returns ordinal constant or none.

Articulation.name

Gets name of articulation.

Example 1. Staccato:

>>> articulation = Articulation('staccato')
>>> articulation.name
'staccato'

Example 2. Tenuto:

>>> articulation = Articulation('tenuto')
>>> articulation.name
'tenuto'

Returns string.

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.

Articulation.__format__(format_specification='')

Formats articulation.

Set format_specification to ‘’, ‘lilypond‘ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

Articulation.__illustrate__()

Illustrates articulation.

Returns LilyPond file.

(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.

Articulation.__str__()

Gets string representation of articulation.

Returns string.