ImageOutputProxy

abstract class abjadbooktools.ImageOutputProxy(image_layout_specifier=None, image_render_specifier=None)

Abstract base class for image output proxies.

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.GraphvizOutputProxy.GraphvizOutputProxy" [color=2, group=1, label=GraphvizOutputProxy, shape=box]; "abjad.tools.abjadbooktools.ImageOutputProxy.ImageOutputProxy" [color=black, fontcolor=white, group=1, label=<<B>ImageOutputProxy</B>>, shape=oval, style="filled, rounded"]; "abjad.tools.abjadbooktools.LilyPondOutputProxy.LilyPondOutputProxy" [color=2, group=1, label=LilyPondOutputProxy, shape=box]; "abjad.tools.abjadbooktools.ImageOutputProxy.ImageOutputProxy" -> "abjad.tools.abjadbooktools.GraphvizOutputProxy.GraphvizOutputProxy"; "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"; }

Bases

Attribute summary

as_latex([configuration, output_directory, ...]) Creates a LaTeX representation of the image output proxy.
file_name_prefix Gets image output proxy file name prefix.
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

abstract ImageOutputProxy.file_name_prefix

Gets image output proxy file name prefix.

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

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.