LilyPondDimension

class lilypondfiletools.LilyPondDimension(value=0, unit='cm')

A LilyPond file \paper block dimension.

>>> import abjad
>>> abjad.LilyPondDimension(2, 'in')
LilyPondDimension(value=2, unit='in')

Use for LilyPond file \paper block attributes.

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.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_lilypondfiletools { graph [label=lilypondfiletools]; "abjad.tools.lilypondfiletools.LilyPondDimension.LilyPondDimension" [color=black, fontcolor=white, group=2, label=<<B>LilyPondDimension</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.AbjadObject.AbjadObject" -> "abjad.tools.lilypondfiletools.LilyPondDimension.LilyPondDimension"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

unit Gets unit of LilyPond dimension.
value Gets value of LilyPond dimension.
__eq__(argument) Is true when ID of argument equals ID of Abjad object.
__format__([format_specification]) Formats LilyPond dimension.
__hash__() Hashes Abjad object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

LilyPondDimension.unit

Gets unit of LilyPond dimension.

>>> dimension = abjad.LilyPondDimension(2, 'in')
>>> dimension.unit
'in'

Returns 'cm', 'in', 'mm' or 'pt'.

LilyPondDimension.value

Gets value of LilyPond dimension.

>>> dimension = abjad.LilyPondDimension(2, 'in')
>>> dimension.value
2

Returns number.

Special methods

(AbjadObject).__eq__(argument)

Is true when ID of argument equals ID of Abjad object. Otherwise false.

Returns true or false.

LilyPondDimension.__format__(format_specification='')

Formats LilyPond dimension.

>>> dimension = abjad.LilyPondDimension(2, 'in')
>>> print(format(dimension))
2\in

Returns string.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(AbjadObject).__ne__(argument)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.