.. _moduleLayout:

music21.layout
==============

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

.. automodule:: music21.layout

Functions
---------

.. autofunction:: music21.layout.divideByPages

.. autofunction:: music21.layout.getPageRegionMeasureNumbers

.. autofunction:: music21.layout.getRegionMeasureNumbers

.. autofunction:: music21.layout.getSystemRegionMeasureNumbers

ScoreLayout
-----------

.. autoclass:: music21.layout.ScoreLayout

.. rubric:: :class:`~music21.layout.ScoreLayout` bases

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

.. rubric:: :class:`~music21.layout.ScoreLayout` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.ScoreLayout` read/write properties

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.ScoreLayout` methods

.. automethod:: music21.layout.ScoreLayout.tenthsToMillimeters

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.ScoreLayout` instance variables

.. attribute:: ScoreLayout.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: ScoreLayout.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: ScoreLayout.hideObjectOnPrint

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

.. attribute:: ScoreLayout.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: ScoreLayout.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: ScoreLayout.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: ScoreLayout.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: ScoreLayout.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.layout.LayoutBase`:

.. hlist::
   :columns: 3

   - :attr:`~music21.layout.LayoutBase.isStream`
   - :attr:`~music21.layout.LayoutBase.hideObjectOnPrint`
   - :attr:`~music21.layout.LayoutBase.classSortOrder`
   - :attr:`~music21.layout.LayoutBase.groups`
   - :attr:`~music21.layout.LayoutBase.isVariant`
   - :attr:`~music21.layout.LayoutBase.id`
   - :attr:`~music21.layout.LayoutBase.isSpanner`
   - :attr:`~music21.layout.LayoutBase.xPosition`

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

.. hlist::
   :columns: 3

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

PageLayout
----------

.. autoclass:: music21.layout.PageLayout

.. rubric:: :class:`~music21.layout.PageLayout` bases

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

.. rubric:: :class:`~music21.layout.PageLayout` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.PageLayout` read/write properties

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.PageLayout` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.PageLayout` instance variables

.. attribute:: PageLayout.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: PageLayout.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: PageLayout.hideObjectOnPrint

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

.. attribute:: PageLayout.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: PageLayout.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: PageLayout.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: PageLayout.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: PageLayout.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.layout.LayoutBase`:

.. hlist::
   :columns: 3

   - :attr:`~music21.layout.LayoutBase.isStream`
   - :attr:`~music21.layout.LayoutBase.hideObjectOnPrint`
   - :attr:`~music21.layout.LayoutBase.classSortOrder`
   - :attr:`~music21.layout.LayoutBase.groups`
   - :attr:`~music21.layout.LayoutBase.isVariant`
   - :attr:`~music21.layout.LayoutBase.id`
   - :attr:`~music21.layout.LayoutBase.isSpanner`
   - :attr:`~music21.layout.LayoutBase.xPosition`

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

.. hlist::
   :columns: 3

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

SystemLayout
------------

.. autoclass:: music21.layout.SystemLayout

.. rubric:: :class:`~music21.layout.SystemLayout` bases

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

.. rubric:: :class:`~music21.layout.SystemLayout` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.SystemLayout` read/write properties

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.SystemLayout` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.SystemLayout` instance variables

.. attribute:: SystemLayout.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: SystemLayout.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: SystemLayout.hideObjectOnPrint

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

.. attribute:: SystemLayout.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: SystemLayout.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: SystemLayout.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: SystemLayout.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: SystemLayout.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.layout.LayoutBase`:

.. hlist::
   :columns: 3

   - :attr:`~music21.layout.LayoutBase.isStream`
   - :attr:`~music21.layout.LayoutBase.hideObjectOnPrint`
   - :attr:`~music21.layout.LayoutBase.classSortOrder`
   - :attr:`~music21.layout.LayoutBase.groups`
   - :attr:`~music21.layout.LayoutBase.isVariant`
   - :attr:`~music21.layout.LayoutBase.id`
   - :attr:`~music21.layout.LayoutBase.isSpanner`
   - :attr:`~music21.layout.LayoutBase.xPosition`

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

.. hlist::
   :columns: 3

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

StaffLayout
-----------

.. autoclass:: music21.layout.StaffLayout

.. rubric:: :class:`~music21.layout.StaffLayout` bases

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

.. rubric:: :class:`~music21.layout.StaffLayout` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.StaffLayout` read/write properties

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.StaffLayout` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.StaffLayout` instance variables

.. attribute:: StaffLayout.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: StaffLayout.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: StaffLayout.hideObjectOnPrint

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

.. attribute:: StaffLayout.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: StaffLayout.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: StaffLayout.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: StaffLayout.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: StaffLayout.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.layout.LayoutBase`:

.. hlist::
   :columns: 3

   - :attr:`~music21.layout.LayoutBase.isStream`
   - :attr:`~music21.layout.LayoutBase.hideObjectOnPrint`
   - :attr:`~music21.layout.LayoutBase.classSortOrder`
   - :attr:`~music21.layout.LayoutBase.groups`
   - :attr:`~music21.layout.LayoutBase.isVariant`
   - :attr:`~music21.layout.LayoutBase.id`
   - :attr:`~music21.layout.LayoutBase.isSpanner`
   - :attr:`~music21.layout.LayoutBase.xPosition`

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

.. hlist::
   :columns: 3

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

LayoutBase
----------

.. autoclass:: music21.layout.LayoutBase

.. rubric:: :class:`~music21.layout.LayoutBase` bases

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

.. rubric:: :class:`~music21.layout.LayoutBase` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.LayoutBase` read/write properties

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.LayoutBase` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.LayoutBase` instance variables

.. attribute:: LayoutBase.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: LayoutBase.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: LayoutBase.hideObjectOnPrint

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

.. attribute:: LayoutBase.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: LayoutBase.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: LayoutBase.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: LayoutBase.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: LayoutBase.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

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

.. hlist::
   :columns: 3

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

LayoutScore
-----------

.. autoclass:: music21.layout.LayoutScore

.. rubric:: :class:`~music21.layout.LayoutScore` bases

- :class:`~music21.stream.Opus`
- :class:`~music21.stream.Stream`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.layout.LayoutScore` read-only properties

.. autoattribute:: music21.layout.LayoutScore.pages

Read-only properties inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Opus.scores`

Read-only properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.beat`
   - :attr:`~music21.stream.Stream.beatDuration`
   - :attr:`~music21.stream.Stream.beatStr`
   - :attr:`~music21.stream.Stream.beatStrength`
   - :attr:`~music21.stream.Stream.derivationChain`
   - :attr:`~music21.stream.Stream.flat`
   - :attr:`~music21.stream.Stream.highestOffset`
   - :attr:`~music21.stream.Stream.highestTime`
   - :attr:`~music21.stream.Stream.isGapless`
   - :attr:`~music21.stream.Stream.lowestOffset`
   - :attr:`~music21.stream.Stream.notes`
   - :attr:`~music21.stream.Stream.notesAndRests`
   - :attr:`~music21.stream.Stream.offsetMap`
   - :attr:`~music21.stream.Stream.pitches`
   - :attr:`~music21.stream.Stream.rootDerivation`
   - :attr:`~music21.stream.Stream.secondsMap`
   - :attr:`~music21.stream.Stream.semiFlat`
   - :attr:`~music21.stream.Stream.sorted`
   - :attr:`~music21.stream.Stream.spannerBundle`
   - :attr:`~music21.stream.Stream.spanners`
   - :attr:`~music21.stream.Stream.variants`
   - :attr:`~music21.stream.Stream.voices`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.LayoutScore` read/write properties

Read/write properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.atSoundingPitch`
   - :attr:`~music21.stream.Stream.derivationMethod`
   - :attr:`~music21.stream.Stream.derivesFrom`
   - :attr:`~music21.stream.Stream.duration`
   - :attr:`~music21.stream.Stream.elements`
   - :attr:`~music21.stream.Stream.finalBarline`
   - :attr:`~music21.stream.Stream.metadata`
   - :attr:`~music21.stream.Stream.seconds`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`

.. rubric:: :class:`~music21.layout.LayoutScore` methods

.. automethod:: music21.layout.LayoutScore.getAllMeasurePositionsInDocument

.. automethod:: music21.layout.LayoutScore.getMarginsAndSizeForPageId

.. automethod:: music21.layout.LayoutScore.getPageAndSystemNumberFromMeasureNumber

.. automethod:: music21.layout.LayoutScore.getPositionForStaff

.. automethod:: music21.layout.LayoutScore.getPositionForStaffMeasure

.. automethod:: music21.layout.LayoutScore.getPositionForSystem

.. automethod:: music21.layout.LayoutScore.getStaffDistanceFromPrevious

.. automethod:: music21.layout.LayoutScore.getStaffHiddenAttribute

.. automethod:: music21.layout.LayoutScore.getStaffSizeFromLayout

.. automethod:: music21.layout.LayoutScore.getSystemBeforeThis

.. automethod:: music21.layout.LayoutScore.measurePositionWithinSystem

Methods inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Opus.getNumbers`
   - :meth:`~music21.stream.Opus.getScoreByNumber`
   - :meth:`~music21.stream.Opus.getScoreByTitle`
   - :meth:`~music21.stream.Opus.mergeScores`
   - :meth:`~music21.stream.Opus.show`
   - :meth:`~music21.stream.Opus.write`

Methods inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Stream.activateVariants`
   - :meth:`~music21.stream.Stream.addGroupForElements`
   - :meth:`~music21.stream.Stream.allPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.analyze`
   - :meth:`~music21.stream.Stream.append`
   - :meth:`~music21.stream.Stream.attachIntervalsBetweenStreams`
   - :meth:`~music21.stream.Stream.attachMelodicIntervals`
   - :meth:`~music21.stream.Stream.attributeCount`
   - :meth:`~music21.stream.Stream.augmentOrDiminish`
   - :meth:`~music21.stream.Stream.beatAndMeasureFromOffset`
   - :meth:`~music21.stream.Stream.bestClef`
   - :meth:`~music21.stream.Stream.chordify`
   - :meth:`~music21.stream.Stream.expandRepeats`
   - :meth:`~music21.stream.Stream.explode`
   - :meth:`~music21.stream.Stream.extendDuration`
   - :meth:`~music21.stream.Stream.extendDurationAndGetBoundaries`
   - :meth:`~music21.stream.Stream.extendTies`
   - :meth:`~music21.stream.Stream.extractContext`
   - :meth:`~music21.stream.Stream.findConsecutiveNotes`
   - :meth:`~music21.stream.Stream.findGaps`
   - :meth:`~music21.stream.Stream.flattenUnnecessaryVoices`
   - :meth:`~music21.stream.Stream.getClefs`
   - :meth:`~music21.stream.Stream.getElementAfterElement`
   - :meth:`~music21.stream.Stream.getElementAtOrBefore`
   - :meth:`~music21.stream.Stream.getElementBeforeOffset`
   - :meth:`~music21.stream.Stream.getElementById`
   - :meth:`~music21.stream.Stream.getElementsByClass`
   - :meth:`~music21.stream.Stream.getElementsByGroup`
   - :meth:`~music21.stream.Stream.getElementsByOffset`
   - :meth:`~music21.stream.Stream.getElementsNotOfClass`
   - :meth:`~music21.stream.Stream.getInstrument`
   - :meth:`~music21.stream.Stream.getInstruments`
   - :meth:`~music21.stream.Stream.getKeySignatures`
   - :meth:`~music21.stream.Stream.getOffsetByElement`
   - :meth:`~music21.stream.Stream.getOverlaps`
   - :meth:`~music21.stream.Stream.getSimultaneous`
   - :meth:`~music21.stream.Stream.getTimeSignatures`
   - :meth:`~music21.stream.Stream.groupElementsByOffset`
   - :meth:`~music21.stream.Stream.hasElement`
   - :meth:`~music21.stream.Stream.hasElementOfClass`
   - :meth:`~music21.stream.Stream.hasMeasures`
   - :meth:`~music21.stream.Stream.hasPartLikeStreams`
   - :meth:`~music21.stream.Stream.hasVoices`
   - :meth:`~music21.stream.Stream.haveAccidentalsBeenMade`
   - :meth:`~music21.stream.Stream.haveBeamsBeenMade`
   - :meth:`~music21.stream.Stream.index`
   - :meth:`~music21.stream.Stream.insert`
   - :meth:`~music21.stream.Stream.insertAndShift`
   - :meth:`~music21.stream.Stream.insertIntoNoteOrChord`
   - :meth:`~music21.stream.Stream.internalize`
   - :meth:`~music21.stream.Stream.invertDiatonic`
   - :meth:`~music21.stream.Stream.isSequence`
   - :meth:`~music21.stream.Stream.isTwelveTone`
   - :meth:`~music21.stream.Stream.isWellFormedNotation`
   - :meth:`~music21.stream.Stream.lyrics`
   - :meth:`~music21.stream.Stream.makeAccidentals`
   - :meth:`~music21.stream.Stream.makeBeams`
   - :meth:`~music21.stream.Stream.makeChords`
   - :meth:`~music21.stream.Stream.makeImmutable`
   - :meth:`~music21.stream.Stream.makeMeasures`
   - :meth:`~music21.stream.Stream.makeMutable`
   - :meth:`~music21.stream.Stream.makeNotation`
   - :meth:`~music21.stream.Stream.makeRests`
   - :meth:`~music21.stream.Stream.makeTies`
   - :meth:`~music21.stream.Stream.makeTupletBrackets`
   - :meth:`~music21.stream.Stream.makeVariantBlocks`
   - :meth:`~music21.stream.Stream.makeVoices`
   - :meth:`~music21.stream.Stream.measure`
   - :meth:`~music21.stream.Stream.measureOffsetMap`
   - :meth:`~music21.stream.Stream.measureTemplate`
   - :meth:`~music21.stream.Stream.measures`
   - :meth:`~music21.stream.Stream.melodicIntervals`
   - :meth:`~music21.stream.Stream.mergeElements`
   - :meth:`~music21.stream.Stream.metronomeMarkBoundaries`
   - :meth:`~music21.stream.Stream.pitchAttributeCount`
   - :meth:`~music21.stream.Stream.playingWhenAttacked`
   - :meth:`~music21.stream.Stream.plot`
   - :meth:`~music21.stream.Stream.pop`
   - :meth:`~music21.stream.Stream.quantize`
   - :meth:`~music21.stream.Stream.realizeOrnaments`
   - :meth:`~music21.stream.Stream.recurse`
   - :meth:`~music21.stream.Stream.remove`
   - :meth:`~music21.stream.Stream.removeByClass`
   - :meth:`~music21.stream.Stream.removeByNotOfClass`
   - :meth:`~music21.stream.Stream.repeatAppend`
   - :meth:`~music21.stream.Stream.repeatInsert`
   - :meth:`~music21.stream.Stream.replace`
   - :meth:`~music21.stream.Stream.restoreActiveSites`
   - :meth:`~music21.stream.Stream.scaleDurations`
   - :meth:`~music21.stream.Stream.scaleOffsets`
   - :meth:`~music21.stream.Stream.shiftElements`
   - :meth:`~music21.stream.Stream.showVariantAsOssialikePart`
   - :meth:`~music21.stream.Stream.simultaneousAttacks`
   - :meth:`~music21.stream.Stream.sliceAtOffsets`
   - :meth:`~music21.stream.Stream.sliceByBeat`
   - :meth:`~music21.stream.Stream.sliceByGreatestDivisor`
   - :meth:`~music21.stream.Stream.sliceByQuarterLengths`
   - :meth:`~music21.stream.Stream.sort`
   - :meth:`~music21.stream.Stream.splitAtQuarterLength`
   - :meth:`~music21.stream.Stream.splitByClass`
   - :meth:`~music21.stream.Stream.storeAtEnd`
   - :meth:`~music21.stream.Stream.stripTies`
   - :meth:`~music21.stream.Stream.toSoundingPitch`
   - :meth:`~music21.stream.Stream.toWrittenPitch`
   - :meth:`~music21.stream.Stream.transferOffsetToElements`
   - :meth:`~music21.stream.Stream.transpose`
   - :meth:`~music21.stream.Stream.trimPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.unwrapWeakref`
   - :meth:`~music21.stream.Stream.voicesToParts`
   - :meth:`~music21.stream.Stream.wrapWeakref`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`

.. rubric:: :class:`~music21.layout.LayoutScore` instance variables

.. attribute:: LayoutScore.autoSort

	
	Boolean describing whether the Stream is automatically sorted by
	offset whenever necessary.
	

.. attribute:: LayoutScore.definesExplicitPageBreaks

	
	Boolean that says whether all page breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-page"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: LayoutScore.definesExplicitSystemBreaks

	
	Boolean that says whether all system breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-system"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: LayoutScore.flattenedRepresentationOf

	
	When this flat Stream is derived from another non-flat stream, a
	reference to the source Stream is stored here.
	

.. attribute:: LayoutScore.isFlat

	
	Boolean describing whether this Stream contains embedded
	sub-Streams or Stream subclasses (not flat).
	

.. attribute:: LayoutScore.isSorted

	
	Boolean describing whether the Stream is sorted or not.
	

Instance variables inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Opus.flattenedRepresentationOf`
   - :attr:`~music21.stream.Opus.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Opus.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Opus.isFlat`
   - :attr:`~music21.stream.Opus.autoSort`
   - :attr:`~music21.stream.Opus.isSorted`

Instance variables inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.flattenedRepresentationOf`
   - :attr:`~music21.stream.Stream.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Stream.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Stream.isFlat`
   - :attr:`~music21.stream.Stream.autoSort`
   - :attr:`~music21.stream.Stream.isSorted`

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

.. hlist::
   :columns: 3

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

Page
----

.. autoclass:: music21.layout.Page

.. rubric:: :class:`~music21.layout.Page` bases

- :class:`~music21.stream.Opus`
- :class:`~music21.stream.Stream`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.layout.Page` read-only properties

.. autoattribute:: music21.layout.Page.systems

Read-only properties inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Opus.scores`

Read-only properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.beat`
   - :attr:`~music21.stream.Stream.beatDuration`
   - :attr:`~music21.stream.Stream.beatStr`
   - :attr:`~music21.stream.Stream.beatStrength`
   - :attr:`~music21.stream.Stream.derivationChain`
   - :attr:`~music21.stream.Stream.flat`
   - :attr:`~music21.stream.Stream.highestOffset`
   - :attr:`~music21.stream.Stream.highestTime`
   - :attr:`~music21.stream.Stream.isGapless`
   - :attr:`~music21.stream.Stream.lowestOffset`
   - :attr:`~music21.stream.Stream.notes`
   - :attr:`~music21.stream.Stream.notesAndRests`
   - :attr:`~music21.stream.Stream.offsetMap`
   - :attr:`~music21.stream.Stream.pitches`
   - :attr:`~music21.stream.Stream.rootDerivation`
   - :attr:`~music21.stream.Stream.secondsMap`
   - :attr:`~music21.stream.Stream.semiFlat`
   - :attr:`~music21.stream.Stream.sorted`
   - :attr:`~music21.stream.Stream.spannerBundle`
   - :attr:`~music21.stream.Stream.spanners`
   - :attr:`~music21.stream.Stream.variants`
   - :attr:`~music21.stream.Stream.voices`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.Page` read/write properties

Read/write properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.atSoundingPitch`
   - :attr:`~music21.stream.Stream.derivationMethod`
   - :attr:`~music21.stream.Stream.derivesFrom`
   - :attr:`~music21.stream.Stream.duration`
   - :attr:`~music21.stream.Stream.elements`
   - :attr:`~music21.stream.Stream.finalBarline`
   - :attr:`~music21.stream.Stream.metadata`
   - :attr:`~music21.stream.Stream.seconds`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`

.. rubric:: :class:`~music21.layout.Page` methods

Methods inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Opus.getNumbers`
   - :meth:`~music21.stream.Opus.getScoreByNumber`
   - :meth:`~music21.stream.Opus.getScoreByTitle`
   - :meth:`~music21.stream.Opus.mergeScores`
   - :meth:`~music21.stream.Opus.show`
   - :meth:`~music21.stream.Opus.write`

Methods inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Stream.activateVariants`
   - :meth:`~music21.stream.Stream.addGroupForElements`
   - :meth:`~music21.stream.Stream.allPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.analyze`
   - :meth:`~music21.stream.Stream.append`
   - :meth:`~music21.stream.Stream.attachIntervalsBetweenStreams`
   - :meth:`~music21.stream.Stream.attachMelodicIntervals`
   - :meth:`~music21.stream.Stream.attributeCount`
   - :meth:`~music21.stream.Stream.augmentOrDiminish`
   - :meth:`~music21.stream.Stream.beatAndMeasureFromOffset`
   - :meth:`~music21.stream.Stream.bestClef`
   - :meth:`~music21.stream.Stream.chordify`
   - :meth:`~music21.stream.Stream.expandRepeats`
   - :meth:`~music21.stream.Stream.explode`
   - :meth:`~music21.stream.Stream.extendDuration`
   - :meth:`~music21.stream.Stream.extendDurationAndGetBoundaries`
   - :meth:`~music21.stream.Stream.extendTies`
   - :meth:`~music21.stream.Stream.extractContext`
   - :meth:`~music21.stream.Stream.findConsecutiveNotes`
   - :meth:`~music21.stream.Stream.findGaps`
   - :meth:`~music21.stream.Stream.flattenUnnecessaryVoices`
   - :meth:`~music21.stream.Stream.getClefs`
   - :meth:`~music21.stream.Stream.getElementAfterElement`
   - :meth:`~music21.stream.Stream.getElementAtOrBefore`
   - :meth:`~music21.stream.Stream.getElementBeforeOffset`
   - :meth:`~music21.stream.Stream.getElementById`
   - :meth:`~music21.stream.Stream.getElementsByClass`
   - :meth:`~music21.stream.Stream.getElementsByGroup`
   - :meth:`~music21.stream.Stream.getElementsByOffset`
   - :meth:`~music21.stream.Stream.getElementsNotOfClass`
   - :meth:`~music21.stream.Stream.getInstrument`
   - :meth:`~music21.stream.Stream.getInstruments`
   - :meth:`~music21.stream.Stream.getKeySignatures`
   - :meth:`~music21.stream.Stream.getOffsetByElement`
   - :meth:`~music21.stream.Stream.getOverlaps`
   - :meth:`~music21.stream.Stream.getSimultaneous`
   - :meth:`~music21.stream.Stream.getTimeSignatures`
   - :meth:`~music21.stream.Stream.groupElementsByOffset`
   - :meth:`~music21.stream.Stream.hasElement`
   - :meth:`~music21.stream.Stream.hasElementOfClass`
   - :meth:`~music21.stream.Stream.hasMeasures`
   - :meth:`~music21.stream.Stream.hasPartLikeStreams`
   - :meth:`~music21.stream.Stream.hasVoices`
   - :meth:`~music21.stream.Stream.haveAccidentalsBeenMade`
   - :meth:`~music21.stream.Stream.haveBeamsBeenMade`
   - :meth:`~music21.stream.Stream.index`
   - :meth:`~music21.stream.Stream.insert`
   - :meth:`~music21.stream.Stream.insertAndShift`
   - :meth:`~music21.stream.Stream.insertIntoNoteOrChord`
   - :meth:`~music21.stream.Stream.internalize`
   - :meth:`~music21.stream.Stream.invertDiatonic`
   - :meth:`~music21.stream.Stream.isSequence`
   - :meth:`~music21.stream.Stream.isTwelveTone`
   - :meth:`~music21.stream.Stream.isWellFormedNotation`
   - :meth:`~music21.stream.Stream.lyrics`
   - :meth:`~music21.stream.Stream.makeAccidentals`
   - :meth:`~music21.stream.Stream.makeBeams`
   - :meth:`~music21.stream.Stream.makeChords`
   - :meth:`~music21.stream.Stream.makeImmutable`
   - :meth:`~music21.stream.Stream.makeMeasures`
   - :meth:`~music21.stream.Stream.makeMutable`
   - :meth:`~music21.stream.Stream.makeNotation`
   - :meth:`~music21.stream.Stream.makeRests`
   - :meth:`~music21.stream.Stream.makeTies`
   - :meth:`~music21.stream.Stream.makeTupletBrackets`
   - :meth:`~music21.stream.Stream.makeVariantBlocks`
   - :meth:`~music21.stream.Stream.makeVoices`
   - :meth:`~music21.stream.Stream.measure`
   - :meth:`~music21.stream.Stream.measureOffsetMap`
   - :meth:`~music21.stream.Stream.measureTemplate`
   - :meth:`~music21.stream.Stream.measures`
   - :meth:`~music21.stream.Stream.melodicIntervals`
   - :meth:`~music21.stream.Stream.mergeElements`
   - :meth:`~music21.stream.Stream.metronomeMarkBoundaries`
   - :meth:`~music21.stream.Stream.pitchAttributeCount`
   - :meth:`~music21.stream.Stream.playingWhenAttacked`
   - :meth:`~music21.stream.Stream.plot`
   - :meth:`~music21.stream.Stream.pop`
   - :meth:`~music21.stream.Stream.quantize`
   - :meth:`~music21.stream.Stream.realizeOrnaments`
   - :meth:`~music21.stream.Stream.recurse`
   - :meth:`~music21.stream.Stream.remove`
   - :meth:`~music21.stream.Stream.removeByClass`
   - :meth:`~music21.stream.Stream.removeByNotOfClass`
   - :meth:`~music21.stream.Stream.repeatAppend`
   - :meth:`~music21.stream.Stream.repeatInsert`
   - :meth:`~music21.stream.Stream.replace`
   - :meth:`~music21.stream.Stream.restoreActiveSites`
   - :meth:`~music21.stream.Stream.scaleDurations`
   - :meth:`~music21.stream.Stream.scaleOffsets`
   - :meth:`~music21.stream.Stream.shiftElements`
   - :meth:`~music21.stream.Stream.showVariantAsOssialikePart`
   - :meth:`~music21.stream.Stream.simultaneousAttacks`
   - :meth:`~music21.stream.Stream.sliceAtOffsets`
   - :meth:`~music21.stream.Stream.sliceByBeat`
   - :meth:`~music21.stream.Stream.sliceByGreatestDivisor`
   - :meth:`~music21.stream.Stream.sliceByQuarterLengths`
   - :meth:`~music21.stream.Stream.sort`
   - :meth:`~music21.stream.Stream.splitAtQuarterLength`
   - :meth:`~music21.stream.Stream.splitByClass`
   - :meth:`~music21.stream.Stream.storeAtEnd`
   - :meth:`~music21.stream.Stream.stripTies`
   - :meth:`~music21.stream.Stream.toSoundingPitch`
   - :meth:`~music21.stream.Stream.toWrittenPitch`
   - :meth:`~music21.stream.Stream.transferOffsetToElements`
   - :meth:`~music21.stream.Stream.transpose`
   - :meth:`~music21.stream.Stream.trimPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.unwrapWeakref`
   - :meth:`~music21.stream.Stream.voicesToParts`
   - :meth:`~music21.stream.Stream.wrapWeakref`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`

.. rubric:: :class:`~music21.layout.Page` instance variables

.. attribute:: Page.autoSort

	
	Boolean describing whether the Stream is automatically sorted by
	offset whenever necessary.
	

.. attribute:: Page.definesExplicitPageBreaks

	
	Boolean that says whether all page breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-page"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: Page.definesExplicitSystemBreaks

	
	Boolean that says whether all system breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-system"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: Page.flattenedRepresentationOf

	
	When this flat Stream is derived from another non-flat stream, a
	reference to the source Stream is stored here.
	

.. attribute:: Page.isFlat

	
	Boolean describing whether this Stream contains embedded
	sub-Streams or Stream subclasses (not flat).
	

.. attribute:: Page.isSorted

	
	Boolean describing whether the Stream is sorted or not.
	

Instance variables inherited from :class:`~music21.stream.Opus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Opus.flattenedRepresentationOf`
   - :attr:`~music21.stream.Opus.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Opus.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Opus.isFlat`
   - :attr:`~music21.stream.Opus.autoSort`
   - :attr:`~music21.stream.Opus.isSorted`

Instance variables inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.flattenedRepresentationOf`
   - :attr:`~music21.stream.Stream.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Stream.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Stream.isFlat`
   - :attr:`~music21.stream.Stream.autoSort`
   - :attr:`~music21.stream.Stream.isSorted`

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

.. hlist::
   :columns: 3

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

System
------

.. autoclass:: music21.layout.System

.. rubric:: :class:`~music21.layout.System` bases

- :class:`~music21.stream.Score`
- :class:`~music21.stream.Stream`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.layout.System` read-only properties

.. autoattribute:: music21.layout.System.staves

Read-only properties inherited from :class:`~music21.stream.Score`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Score.parts`

Read-only properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.beat`
   - :attr:`~music21.stream.Stream.beatDuration`
   - :attr:`~music21.stream.Stream.beatStr`
   - :attr:`~music21.stream.Stream.beatStrength`
   - :attr:`~music21.stream.Stream.derivationChain`
   - :attr:`~music21.stream.Stream.flat`
   - :attr:`~music21.stream.Stream.highestOffset`
   - :attr:`~music21.stream.Stream.highestTime`
   - :attr:`~music21.stream.Stream.isGapless`
   - :attr:`~music21.stream.Stream.lowestOffset`
   - :attr:`~music21.stream.Stream.notes`
   - :attr:`~music21.stream.Stream.notesAndRests`
   - :attr:`~music21.stream.Stream.offsetMap`
   - :attr:`~music21.stream.Stream.pitches`
   - :attr:`~music21.stream.Stream.rootDerivation`
   - :attr:`~music21.stream.Stream.secondsMap`
   - :attr:`~music21.stream.Stream.semiFlat`
   - :attr:`~music21.stream.Stream.sorted`
   - :attr:`~music21.stream.Stream.spannerBundle`
   - :attr:`~music21.stream.Stream.spanners`
   - :attr:`~music21.stream.Stream.variants`
   - :attr:`~music21.stream.Stream.voices`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.System` read/write properties

Read/write properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.atSoundingPitch`
   - :attr:`~music21.stream.Stream.derivationMethod`
   - :attr:`~music21.stream.Stream.derivesFrom`
   - :attr:`~music21.stream.Stream.duration`
   - :attr:`~music21.stream.Stream.elements`
   - :attr:`~music21.stream.Stream.finalBarline`
   - :attr:`~music21.stream.Stream.metadata`
   - :attr:`~music21.stream.Stream.seconds`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`

.. rubric:: :class:`~music21.layout.System` methods

Methods inherited from :class:`~music21.stream.Score`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Score.expandRepeats`
   - :meth:`~music21.stream.Score.flattenParts`
   - :meth:`~music21.stream.Score.implode`
   - :meth:`~music21.stream.Score.makeNotation`
   - :meth:`~music21.stream.Score.measure`
   - :meth:`~music21.stream.Score.measureOffsetMap`
   - :meth:`~music21.stream.Score.measures`
   - :meth:`~music21.stream.Score.partsToVoices`
   - :meth:`~music21.stream.Score.sliceByGreatestDivisor`

Methods inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Stream.activateVariants`
   - :meth:`~music21.stream.Stream.addGroupForElements`
   - :meth:`~music21.stream.Stream.allPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.analyze`
   - :meth:`~music21.stream.Stream.append`
   - :meth:`~music21.stream.Stream.attachIntervalsBetweenStreams`
   - :meth:`~music21.stream.Stream.attachMelodicIntervals`
   - :meth:`~music21.stream.Stream.attributeCount`
   - :meth:`~music21.stream.Stream.augmentOrDiminish`
   - :meth:`~music21.stream.Stream.beatAndMeasureFromOffset`
   - :meth:`~music21.stream.Stream.bestClef`
   - :meth:`~music21.stream.Stream.chordify`
   - :meth:`~music21.stream.Stream.explode`
   - :meth:`~music21.stream.Stream.extendDuration`
   - :meth:`~music21.stream.Stream.extendDurationAndGetBoundaries`
   - :meth:`~music21.stream.Stream.extendTies`
   - :meth:`~music21.stream.Stream.extractContext`
   - :meth:`~music21.stream.Stream.findConsecutiveNotes`
   - :meth:`~music21.stream.Stream.findGaps`
   - :meth:`~music21.stream.Stream.flattenUnnecessaryVoices`
   - :meth:`~music21.stream.Stream.getClefs`
   - :meth:`~music21.stream.Stream.getElementAfterElement`
   - :meth:`~music21.stream.Stream.getElementAtOrBefore`
   - :meth:`~music21.stream.Stream.getElementBeforeOffset`
   - :meth:`~music21.stream.Stream.getElementById`
   - :meth:`~music21.stream.Stream.getElementsByClass`
   - :meth:`~music21.stream.Stream.getElementsByGroup`
   - :meth:`~music21.stream.Stream.getElementsByOffset`
   - :meth:`~music21.stream.Stream.getElementsNotOfClass`
   - :meth:`~music21.stream.Stream.getInstrument`
   - :meth:`~music21.stream.Stream.getInstruments`
   - :meth:`~music21.stream.Stream.getKeySignatures`
   - :meth:`~music21.stream.Stream.getOffsetByElement`
   - :meth:`~music21.stream.Stream.getOverlaps`
   - :meth:`~music21.stream.Stream.getSimultaneous`
   - :meth:`~music21.stream.Stream.getTimeSignatures`
   - :meth:`~music21.stream.Stream.groupElementsByOffset`
   - :meth:`~music21.stream.Stream.hasElement`
   - :meth:`~music21.stream.Stream.hasElementOfClass`
   - :meth:`~music21.stream.Stream.hasMeasures`
   - :meth:`~music21.stream.Stream.hasPartLikeStreams`
   - :meth:`~music21.stream.Stream.hasVoices`
   - :meth:`~music21.stream.Stream.haveAccidentalsBeenMade`
   - :meth:`~music21.stream.Stream.haveBeamsBeenMade`
   - :meth:`~music21.stream.Stream.index`
   - :meth:`~music21.stream.Stream.insert`
   - :meth:`~music21.stream.Stream.insertAndShift`
   - :meth:`~music21.stream.Stream.insertIntoNoteOrChord`
   - :meth:`~music21.stream.Stream.internalize`
   - :meth:`~music21.stream.Stream.invertDiatonic`
   - :meth:`~music21.stream.Stream.isSequence`
   - :meth:`~music21.stream.Stream.isTwelveTone`
   - :meth:`~music21.stream.Stream.isWellFormedNotation`
   - :meth:`~music21.stream.Stream.lyrics`
   - :meth:`~music21.stream.Stream.makeAccidentals`
   - :meth:`~music21.stream.Stream.makeBeams`
   - :meth:`~music21.stream.Stream.makeChords`
   - :meth:`~music21.stream.Stream.makeImmutable`
   - :meth:`~music21.stream.Stream.makeMeasures`
   - :meth:`~music21.stream.Stream.makeMutable`
   - :meth:`~music21.stream.Stream.makeRests`
   - :meth:`~music21.stream.Stream.makeTies`
   - :meth:`~music21.stream.Stream.makeTupletBrackets`
   - :meth:`~music21.stream.Stream.makeVariantBlocks`
   - :meth:`~music21.stream.Stream.makeVoices`
   - :meth:`~music21.stream.Stream.measureTemplate`
   - :meth:`~music21.stream.Stream.melodicIntervals`
   - :meth:`~music21.stream.Stream.mergeElements`
   - :meth:`~music21.stream.Stream.metronomeMarkBoundaries`
   - :meth:`~music21.stream.Stream.pitchAttributeCount`
   - :meth:`~music21.stream.Stream.playingWhenAttacked`
   - :meth:`~music21.stream.Stream.plot`
   - :meth:`~music21.stream.Stream.pop`
   - :meth:`~music21.stream.Stream.quantize`
   - :meth:`~music21.stream.Stream.realizeOrnaments`
   - :meth:`~music21.stream.Stream.recurse`
   - :meth:`~music21.stream.Stream.remove`
   - :meth:`~music21.stream.Stream.removeByClass`
   - :meth:`~music21.stream.Stream.removeByNotOfClass`
   - :meth:`~music21.stream.Stream.repeatAppend`
   - :meth:`~music21.stream.Stream.repeatInsert`
   - :meth:`~music21.stream.Stream.replace`
   - :meth:`~music21.stream.Stream.restoreActiveSites`
   - :meth:`~music21.stream.Stream.scaleDurations`
   - :meth:`~music21.stream.Stream.scaleOffsets`
   - :meth:`~music21.stream.Stream.shiftElements`
   - :meth:`~music21.stream.Stream.showVariantAsOssialikePart`
   - :meth:`~music21.stream.Stream.simultaneousAttacks`
   - :meth:`~music21.stream.Stream.sliceAtOffsets`
   - :meth:`~music21.stream.Stream.sliceByBeat`
   - :meth:`~music21.stream.Stream.sliceByQuarterLengths`
   - :meth:`~music21.stream.Stream.sort`
   - :meth:`~music21.stream.Stream.splitAtQuarterLength`
   - :meth:`~music21.stream.Stream.splitByClass`
   - :meth:`~music21.stream.Stream.storeAtEnd`
   - :meth:`~music21.stream.Stream.stripTies`
   - :meth:`~music21.stream.Stream.toSoundingPitch`
   - :meth:`~music21.stream.Stream.toWrittenPitch`
   - :meth:`~music21.stream.Stream.transferOffsetToElements`
   - :meth:`~music21.stream.Stream.transpose`
   - :meth:`~music21.stream.Stream.trimPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.unwrapWeakref`
   - :meth:`~music21.stream.Stream.voicesToParts`
   - :meth:`~music21.stream.Stream.wrapWeakref`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.System` instance variables

.. attribute:: System.autoSort

	
	Boolean describing whether the Stream is automatically sorted by
	offset whenever necessary.
	

.. attribute:: System.definesExplicitPageBreaks

	
	Boolean that says whether all page breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-page"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: System.definesExplicitSystemBreaks

	
	Boolean that says whether all system breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-system"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: System.flattenedRepresentationOf

	
	When this flat Stream is derived from another non-flat stream, a
	reference to the source Stream is stored here.
	

.. attribute:: System.isFlat

	
	Boolean describing whether this Stream contains embedded
	sub-Streams or Stream subclasses (not flat).
	

.. attribute:: System.isSorted

	
	Boolean describing whether the Stream is sorted or not.
	

Instance variables inherited from :class:`~music21.stream.Score`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Score.flattenedRepresentationOf`
   - :attr:`~music21.stream.Score.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Score.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Score.isFlat`
   - :attr:`~music21.stream.Score.autoSort`
   - :attr:`~music21.stream.Score.isSorted`

Instance variables inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.flattenedRepresentationOf`
   - :attr:`~music21.stream.Stream.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Stream.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Stream.isFlat`
   - :attr:`~music21.stream.Stream.autoSort`
   - :attr:`~music21.stream.Stream.isSorted`

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

.. hlist::
   :columns: 3

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

Staff
-----

.. autoclass:: music21.layout.Staff

.. rubric:: :class:`~music21.layout.Staff` bases

- :class:`~music21.stream.Part`
- :class:`~music21.stream.Stream`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.layout.Staff` read-only properties

Read-only properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.beat`
   - :attr:`~music21.stream.Stream.beatDuration`
   - :attr:`~music21.stream.Stream.beatStr`
   - :attr:`~music21.stream.Stream.beatStrength`
   - :attr:`~music21.stream.Stream.derivationChain`
   - :attr:`~music21.stream.Stream.flat`
   - :attr:`~music21.stream.Stream.highestOffset`
   - :attr:`~music21.stream.Stream.highestTime`
   - :attr:`~music21.stream.Stream.isGapless`
   - :attr:`~music21.stream.Stream.lowestOffset`
   - :attr:`~music21.stream.Stream.notes`
   - :attr:`~music21.stream.Stream.notesAndRests`
   - :attr:`~music21.stream.Stream.offsetMap`
   - :attr:`~music21.stream.Stream.pitches`
   - :attr:`~music21.stream.Stream.rootDerivation`
   - :attr:`~music21.stream.Stream.secondsMap`
   - :attr:`~music21.stream.Stream.semiFlat`
   - :attr:`~music21.stream.Stream.sorted`
   - :attr:`~music21.stream.Stream.spannerBundle`
   - :attr:`~music21.stream.Stream.spanners`
   - :attr:`~music21.stream.Stream.variants`
   - :attr:`~music21.stream.Stream.voices`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.Staff` read/write properties

Read/write properties inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.atSoundingPitch`
   - :attr:`~music21.stream.Stream.derivationMethod`
   - :attr:`~music21.stream.Stream.derivesFrom`
   - :attr:`~music21.stream.Stream.duration`
   - :attr:`~music21.stream.Stream.elements`
   - :attr:`~music21.stream.Stream.finalBarline`
   - :attr:`~music21.stream.Stream.metadata`
   - :attr:`~music21.stream.Stream.seconds`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`

.. rubric:: :class:`~music21.layout.Staff` methods

Methods inherited from :class:`~music21.stream.Part`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Part.makeAccidentals`

Methods inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.Stream.activateVariants`
   - :meth:`~music21.stream.Stream.addGroupForElements`
   - :meth:`~music21.stream.Stream.allPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.analyze`
   - :meth:`~music21.stream.Stream.append`
   - :meth:`~music21.stream.Stream.attachIntervalsBetweenStreams`
   - :meth:`~music21.stream.Stream.attachMelodicIntervals`
   - :meth:`~music21.stream.Stream.attributeCount`
   - :meth:`~music21.stream.Stream.augmentOrDiminish`
   - :meth:`~music21.stream.Stream.beatAndMeasureFromOffset`
   - :meth:`~music21.stream.Stream.bestClef`
   - :meth:`~music21.stream.Stream.chordify`
   - :meth:`~music21.stream.Stream.expandRepeats`
   - :meth:`~music21.stream.Stream.explode`
   - :meth:`~music21.stream.Stream.extendDuration`
   - :meth:`~music21.stream.Stream.extendDurationAndGetBoundaries`
   - :meth:`~music21.stream.Stream.extendTies`
   - :meth:`~music21.stream.Stream.extractContext`
   - :meth:`~music21.stream.Stream.findConsecutiveNotes`
   - :meth:`~music21.stream.Stream.findGaps`
   - :meth:`~music21.stream.Stream.flattenUnnecessaryVoices`
   - :meth:`~music21.stream.Stream.getClefs`
   - :meth:`~music21.stream.Stream.getElementAfterElement`
   - :meth:`~music21.stream.Stream.getElementAtOrBefore`
   - :meth:`~music21.stream.Stream.getElementBeforeOffset`
   - :meth:`~music21.stream.Stream.getElementById`
   - :meth:`~music21.stream.Stream.getElementsByClass`
   - :meth:`~music21.stream.Stream.getElementsByGroup`
   - :meth:`~music21.stream.Stream.getElementsByOffset`
   - :meth:`~music21.stream.Stream.getElementsNotOfClass`
   - :meth:`~music21.stream.Stream.getInstrument`
   - :meth:`~music21.stream.Stream.getInstruments`
   - :meth:`~music21.stream.Stream.getKeySignatures`
   - :meth:`~music21.stream.Stream.getOffsetByElement`
   - :meth:`~music21.stream.Stream.getOverlaps`
   - :meth:`~music21.stream.Stream.getSimultaneous`
   - :meth:`~music21.stream.Stream.getTimeSignatures`
   - :meth:`~music21.stream.Stream.groupElementsByOffset`
   - :meth:`~music21.stream.Stream.hasElement`
   - :meth:`~music21.stream.Stream.hasElementOfClass`
   - :meth:`~music21.stream.Stream.hasMeasures`
   - :meth:`~music21.stream.Stream.hasPartLikeStreams`
   - :meth:`~music21.stream.Stream.hasVoices`
   - :meth:`~music21.stream.Stream.haveAccidentalsBeenMade`
   - :meth:`~music21.stream.Stream.haveBeamsBeenMade`
   - :meth:`~music21.stream.Stream.index`
   - :meth:`~music21.stream.Stream.insert`
   - :meth:`~music21.stream.Stream.insertAndShift`
   - :meth:`~music21.stream.Stream.insertIntoNoteOrChord`
   - :meth:`~music21.stream.Stream.internalize`
   - :meth:`~music21.stream.Stream.invertDiatonic`
   - :meth:`~music21.stream.Stream.isSequence`
   - :meth:`~music21.stream.Stream.isTwelveTone`
   - :meth:`~music21.stream.Stream.isWellFormedNotation`
   - :meth:`~music21.stream.Stream.lyrics`
   - :meth:`~music21.stream.Stream.makeBeams`
   - :meth:`~music21.stream.Stream.makeChords`
   - :meth:`~music21.stream.Stream.makeImmutable`
   - :meth:`~music21.stream.Stream.makeMeasures`
   - :meth:`~music21.stream.Stream.makeMutable`
   - :meth:`~music21.stream.Stream.makeNotation`
   - :meth:`~music21.stream.Stream.makeRests`
   - :meth:`~music21.stream.Stream.makeTies`
   - :meth:`~music21.stream.Stream.makeTupletBrackets`
   - :meth:`~music21.stream.Stream.makeVariantBlocks`
   - :meth:`~music21.stream.Stream.makeVoices`
   - :meth:`~music21.stream.Stream.measure`
   - :meth:`~music21.stream.Stream.measureOffsetMap`
   - :meth:`~music21.stream.Stream.measureTemplate`
   - :meth:`~music21.stream.Stream.measures`
   - :meth:`~music21.stream.Stream.melodicIntervals`
   - :meth:`~music21.stream.Stream.mergeElements`
   - :meth:`~music21.stream.Stream.metronomeMarkBoundaries`
   - :meth:`~music21.stream.Stream.pitchAttributeCount`
   - :meth:`~music21.stream.Stream.playingWhenAttacked`
   - :meth:`~music21.stream.Stream.plot`
   - :meth:`~music21.stream.Stream.pop`
   - :meth:`~music21.stream.Stream.quantize`
   - :meth:`~music21.stream.Stream.realizeOrnaments`
   - :meth:`~music21.stream.Stream.recurse`
   - :meth:`~music21.stream.Stream.remove`
   - :meth:`~music21.stream.Stream.removeByClass`
   - :meth:`~music21.stream.Stream.removeByNotOfClass`
   - :meth:`~music21.stream.Stream.repeatAppend`
   - :meth:`~music21.stream.Stream.repeatInsert`
   - :meth:`~music21.stream.Stream.replace`
   - :meth:`~music21.stream.Stream.restoreActiveSites`
   - :meth:`~music21.stream.Stream.scaleDurations`
   - :meth:`~music21.stream.Stream.scaleOffsets`
   - :meth:`~music21.stream.Stream.shiftElements`
   - :meth:`~music21.stream.Stream.showVariantAsOssialikePart`
   - :meth:`~music21.stream.Stream.simultaneousAttacks`
   - :meth:`~music21.stream.Stream.sliceAtOffsets`
   - :meth:`~music21.stream.Stream.sliceByBeat`
   - :meth:`~music21.stream.Stream.sliceByGreatestDivisor`
   - :meth:`~music21.stream.Stream.sliceByQuarterLengths`
   - :meth:`~music21.stream.Stream.sort`
   - :meth:`~music21.stream.Stream.splitAtQuarterLength`
   - :meth:`~music21.stream.Stream.splitByClass`
   - :meth:`~music21.stream.Stream.storeAtEnd`
   - :meth:`~music21.stream.Stream.stripTies`
   - :meth:`~music21.stream.Stream.toSoundingPitch`
   - :meth:`~music21.stream.Stream.toWrittenPitch`
   - :meth:`~music21.stream.Stream.transferOffsetToElements`
   - :meth:`~music21.stream.Stream.transpose`
   - :meth:`~music21.stream.Stream.trimPlayingWhileSounding`
   - :meth:`~music21.stream.Stream.unwrapWeakref`
   - :meth:`~music21.stream.Stream.voicesToParts`
   - :meth:`~music21.stream.Stream.wrapWeakref`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.Staff` instance variables

.. attribute:: Staff.autoSort

	
	Boolean describing whether the Stream is automatically sorted by
	offset whenever necessary.
	

.. attribute:: Staff.definesExplicitPageBreaks

	
	Boolean that says whether all page breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-page"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: Staff.definesExplicitSystemBreaks

	
	Boolean that says whether all system breaks in the piece are
	explicitly defined.  Only used on musicxml output (maps to the
	musicxml <supports attribute="new-system"> tag) and only if this is
	the outermost Stream being shown
	

.. attribute:: Staff.flattenedRepresentationOf

	
	When this flat Stream is derived from another non-flat stream, a
	reference to the source Stream is stored here.
	

.. attribute:: Staff.isFlat

	
	Boolean describing whether this Stream contains embedded
	sub-Streams or Stream subclasses (not flat).
	

.. attribute:: Staff.isSorted

	
	Boolean describing whether the Stream is sorted or not.
	

Instance variables inherited from :class:`~music21.stream.Part`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Part.flattenedRepresentationOf`
   - :attr:`~music21.stream.Part.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Part.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Part.isFlat`
   - :attr:`~music21.stream.Part.autoSort`
   - :attr:`~music21.stream.Part.isSorted`

Instance variables inherited from :class:`~music21.stream.Stream`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.Stream.flattenedRepresentationOf`
   - :attr:`~music21.stream.Stream.definesExplicitPageBreaks`
   - :attr:`~music21.stream.Stream.definesExplicitSystemBreaks`
   - :attr:`~music21.stream.Stream.isFlat`
   - :attr:`~music21.stream.Stream.autoSort`
   - :attr:`~music21.stream.Stream.isSorted`

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

.. hlist::
   :columns: 3

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

StaffGroup
----------

.. autoclass:: music21.layout.StaffGroup

.. rubric:: :class:`~music21.layout.StaffGroup` bases

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

.. rubric:: :class:`~music21.layout.StaffGroup` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.layout.StaffGroup` read/write properties

.. autoattribute:: music21.layout.StaffGroup.barTogether

.. autoattribute:: music21.layout.StaffGroup.symbol

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

.. hlist::
   :columns: 3

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

.. rubric:: :class:`~music21.layout.StaffGroup` methods

Methods inherited from :class:`~music21.spanner.Spanner`:

.. hlist::
   :columns: 3

   - :meth:`~music21.spanner.Spanner.addSpannedElements`
   - :meth:`~music21.spanner.Spanner.getDurationBySite`
   - :meth:`~music21.spanner.Spanner.getDurationSpanBySite`
   - :meth:`~music21.spanner.Spanner.getFirst`
   - :meth:`~music21.spanner.Spanner.getLast`
   - :meth:`~music21.spanner.Spanner.getOffsetSpanBySite`
   - :meth:`~music21.spanner.Spanner.getOffsetsBySite`
   - :meth:`~music21.spanner.Spanner.getSpannedElementIds`
   - :meth:`~music21.spanner.Spanner.getSpannedElements`
   - :meth:`~music21.spanner.Spanner.getSpannedElementsByClass`
   - :meth:`~music21.spanner.Spanner.getSpannerStorageId`
   - :meth:`~music21.spanner.Spanner.hasSpannedElement`
   - :meth:`~music21.spanner.Spanner.isFirst`
   - :meth:`~music21.spanner.Spanner.isLast`
   - :meth:`~music21.spanner.Spanner.purgeLocations`
   - :meth:`~music21.spanner.Spanner.purgeOrphans`
   - :meth:`~music21.spanner.Spanner.replaceSpannedElement`
   - :meth:`~music21.spanner.Spanner.unwrapWeakref`
   - :meth:`~music21.spanner.Spanner.wrapWeakref`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.layout.StaffGroup` instance variables

.. attribute:: StaffGroup.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: StaffGroup.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: StaffGroup.hideObjectOnPrint

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

.. attribute:: StaffGroup.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: StaffGroup.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: StaffGroup.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: StaffGroup.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: StaffGroup.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.spanner.Spanner`:

.. hlist::
   :columns: 3

   - :attr:`~music21.spanner.Spanner.isStream`
   - :attr:`~music21.spanner.Spanner.hideObjectOnPrint`
   - :attr:`~music21.spanner.Spanner.classSortOrder`
   - :attr:`~music21.spanner.Spanner.groups`
   - :attr:`~music21.spanner.Spanner.isVariant`
   - :attr:`~music21.spanner.Spanner.id`
   - :attr:`~music21.spanner.Spanner.isSpanner`
   - :attr:`~music21.spanner.Spanner.xPosition`

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

.. hlist::
   :columns: 3

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