.. _moduleEditorial:

music21.editorial
=================

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

.. automodule:: music21.editorial

Functions
---------

.. autofunction:: music21.editorial.getObjectsWithEditorial

NoteEditorial
-------------

.. autoclass:: music21.editorial.NoteEditorial

.. rubric:: :class:`~music21.editorial.NoteEditorial` bases

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

.. rubric:: :class:`~music21.editorial.NoteEditorial` methods

.. automethod:: music21.editorial.NoteEditorial.colorLilyStart

.. automethod:: music21.editorial.NoteEditorial.fictaLilyStart

.. automethod:: music21.editorial.NoteEditorial.lilyAttached

.. automethod:: music21.editorial.NoteEditorial.lilyEnd

.. automethod:: music21.editorial.NoteEditorial.lilyStart

.. rubric:: :class:`~music21.editorial.NoteEditorial` instance variables

.. attribute:: NoteEditorial.color

	the color of the note (RGP, x11 colors, and extended x11colors are allowed)

.. attribute:: NoteEditorial.comment

	a reference to a :class:`~music21.editorial.Comment` object

.. attribute:: NoteEditorial.ficta

	a :class:`~music21.pitch.Accidental` object that specifies musica
	ficta for the note.  Will only be displayed in LilyPond and then only if
	there is no Accidental object on the note itself

.. attribute:: NoteEditorial.harmonicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the harmonic interval between this note and a single other note
	(useful for storing information post analysis)

.. attribute:: NoteEditorial.harmonicIntervals

	a list for when you want to store more than one harmonicInterval

.. attribute:: NoteEditorial.hidden

	boolean value about whether to hide the
	note or not (only works in lilypond)

.. attribute:: NoteEditorial.melodicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the melodic interval to the next note in this part/voice/stream, etc.

.. attribute:: NoteEditorial.melodicIntervals

	a list for storing more than one melodic interval

.. attribute:: NoteEditorial.melodicIntervalsOverRests

	same thing but a list

.. attribute:: NoteEditorial.misc

	A dict to hold anything you might like to store.

Comment
-------

.. autoclass:: music21.editorial.Comment

.. rubric:: :class:`~music21.editorial.Comment` bases

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

.. rubric:: :class:`~music21.editorial.Comment` read-only properties

.. autoattribute:: music21.editorial.Comment.lily
