LilyPondOutputProxy

class abjadbooktools.LilyPondOutputProxy(payload, image_layout_specifier=None, image_render_specifier=None)

A LilyPond output proxy.

>>> from abjad.tools import abjadbooktools
>>> staff = Staff("c'4 d'4 e'4 f'4")
>>> proxy = abjadbooktools.LilyPondOutputProxy(staff)
>>> print(format(proxy))
abjadbooktools.LilyPondOutputProxy(
    lilypondfiletools.LilyPondFile(
        comments=(),
        global_staff_size=12,
        includes=(),
        items=[
            lilypondfiletools.Block(
                name='header',
                ),
            lilypondfiletools.Block(
                name='layout',
                ),
            lilypondfiletools.Block(
                name='paper',
                ),
            lilypondfiletools.Block(
                name='score',
                ),
            ],
        lilypond_language_token=lilypondfiletools.LilyPondLanguageToken(),
        lilypond_version_token=lilypondfiletools.LilyPondVersionToken(
            version_string='2.19.0',
            ),
        )
    )
>>> proxy.as_latex(relative_output_directory='assets')
['\\noindent\\includegraphics{assets/lilypond-9a3d90e80bc733e46a43d1ee30b68fa9.pdf}']

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_abjadbooktools { graph [label=abjadbooktools]; "abjad.tools.abjadbooktools.ImageOutputProxy.ImageOutputProxy" [color=2, group=1, label=ImageOutputProxy, shape=oval, style=bold]; "abjad.tools.abjadbooktools.LilyPondOutputProxy.LilyPondOutputProxy" [color=black, fontcolor=white, group=1, label=<<B>LilyPondOutputProxy</B>>, shape=box, style="filled, rounded"]; "abjad.tools.abjadbooktools.ImageOutputProxy.ImageOutputProxy" -> "abjad.tools.abjadbooktools.LilyPondOutputProxy.LilyPondOutputProxy"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=3, group=2, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.abjadbooktools.ImageOutputProxy.ImageOutputProxy"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Attribute summary

as_docutils([configuration, output_directory]) Creates a docutils node representation of the output proxy.
as_latex([configuration, output_directory, ...]) Creates a LaTeX representation of the image output proxy.
file_name_prefix Gets file name prefix of LilyPond output proxy.
file_name_without_extension Gets image output proxy filename without file extension.
image_layout_specifier Gets image specifier.
image_render_specifier Gets image specifier.
payload Gets images output proxy payload.
render_for_latex(absolute_output_directory) Renders the image output proxy payload for LaTeX inclusion.
__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.

Read-only properties

LilyPondOutputProxy.file_name_prefix

Gets file name prefix of LilyPond output proxy.

Returns string.

(ImageOutputProxy).file_name_without_extension

Gets image output proxy filename without file extension.

Returns string.

(ImageOutputProxy).image_layout_specifier

Gets image specifier.

(ImageOutputProxy).image_render_specifier

Gets image specifier.

(ImageOutputProxy).payload

Gets images output proxy payload.

Returns string.

Methods

LilyPondOutputProxy.as_docutils(configuration=None, output_directory=None)

Creates a docutils node representation of the output proxy.

>>> for node in proxy.as_docutils():
...     print(node.pformat())
...
<abjad_output_block image_layout_specifier image_render_specifier renderer="lilypond" xml:space="preserve">
    \version "2.19.0"
    \language "english"

    #(set-global-staff-size 12)

    \header {
        tagline = ##f
    }

    \layout {
        indent = #0
        ragged-right = ##t
        \context {
            \Score
            \remove Bar_number_engraver
            \override SpacingSpanner.strict-grace-spacing = ##t
            \override SpacingSpanner.strict-note-spacing = ##t
            \override SpacingSpanner.uniform-stretching = ##t
            \override TupletBracket.bracket-visibility = ##t
            \override TupletBracket.minimum-length = #3
            \override TupletBracket.padding = #2
            \override TupletBracket.springs-and-rods = #ly:spanner::set-spacing-rods
            \override TupletNumber.text = #tuplet-number::calc-fraction-text
            proportionalNotationDuration = #(ly:make-moment 1 24)
            tupletFullLength = ##t
        }
    }

    \paper {
        left-margin = 1\in
    }

    \score {
        \new Staff {
            c'4
            d'4
            e'4
            f'4
        }
    }

Returns list of docutils nodes.

(ImageOutputProxy).as_latex(configuration=None, output_directory=None, relative_output_directory=None)

Creates a LaTeX representation of the image output proxy.

(ImageOutputProxy).render_for_latex(absolute_output_directory)

Renders the image output proxy payload for LaTeX inclusion.

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.