.. _moduleVariant:

music21.variant
===============

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

.. automodule:: music21.variant

Functions
---------

.. autofunction:: music21.variant.addVariant

.. autofunction:: music21.variant.getMeasureHashes

.. autofunction:: music21.variant.makeAllVariantsReplacements

.. autofunction:: music21.variant.mergePartAsOssia

.. autofunction:: music21.variant.mergeVariantMeasureStreams

.. autofunction:: music21.variant.mergeVariantScores

.. autofunction:: music21.variant.mergeVariants

.. autofunction:: music21.variant.mergeVariantsEqualDuration

.. autofunction:: music21.variant.refineVariant

Variant
-------

.. autoclass:: music21.variant.Variant

.. rubric:: :class:`~music21.variant.Variant` bases

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

.. rubric:: :class:`~music21.variant.Variant` read-only properties

.. autoattribute:: music21.variant.Variant.containedHighestOffset

.. autoattribute:: music21.variant.Variant.containedHighestTime

.. autoattribute:: music21.variant.Variant.containedSite

.. autoattribute:: music21.variant.Variant.highestOffset

.. autoattribute:: music21.variant.Variant.highestTime

.. autoattribute:: music21.variant.Variant.lengthType

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.variant.Variant` read/write properties

.. autoattribute:: music21.variant.Variant.replacementDuration

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`

.. rubric:: :class:`~music21.variant.Variant` methods

.. automethod:: music21.variant.Variant.getElementIds

.. automethod:: music21.variant.Variant.purgeLocations

.. automethod:: music21.variant.Variant.purgeOrphans

.. automethod:: music21.variant.Variant.removeReplacedElementsFromStream

.. automethod:: music21.variant.Variant.replaceElement

.. automethod:: music21.variant.Variant.replacedElements

.. automethod:: music21.variant.Variant.show

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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :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.variant.Variant` 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`
