specifiers

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.system" { graph [label="abjad.system"]; node [color=1]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjadext/book/../../abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjadext/book/../../abjad/system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph "cluster_abjadext.book.specifiers" { graph [label="abjadext.book.specifiers"]; node [color=2]; "abjadext.book.specifiers.CodeBlockSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.CodeBlockSpecifier", color=black, fontcolor=white, label="Code\nBlock\nSpecifier", target=_top]; "abjadext.book.specifiers.ImageLayoutSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.ImageLayoutSpecifier", color=black, fontcolor=white, label="Image\nLayout\nSpecifier", target=_top]; "abjadext.book.specifiers.ImageRenderSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.ImageRenderSpecifier", color=black, fontcolor=white, label="Image\nRender\nSpecifier", target=_top]; } 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" -> "abjadext.book.specifiers.CodeBlockSpecifier"; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.specifiers.ImageLayoutSpecifier"; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.specifiers.ImageRenderSpecifier"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }


Internals

CodeBlockSpecifier A code block specifier.
ImageLayoutSpecifier An image layout specifier.
ImageRenderSpecifier An image render specifier.
class abjadext.book.specifiers.CodeBlockSpecifier(allow_exceptions=None, hide=None, strip_prompt=None, text_width=None)

A code block specifier.


Attributes Summary

allow_exceptions Is true if code block allows exceptions.
from_options Creates code block specifier from options dictionary.
hide Is true if code block should be hidden.
strip_prompt Is true if code block should strip Python prompt from output.
text_width Gets text width wrap of code block.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

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).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Class & static methods

classmethod from_options(**options)

Creates code block specifier from options dictionary.

Returns code block specifier.


Read-only properties

allow_exceptions

Is true if code block allows exceptions. Otherwise false.

Returns true or false.

hide

Is true if code block should be hidden. Otherwise false.

Returns true or false.

strip_prompt

Is true if code block should strip Python prompt from output. Otherwise false.

Returns true or false.

text_width

Gets text width wrap of code block.

Returns integer or none.

class abjadext.book.specifiers.ImageLayoutSpecifier(pages=None, with_columns=None, with_thumbnail=None)

An image layout specifier.


Attributes Summary

from_options Creates image specifier from options dictionary.
pages Gets page indices.
with_columns Gets column count for table layout.
with_thumbnail Is true if image should have a thumbnail.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

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).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Class & static methods

classmethod from_options(**options)

Creates image specifier from options dictionary.

Returns image specifier.


Read-only properties

pages

Gets page indices.

Returns tuple of integers or none.

with_columns

Gets column count for table layout.

Return integer or none.

with_thumbnail

Is true if image should have a thumbnail.

Returns true or false.

class abjadext.book.specifiers.ImageRenderSpecifier(no_resize=None, no_stylesheet=None, no_trim=None, stylesheet=None)

An image render specifier.


Attributes Summary

from_options Creates image specifier from options dictionary.
no_resize Is true if image should not be resized.
no_stylesheet Is true if no stylesheet should be used with image at all.
no_trim Is true if image should not be trimmed of whitespace.
stylesheet Gets stylesheet name to be used for image.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

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).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Class & static methods

classmethod from_options(**options)

Creates image specifier from options dictionary.

Returns image specifier.


Read-only properties

no_resize

Is true if image should not be resized.

Returns true or false.

no_stylesheet

Is true if no stylesheet should be used with image at all.

Returns true or false.

no_trim

Is true if image should not be trimmed of whitespace.

Returns true or false.

stylesheet

Gets stylesheet name to be used for image.

Returns string or none.