.. _moduleGraphPrimitives:

music21.graph.primitives
========================

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

.. automodule:: music21.graph.primitives

Graph
-----

.. autoclass:: music21.graph.primitives.Graph

.. rubric:: :class:`~music21.graph.primitives.Graph` read/write properties

.. autoattribute:: music21.graph.primitives.Graph.doneAction

.. rubric:: :class:`~music21.graph.primitives.Graph` methods

.. automethod:: music21.graph.primitives.Graph.applyFormatting

.. automethod:: music21.graph.primitives.Graph.applyFormattingToOneAxis

.. automethod:: music21.graph.primitives.Graph.applyGrid

.. automethod:: music21.graph.primitives.Graph.callDoneAction

.. automethod:: music21.graph.primitives.Graph.hideAxisSpines

.. automethod:: music21.graph.primitives.Graph.nextColor

.. automethod:: music21.graph.primitives.Graph.process

.. automethod:: music21.graph.primitives.Graph.renderSubplot

.. automethod:: music21.graph.primitives.Graph.setAxisLabel

.. automethod:: music21.graph.primitives.Graph.setAxisRange

.. automethod:: music21.graph.primitives.Graph.setData

.. automethod:: music21.graph.primitives.Graph.setIntegerTicksFromData

.. automethod:: music21.graph.primitives.Graph.setTicks

.. automethod:: music21.graph.primitives.Graph.show

.. automethod:: music21.graph.primitives.Graph.write

Graph3DBars
-----------

.. autoclass:: music21.graph.primitives.Graph3DBars

.. rubric:: :class:`~music21.graph.primitives.Graph3DBars` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.Graph3DBars` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.Graph3DBars` methods

.. automethod:: music21.graph.primitives.Graph3DBars.process

.. automethod:: music21.graph.primitives.Graph3DBars.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

GraphColorGrid
--------------

.. autoclass:: music21.graph.primitives.GraphColorGrid

.. rubric:: :class:`~music21.graph.primitives.GraphColorGrid` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGrid` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGrid` methods

.. automethod:: music21.graph.primitives.GraphColorGrid.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGrid` instance variables

.. attribute:: GraphColorGrid.hideLeftBottomSpines

	bool to hide the left and bottom axis spines; default True

GraphColorGridLegend
--------------------

.. autoclass:: music21.graph.primitives.GraphColorGridLegend

.. rubric:: :class:`~music21.graph.primitives.GraphColorGridLegend` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGridLegend` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGridLegend` methods

.. automethod:: music21.graph.primitives.GraphColorGridLegend.makeOneRowOfGraph

.. automethod:: music21.graph.primitives.GraphColorGridLegend.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphColorGridLegend` instance variables

.. attribute:: GraphColorGridLegend.hideLeftBottomSpines

	bool to hide the left and bottom axis spines; default True

GraphGroupedVerticalBar
-----------------------

.. autoclass:: music21.graph.primitives.GraphGroupedVerticalBar

.. rubric:: :class:`~music21.graph.primitives.GraphGroupedVerticalBar` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphGroupedVerticalBar` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphGroupedVerticalBar` methods

.. automethod:: music21.graph.primitives.GraphGroupedVerticalBar.labelBars

.. automethod:: music21.graph.primitives.GraphGroupedVerticalBar.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

GraphHistogram
--------------

.. autoclass:: music21.graph.primitives.GraphHistogram

.. rubric:: :class:`~music21.graph.primitives.GraphHistogram` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphHistogram` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphHistogram` methods

.. automethod:: music21.graph.primitives.GraphHistogram.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphHistogram` instance variables

.. attribute:: GraphHistogram.binWidth

	
	Size of each bin; if the bins are equally spaced at intervals of 1,
	then 0.8 is a good default to allow a little space. 1.0 will give no
	space.
	

GraphHorizontalBar
------------------

.. autoclass:: music21.graph.primitives.GraphHorizontalBar

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBar` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBar` read-only properties

.. autoattribute:: music21.graph.primitives.GraphHorizontalBar.barHeight

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBar` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBar` methods

.. automethod:: music21.graph.primitives.GraphHorizontalBar.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBar` instance variables

.. attribute:: GraphHorizontalBar.barSpace

	Amount of vertical space each bar takes; default 8

.. attribute:: GraphHorizontalBar.margin

	Space around the bars, default 2

GraphHorizontalBarWeighted
--------------------------

.. autoclass:: music21.graph.primitives.GraphHorizontalBarWeighted

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBarWeighted` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBarWeighted` read-only properties

.. autoattribute:: music21.graph.primitives.GraphHorizontalBarWeighted.barHeight

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBarWeighted` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBarWeighted` methods

.. automethod:: music21.graph.primitives.GraphHorizontalBarWeighted.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphHorizontalBarWeighted` instance variables

.. attribute:: GraphHorizontalBarWeighted.barSpace

	Amount of vertical space each bar takes; default 8

.. attribute:: GraphHorizontalBarWeighted.margin

	Space around the bars, default 2

GraphNetworxGraph
-----------------

.. autoclass:: music21.graph.primitives.GraphNetworxGraph

.. rubric:: :class:`~music21.graph.primitives.GraphNetworxGraph` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphNetworxGraph` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphNetworxGraph` methods

.. automethod:: music21.graph.primitives.GraphNetworxGraph.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphNetworxGraph` instance variables

.. attribute:: GraphNetworxGraph.hideLeftBottomSpines

	bool to hide the left and bottom axis spines; default True

.. attribute:: GraphNetworxGraph.networkxGraph

	An instance of a networkx graph object.

GraphScatter
------------

.. autoclass:: music21.graph.primitives.GraphScatter

.. rubric:: :class:`~music21.graph.primitives.GraphScatter` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphScatter` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphScatter` methods

.. automethod:: music21.graph.primitives.GraphScatter.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

GraphScatterWeighted
--------------------

.. autoclass:: music21.graph.primitives.GraphScatterWeighted

.. rubric:: :class:`~music21.graph.primitives.GraphScatterWeighted` bases

- :class:`~music21.graph.primitives.Graph`

.. rubric:: :class:`~music21.graph.primitives.GraphScatterWeighted` read-only properties

.. autoattribute:: music21.graph.primitives.GraphScatterWeighted.rangeDiameter

.. rubric:: :class:`~music21.graph.primitives.GraphScatterWeighted` read/write properties

Read/write properties inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :attr:`~music21.graph.primitives.Graph.doneAction`

.. rubric:: :class:`~music21.graph.primitives.GraphScatterWeighted` methods

.. automethod:: music21.graph.primitives.GraphScatterWeighted.renderSubplot

Methods inherited from :class:`~music21.graph.primitives.Graph`:

.. hlist::
   :columns: 3

   - :meth:`~music21.graph.primitives.Graph.applyFormatting`
   - :meth:`~music21.graph.primitives.Graph.applyFormattingToOneAxis`
   - :meth:`~music21.graph.primitives.Graph.applyGrid`
   - :meth:`~music21.graph.primitives.Graph.callDoneAction`
   - :meth:`~music21.graph.primitives.Graph.hideAxisSpines`
   - :meth:`~music21.graph.primitives.Graph.nextColor`
   - :meth:`~music21.graph.primitives.Graph.process`
   - :meth:`~music21.graph.primitives.Graph.setAxisLabel`
   - :meth:`~music21.graph.primitives.Graph.setAxisRange`
   - :meth:`~music21.graph.primitives.Graph.setData`
   - :meth:`~music21.graph.primitives.Graph.setIntegerTicksFromData`
   - :meth:`~music21.graph.primitives.Graph.setTicks`
   - :meth:`~music21.graph.primitives.Graph.show`
   - :meth:`~music21.graph.primitives.Graph.write`

.. rubric:: :class:`~music21.graph.primitives.GraphScatterWeighted` instance variables

.. attribute:: GraphScatterWeighted.maxDiameter

	the maximum diameter of any ellipse, default 1.25

.. attribute:: GraphScatterWeighted.minDiameter

	the minimum diameter of any ellipse, default 0.25
