MarginMarkup

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

class abjad.indicators.MarginMarkup.MarginMarkup(*, context='Staff', format_slot='before', markup=None)

Margin markup.

>>> staff = abjad.Staff("c'4 d'4 e'4 f'4")
>>> margin_markup = abjad.MarginMarkup(
...     markup=abjad.Markup('Vc.'),
...     )
>>> abjad.attach(margin_markup, staff[0])
>>> abjad.show(staff, strict=89) 

Attributes Summary

__eq__ Is true when argument is margin markup with context and markup equal to those of this margin markup.
__hash__ Hashes margin markup.
context Gets default context of margin markup.
format_slot Gets format slot.
latent Is true.
markup Gets (instrument name) markup.
parameter Is true.
redraw Is true.
tweaks Are not implemented on margin markup.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

__eq__(argument)

Is true when argument is margin markup with context and markup equal to those of this margin markup.

>>> margin_markup_1 = abjad.MarginMarkup(
...     context='PianoStaff',
...     markup=abjad.Markup('Hp.'),
...     )
>>> margin_markup_2 = abjad.MarginMarkup(
...     context='PianoStaff',
...     markup=abjad.Markup('Hp.'),
...     )
>>> margin_markup_3 = abjad.MarginMarkup(
...     context='Staff',
...     markup=abjad.Markup('Hp.'),
...     )
>>> margin_markup_1 == margin_markup_1
True
>>> margin_markup_1 == margin_markup_2
True
>>> margin_markup_1 == margin_markup_3
False
>>> margin_markup_2 == margin_markup_1
True
>>> margin_markup_2 == margin_markup_2
True
>>> margin_markup_2 == margin_markup_3
False
>>> margin_markup_3 == margin_markup_1
False
>>> margin_markup_3 == margin_markup_2
False
>>> margin_markup_3 == margin_markup_3
True
Return type:bool
(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

__hash__()

Hashes margin markup.

Redefined in tandem with __eq__.

>>> margin_markup = abjad.MarginMarkup(
...     context='PianoStaff',
...     markup=abjad.Markup('Hp.'),
...     )
>>> hash_ = hash(margin_markup)
>>> isinstance(hash_, int)
True
Return type:int
(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Read-only properties

context

Gets default context of margin markup.

>>> abjad.MarginMarkup().context
'Staff'
Return type:str
format_slot

Gets format slot.

>>> abjad.MarginMarkup().format_slot
'before'
Return type:str
latent

Is true.

>>> margin_markup = abjad.MarginMarkup(
...     markup=abjad.Markup('Vc.'),
...     )
>>> margin_markup.latent
True

Class constant.

Return type:bool
markup

Gets (instrument name) markup.

Return type:Optional[Markup]
parameter

Is true.

>>> margin_markup = abjad.MarginMarkup(
...     markup=abjad.Markup('Vc.'),
...     )
>>> margin_markup.parameter
True

Class constant.

Return type:bool
redraw

Is true.

>>> margin_markup = abjad.MarginMarkup(
...     markup=abjad.Markup('Vc.'),
...     )
>>> margin_markup.redraw
True

Class constant.

Return type:bool
tweaks

Are not implemented on margin markup.

The LilyPond \shortInstrumentName command refuses tweaks.

Craft explicit markup instead.

Return type:None