pymusicxml.spanners.StartBracket
- class pymusicxml.spanners.StartBracket(label: Any = 1, line_type: str | LineType = 'dashed', line_end: Optional[Union[str, LineEnd]] = None, end_length: Optional[Real] = None, text: Optional[Union[str, TextAnnotation]] = None, placement: str | StaffPlacement = 'above', voice: int = 1, staff: Optional[int] = None)[source]
Bases:
Direction
,StartNumberedSpanner
Start of a bracket spanner.
- Parameters:
label – each spanner is given an label to distinguish it from other spanners of the same type. In the MusicXML standard, this is a number from 1 to 6, but in pymusicxml it is allowed to be anything (including, for instance, a string). These labels are then converted to numbers on export.
line_end – Type of hook/arrow at the start of this bracket
end_length – Length of the hock at the start of this bracket
text – Any text to attach to the start of this bracket
placement – Where to place the direction in relation to the staff (“above” or “below”)
voice – Which voice to attach to
staff – Which staff to attach to if the part has multiple staves
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.
Inherited 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.
Wraps this component in a
Score
so that it can be exported and viewedAttributes
- STOP_TYPE
alias of
StopBracket
- render_direction_type() Sequence[Element] [source]
Renders the <direction-type> element that constitutes the main substance of a <direction> element.
- 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.)
- MID_TYPES: Sequence[MidNumberedSpanner] = ()
- 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.