.. _moduleStyle:

music21.style
=============

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.style

BeamStyle
---------

.. autoclass:: music21.style.BeamStyle

.. rubric:: :class:`~music21.style.BeamStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.BeamStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.BeamStyle` read/write properties

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.BeamStyle` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

BezierStyle
-----------

.. autoclass:: music21.style.BezierStyle

.. rubric:: :class:`~music21.style.BezierStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.BezierStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.BezierStyle` read/write properties

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.BezierStyle` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

Enclosure
---------

.. autoclass:: music21.style.Enclosure

.. rubric:: :class:`~music21.style.Enclosure` bases

- :class:`~music21.common.enums.StrEnum`

LineStyle
---------

.. autoclass:: music21.style.LineStyle

.. rubric:: :class:`~music21.style.LineStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.LineStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.LineStyle` read/write properties

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.LineStyle` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

NoteStyle
---------

.. autoclass:: music21.style.NoteStyle

.. rubric:: :class:`~music21.style.NoteStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.NoteStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.NoteStyle` read/write properties

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.NoteStyle` instance variables

.. attribute:: NoteStyle.accidentalStyle

	
	An optional style.Style object describing what the accidental looks like.
	
	>>> n = note.Note()
	>>> n.style.accidentalStyle is None
	True
	
	Note that accidentalStyle is not created automatically.  Users must
	instantiate a :class:`~music21.style.Style` object.
	
	>>> n.style.accidentalStyle = style.Style()
	>>> n.style.accidentalStyle.relativeX = -2.0
	
	Note: do not use .hideObjectOnPrint in accidentalStyle to hide the
	accidental.  Set the displayType on the Accidental itself.
	
	This object may eventually move to Note.pitch.accidental.style.
	

.. attribute:: NoteStyle.noteSize

	
	An optional string representing the size of the note as a type of note.
	
	Valid values are None (=normal), `'cue'`, `'grace'`, `'graceCue'`, and `'large'`
	(taken from MusicXML, with "graceCue" replacing "grace-cue").
	

.. attribute:: NoteStyle.stemStyle

	
	An optional style.Style object describing what the stem looks like.
	
	>>> n = note.Note()
	>>> n.style.stemStyle is None
	True
	
	Note that stemStyle is not created automatically.  Users must
	instantiate a :class:`~music21.style.Style` object.
	
	>>> n.style.stemStyle = style.Style()
	>>> n.style.stemStyle.color = 'red'
	

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

StreamStyle
-----------

.. autoclass:: music21.style.StreamStyle

.. rubric:: :class:`~music21.style.StreamStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.StreamStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.StreamStyle` read/write properties

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.StreamStyle` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

Style
-----

.. autoclass:: music21.style.Style

.. rubric:: :class:`~music21.style.Style` bases

- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.Style` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.Style` read/write properties

.. autoattribute:: music21.style.Style.absoluteY

.. autoattribute:: music21.style.Style.enclosure

.. rubric:: :class:`~music21.style.Style` instance variables

.. attribute:: Style.hideObjectOnPrint

	
	If set to `True`, the Music21Object will not print upon output
	(only used in MusicXML output at this point and
	in Lilypond output for notes, chords, and rests).
	

.. attribute:: Style.units

	
	What distances are measured in.  The default "tenths" is a concept
	borrowed from MusicXML which refers to 1/10th of the distance between
	two staff lines.  It is currently also the only supported unit.
	

StyleMixin
----------

.. autoclass:: music21.style.StyleMixin

.. rubric:: :class:`~music21.style.StyleMixin` bases

- :class:`~music21.common.objects.SlottedObjectMixin`

.. rubric:: :class:`~music21.style.StyleMixin` read-only properties

.. autoattribute:: music21.style.StyleMixin.hasEditorialInformation

.. autoattribute:: music21.style.StyleMixin.hasStyleInformation

.. rubric:: :class:`~music21.style.StyleMixin` read/write properties

.. autoattribute:: music21.style.StyleMixin.editorial

.. autoattribute:: music21.style.StyleMixin.style

TextStyle
---------

.. autoclass:: music21.style.TextStyle

.. rubric:: :class:`~music21.style.TextStyle` bases

- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.TextStyle` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.TextStyle` read/write properties

.. autoattribute:: music21.style.TextStyle.alignHorizontal

.. autoattribute:: music21.style.TextStyle.alignVertical

.. autoattribute:: music21.style.TextStyle.fontFamily

.. autoattribute:: music21.style.TextStyle.fontSize

.. autoattribute:: music21.style.TextStyle.fontStyle

.. autoattribute:: music21.style.TextStyle.fontWeight

.. autoattribute:: music21.style.TextStyle.justify

.. autoattribute:: music21.style.TextStyle.letterSpacing

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.TextStyle` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`

TextStylePlacement
------------------

.. autoclass:: music21.style.TextStylePlacement

.. rubric:: :class:`~music21.style.TextStylePlacement` bases

- :class:`~music21.style.TextStyle`
- :class:`~music21.style.Style`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.style.TextStylePlacement` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.style.TextStylePlacement` read/write properties

Read/write properties inherited from :class:`~music21.style.TextStyle`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.TextStyle.alignHorizontal`
   - :attr:`~music21.style.TextStyle.alignVertical`
   - :attr:`~music21.style.TextStyle.fontFamily`
   - :attr:`~music21.style.TextStyle.fontSize`
   - :attr:`~music21.style.TextStyle.fontStyle`
   - :attr:`~music21.style.TextStyle.fontWeight`
   - :attr:`~music21.style.TextStyle.justify`
   - :attr:`~music21.style.TextStyle.letterSpacing`

Read/write properties inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.absoluteY`
   - :attr:`~music21.style.Style.enclosure`

.. rubric:: :class:`~music21.style.TextStylePlacement` instance variables

Instance variables inherited from :class:`~music21.style.Style`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.Style.hideObjectOnPrint`
   - :attr:`~music21.style.Style.units`
