ScoreTemplate

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.segments" { graph [label="abjad.segments"]; node [color=1]; "abjad.segments.GroupedRhythmicStavesScoreTemplate.GroupedRhythmicStavesScoreTemplate" [URL="../api/abjad/segments/GroupedRhythmicStavesScoreTemplate.html#abjad.segments.GroupedRhythmicStavesScoreTemplate.GroupedRhythmicStavesScoreTemplate", color=1, label="Grouped\nRhythmic\nStaves\nScore\nTemplate", target=_top]; "abjad.segments.GroupedStavesScoreTemplate.GroupedStavesScoreTemplate" [URL="../api/abjad/segments/GroupedStavesScoreTemplate.html#abjad.segments.GroupedStavesScoreTemplate.GroupedStavesScoreTemplate", color=1, label="Grouped\nStaves\nScore\nTemplate", target=_top]; "abjad.segments.ScoreTemplate.ScoreTemplate" [URL="../api/abjad/segments/ScoreTemplate.html#abjad.segments.ScoreTemplate.ScoreTemplate", color=black, fontcolor=white, label="Score\nTemplate", shape=oval, style="bold, filled", target=_top]; "abjad.segments.ScoreTemplate.ScoreTemplate" -> "abjad.segments.GroupedRhythmicStavesScoreTemplate.GroupedRhythmicStavesScoreTemplate" [minlen=1]; "abjad.segments.ScoreTemplate.ScoreTemplate" -> "abjad.segments.GroupedStavesScoreTemplate.GroupedStavesScoreTemplate" [minlen=2]; "abjad.segments.StringOrchestraScoreTemplate.StringOrchestraScoreTemplate" [URL="../api/abjad/segments/StringOrchestraScoreTemplate.html#abjad.segments.StringOrchestraScoreTemplate.StringOrchestraScoreTemplate", color=1, label="String\nOrchestra\nScore\nTemplate", target=_top]; "abjad.segments.ScoreTemplate.ScoreTemplate" -> "abjad.segments.StringOrchestraScoreTemplate.StringOrchestraScoreTemplate" [minlen=1]; "abjad.segments.StringQuartetScoreTemplate.StringQuartetScoreTemplate" [URL="../api/abjad/segments/StringQuartetScoreTemplate.html#abjad.segments.StringQuartetScoreTemplate.StringQuartetScoreTemplate", color=1, label="String\nQuartet\nScore\nTemplate", target=_top]; "abjad.segments.ScoreTemplate.ScoreTemplate" -> "abjad.segments.StringQuartetScoreTemplate.StringQuartetScoreTemplate" [minlen=2]; "abjad.segments.TwoStaffPianoScoreTemplate.TwoStaffPianoScoreTemplate" [URL="../api/abjad/segments/TwoStaffPianoScoreTemplate.html#abjad.segments.TwoStaffPianoScoreTemplate.TwoStaffPianoScoreTemplate", color=1, label="Two\nStaff\nPiano\nScore\nTemplate", target=_top]; "abjad.segments.ScoreTemplate.ScoreTemplate" -> "abjad.segments.TwoStaffPianoScoreTemplate.TwoStaffPianoScoreTemplate" [minlen=1]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=2]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/segments/../system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", color=2, label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjad/segments/../system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", color=2, label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject" [minlen=1]; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", color=3, label=object, target=_top]; } "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.segments.ScoreTemplate.ScoreTemplate"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject" [minlen=1]; }

abstract class abjad.segments.ScoreTemplate.ScoreTemplate

Abstract score template.


Attributes Summary

__call__ Calls score template.
__illustrate__ Illustrates score template.
allows_instrument Is true when staff_name allows instrument.
allows_part_assignment Is true when voice_name allows part_assignment.
always_make_global_rests Is true when score template always makes global rests.
attach_defaults Attaches defaults to all staff and staff group contexts in argument when argument is a score.
do_not_require_margin_markup Is true when score template does not require margin markup.
part_manifest Gets part manifest.
voice_abbreviations Gets voice abbreviations.

Special methods

abstract __call__()

Calls score template.

Return type:Score
(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.

__illustrate__(default_paper_size=None, global_staff_size=None, includes=None)

Illustrates score template.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Methods

allows_instrument(staff_name, instrument)

Is true when staff_name allows instrument.

To be implemented by concrete score template classes.

Return type:bool
allows_part_assignment(voice_name, part_assignment)

Is true when voice_name allows part_assignment.

Return type:bool
attach_defaults(argument)

Attaches defaults to all staff and staff group contexts in argument when argument is a score.

Attaches defaults to argument (without iterating argument) when argument is a staff or staff group.

Returns list of one wrapper for every indicator attached.

Return type:List[~T]

Read-only properties

always_make_global_rests

Is true when score template always makes global rests.

Return type:bool
do_not_require_margin_markup

Is true when score template does not require margin markup.

Conventionally, solos do not require margin markup.

Return type:bool
part_manifest

Gets part manifest.

Return type:Optional[PartManifest]
voice_abbreviations

Gets voice abbreviations.

Return type:OrderedDict