.. _moduleText:

music21.text
============

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

.. automodule:: music21.text

Functions
---------

.. autofunction:: music21.text.assembleAllLyrics

.. autofunction:: music21.text.assembleLyrics

.. autofunction:: music21.text.postpendArticle

.. autofunction:: music21.text.prependArticle

TextBox
-------

.. autoclass:: music21.text.TextBox

.. rubric:: :class:`~music21.text.TextBox` bases

- :class:`~music21.base.Music21Object`
- :class:`~music21.text.TextFormat`

.. rubric:: :class:`~music21.text.TextBox` read-only properties

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.text.TextBox` read/write properties

.. autoattribute:: music21.text.TextBox.alignHorizontal

.. autoattribute:: music21.text.TextBox.alignVertical

.. autoattribute:: music21.text.TextBox.content

.. autoattribute:: music21.text.TextBox.page

.. autoattribute:: music21.text.TextBox.positionHorizontal

.. autoattribute:: music21.text.TextBox.positionVertical

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

Read/write properties inherited from :class:`~music21.text.TextFormat`:

.. hlist::
   :columns: 3

   - :attr:`~music21.text.TextFormat.justify`
   - :attr:`~music21.text.TextFormat.letterSpacing`
   - :attr:`~music21.text.TextFormat.size`
   - :attr:`~music21.text.TextFormat.style`
   - :attr:`~music21.text.TextFormat.weight`

.. rubric:: :class:`~music21.text.TextBox` methods

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.text.TextBox` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`

TextFormat
----------

.. autoclass:: music21.text.TextFormat

.. rubric:: :class:`~music21.text.TextFormat` read/write properties

.. autoattribute:: music21.text.TextFormat.justify

.. autoattribute:: music21.text.TextFormat.letterSpacing

.. autoattribute:: music21.text.TextFormat.size

.. autoattribute:: music21.text.TextFormat.style

.. autoattribute:: music21.text.TextFormat.weight

LanguageDetector
----------------

.. autoclass:: music21.text.LanguageDetector

.. rubric:: :class:`~music21.text.LanguageDetector` methods

.. automethod:: music21.text.LanguageDetector.mostLikelyLanguage

.. automethod:: music21.text.LanguageDetector.mostLikelyLanguageNumeric

.. automethod:: music21.text.LanguageDetector.readExcerpts

Trigram
-------

.. autoclass:: music21.text.Trigram

.. rubric:: :class:`~music21.text.Trigram` read-only properties

.. autoattribute:: music21.text.Trigram.length

.. rubric:: :class:`~music21.text.Trigram` methods

.. automethod:: music21.text.Trigram.likely

.. automethod:: music21.text.Trigram.makeWords

.. automethod:: music21.text.Trigram.measure

.. automethod:: music21.text.Trigram.parseExcerpt

.. automethod:: music21.text.Trigram.similarity
