KeyCluster

class indicatortools.KeyCluster(include_black_keys=True, include_white_keys=True, markup_direction=Up, suppress_markup=False)

A key cluster indicator.

Example 1. Default values:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster()
>>> attach(key_cluster, chord)
>>> show(chord) 

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

Bases

Attribute summary

default_scope Gest default scope of key cluster indicator.
include_black_keys Is true if key cluster includes black keys.
include_white_keys Is true if key cluster includes white keys.
markup_direction Gets markup direction.
suppress_markup Is true if key cluster suppresses key markup.
__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

KeyCluster.default_scope

Gest default scope of key cluster indicator.

>>> key_cluster = indicatortools.KeyCluster()
>>> key_cluster.default_scope is None
True

Returns none.

KeyCluster.include_black_keys

Is true if key cluster includes black keys.

Example 1. Includes flat markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     include_black_keys=True,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Default behavior.

Example 2. Does not include flat markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     include_black_keys=False,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Todo

Rename to include_flat_markup.

Set to true or false.

KeyCluster.include_white_keys

Is true if key cluster includes white keys.

Example 1. Includes natural markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     include_white_keys=True,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Default behavior.

Example 2. Does not include natural markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     include_white_keys=False,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Todo

Rename to include_natural_markup.

Set to true or false.

KeyCluster.markup_direction

Gets markup direction.

Example 1. Positions markup up:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     markup_direction=Up,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Default behavior.

Example 2. Positions markup down:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     markup_direction=Down,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Set to up, down or center.

KeyCluster.suppress_markup

Is true if key cluster suppresses key markup.

Example 1. Does not suppress markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     suppress_markup=False,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Default behavior.

Example 2. Does not suppress markup:

>>> chord = Chord("<c' e' g' b' d'' f''>8")
>>> key_cluster = indicatortools.KeyCluster(
...     suppress_markup=True,
...     )
>>> attach(key_cluster, chord)
>>> show(chord) 

Todo

Remove?

Set to true or false.

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.