RehearsalMark

class indicatortools.RehearsalMark(number=None, markup=None)

A rehearsal mark.

Example 1. Rehearsal A:

>>> staff = Staff("c'4 d' e' f'")
>>> score = Score([staff])
>>> mark = indicatortools.RehearsalMark(number=1)
>>> attach(mark, staff[0])
>>> scheme = schemetools.Scheme('format-mark-box-alphabet')
>>> set_(score).markFormatter = scheme
>>> show(score) 

Example 2. Rehearsal B:

>>> staff = Staff("c'4 d' e' f'")
>>> score = Score([staff])
>>> mark = indicatortools.RehearsalMark(number=2)
>>> attach(mark, staff[0])
>>> scheme = schemetools.Scheme('format-mark-box-alphabet')
>>> set_(score).markFormatter = scheme
>>> show(score) 

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.RehearsalMark.RehearsalMark" [color=black, fontcolor=white, group=2, label=<<B>RehearsalMark</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.RehearsalMark.RehearsalMark"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

default_scope Gets default scope of rehearsal mark.
markup Gets markup of rehearsal mark.
number Gets number of rehearsal mark.
__copy__(\*args) Copies Abjad value object.
__eq__(expr) Is true when all initialization values of Abjad value object equal the initialization values of expr.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of rehearsal mark.

Read-only properties

RehearsalMark.default_scope

Gets default scope of rehearsal mark.

Example 1. Rehearsal A:

>>> mark = indicatortools.RehearsalMark(number=1)
>>> mark.default_scope is None
True

Example 2. Rehearsal B:

>>> mark = indicatortools.RehearsalMark(number=2)
>>> mark.default_scope is None
True

Todo

Make rehearsal marks score-scoped.

Returns none (but should return score).

RehearsalMark.markup

Gets markup of rehearsal mark.

Example 1. Custom rehearsal A:

>>> markup = Markup(r'\bold { \italic { A } }')
>>> mark = indicatortools.RehearsalMark(markup=markup)
>>> show(mark.markup) 

Example 2. Custom rehearsal B:

>>> markup = Markup(r'\bold { \italic { B } }')
>>> mark = indicatortools.RehearsalMark(markup=markup)
>>> show(mark.markup) 

Returns markup or none.

RehearsalMark.number

Gets number of rehearsal mark.

Example 1. Rehearsal A:

>>> mark = indicatortools.RehearsalMark(number=1)
>>> mark.number
1

Example 2. Rehearsal B:

>>> mark = indicatortools.RehearsalMark(number=2)
>>> mark.number
2

Returns positive integer or none.

Special methods

(AbjadValueObject).__copy__(*args)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(expr)

Is true when all initialization values of Abjad value object equal the initialization values of expr.

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).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

RehearsalMark.__str__()

Gets string representation of rehearsal mark.

Example 1. Rehearsal A

>>> mark = indicatortools.RehearsalMark(number=1)
>>> print(str(mark))
\mark #1

Example 2. Rehearsal B

>>> mark = indicatortools.RehearsalMark(number=2)
>>> print(str(mark))
\mark #2

Returns string.