abjad.overrides

abjad.overrides.override(argument)	Makes LilyPond grob override interface.
abjad.overrides.setting(argument)	Makes LilyPond setting name interface.
abjad.overrides.Interface()	Base class from which grob, setting and tweak interfaces inherit.
abjad.overrides.LilyPondOverride([...])	LilyPond grob override.
abjad.overrides.LilyPondSetting([...])	LilyPond context setting.
abjad.overrides.OverrideInterface()	Override interface.
abjad.overrides.SettingInterface()	LilyPond setting interface.

abjad.overrides.override(argument)

Makes LilyPond grob override interface.

Overrides staff symbol color:

>>> staff = abjad.Staff("c'4 e'4 d'4 f'4")
>>> abjad.override(staff).StaffSymbol.color = "#red"
>>> abjad.show(staff)  

Specify grob context like this:

>>> staff = abjad.Staff("c'4 e'4 d'4 f'4")
>>> abjad.override(staff[0]).Staff.StaffSymbol.color = "#blue"
>>> abjad.show(staff)  

Returns LilyPond grob override interface.

>>> staff = abjad.Staff("c'4 e' d' f'")
>>> abjad.override(staff)
OverrideInterface()

abjad.overrides.setting(argument)

Makes LilyPond setting name interface.

Sets instrument name:

>>> staff = abjad.Staff("c'4 e'4 d'4 f'4")
>>> string = r'\markup "Vn. I"'
>>> abjad.setting(staff).instrumentName = string
>>> abjad.show(staff)  

Returns LilyPond setting name interface:

>>> abjad.setting(staff)
SettingInterface(('instrumentName', '\\markup "Vn. I"'))

class abjad.overrides.Interface

Base class from which grob, setting and tweak interfaces inherit.

class abjad.overrides.LilyPondOverride(lilypond_type: str | None = None, grob_name: str = 'NoteHead', once: bool = False, is_revert: bool = False, property_path: str | Sequence[str] = 'color', value: bool | int | float | str = '#red')

LilyPond grob override.

>>> override = abjad.LilyPondOverride(
...     lilypond_type="Staff",
...     grob_name="TextSpanner",
...     once=True,
...     property_path=(
...         "bound-details",
...         "left",
...         "text",
...     ),
...     value=r"\markup \bold { over pressure }",
... )
>>> print(override.override_string)
\once \override Staff.TextSpanner.bound-details.left.text = \markup \bold { over pressure }

>>> override = abjad.LilyPondOverride(
...     lilypond_type="Staff",
...     grob_name="TextSpanner",
...     once=True,
...     property_path="bound_details__left__text",
...     value=r"\markup \bold { over pressure }",
... )
>>> print(override.override_string)
\once \override Staff.TextSpanner.bound-details.left.text = \markup \bold { over pressure }

override_format_pieces	Gets LilyPond grob override override format pieces.
override_string	Gets LilyPond grob override override string.
revert_format_pieces	Gets LilyPond grob override revert format pieces.
revert_string	Gets LilyPond grob override revert string.
tweak_string([directed, grob])	Gets LilyPond grob override tweak string.

override_format_pieces

Gets LilyPond grob override override format pieces.

>>> override = abjad.LilyPondOverride(
...     lilypond_type="Staff",
...     grob_name="TextSpanner",
...     once=True,
...     property_path=(
...         "bound-details",
...         "left",
...         "text",
...     ),
...     value=r"\markup \bold { over pressure }",
... )
>>> for line in override.override_format_pieces:
...     line
... 
'\\once \\override Staff.TextSpanner.bound-details.left.text = \\markup \\bold { over pressure }'

override_string

Gets LilyPond grob override override string.

>>> override = abjad.LilyPondOverride(
...     grob_name="Glissando",
...     property_path="style",
...     value="#'zigzag",
... )
>>> override.override_string
"\\override Glissando.style = #'zigzag"

revert_format_pieces

Gets LilyPond grob override revert format pieces.

>>> override = abjad.LilyPondOverride(
...     grob_name="Glissando",
...     property_path="style",
...     value="#'zigzag",
... )
>>> override.revert_format_pieces
('\\revert Glissando.style',)

revert_string

Gets LilyPond grob override revert string.

>>> override = abjad.LilyPondOverride(
...     grob_name="Glissando",
...     property_path="style",
...     value="#'zigzag",
... )
>>> override.revert_string
'\\revert Glissando.style'

tweak_string(directed=True, grob=False) → str

Gets LilyPond grob override tweak string.

>>> override = abjad.LilyPondOverride(
...     grob_name="Glissando",
...     property_path="style",
...     value="#'zigzag",
... )
>>> override.tweak_string()
"- \\tweak style #'zigzag"

>>> override = abjad.LilyPondOverride(
...     grob_name="RehearsalMark",
...     property_path="color",
...     value="#red",
... )
>>> override.tweak_string(directed=False)
'\\tweak color #red'

class abjad.overrides.LilyPondSetting(lilypond_type: str | None = None, context_property: str = 'autoBeaming', is_unset: bool = False, value: Any = False)

LilyPond context setting.

>>> context_setting = abjad.LilyPondSetting(
...     lilypond_type="Score",
...     context_property="autoBeaming",
...     value="##f",
... )

>>> print("\n".join(context_setting.format_pieces))
\set Score.autoBeaming = ##f

format_pieces

Gets LilyPond context setting \set or \unset format pieces.

format_pieces

Gets LilyPond context setting \set or \unset format pieces.

class abjad.overrides.OverrideInterface

Override interface.

Override interfaces are created by the abjad.override() factory function:

>>> note = abjad.Note("c'4")
>>> abjad.override(note)
OverrideInterface()

class abjad.overrides.SettingInterface

LilyPond setting interface.

>>> note = abjad.Note("c'4")
>>> abjad.setting(note)
SettingInterface()