pymusicxml.score_components.Direction
- class pymusicxml.score_components.Direction(placement: str | StaffPlacement = 'above', voice: int = 1, staff: Optional[int] = None)[source]
Bases:
MusicXMLComponent,ABCAbstract base class for musical directions, such as text and metronome marks.
Methods
render()Renders this component to a tuple of ElementTree.Element.
Renders the <direction-type> element that constitutes the main substance of a <direction> element.
Wraps this component in a
Scoreso that it can be exported and viewedInherited Methods
export_to_file(file_path[, pretty_print])Exports this musical object (wrapped as a score) to the given file path.
to_xml([pretty_print])Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.
view_in_software(command)Uses the given terminal command to create a score out of this musical object, and open it in music notation software.
- export_to_file(file_path: str, pretty_print: bool = True) None
Exports this musical object (wrapped as a score) to the given file path.
- Parameters:
file_path – The path of the file we want to write to.
pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation
- to_xml(pretty_print: bool = False) str
Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.
- Parameters:
pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation
- view_in_software(command: str) None
Uses the given terminal command to create a score out of this musical object, and open it in music notation software.
- Parameters:
command – The terminal command corresponding to the software with which we want to open the score.
- render() Sequence[Element][source]
Renders this component to a tuple of ElementTree.Element. (The reason for making it a tuple is that musical objects like chords are represented by several notes side by side, with all but the first containing a </chord> tag.)