scamp.spanners.StartDashes

class scamp.spanners.StartDashes(label: Any = 0, **formatting)[source]

Bases: Spanner

Start dashes spanner.

Parameters:
  • label – See Spanner.

  • formatting – See Spanner. Formatting can consist of {“placement”: “above”/”below”, “text”: [string], “dash_length”: [number of pixels], “space_length”: [number of pixels]}

Methods

get_abjad_direction()

to_abjad()

Converts this to an abjad indicator.

to_pymusicxml()

Converts this to a pymusicxml spanner type.

Inherited Methods

duplicate()

Returns a copy of this object by serializing to and from JSON.

json_dumps()

Dump this object as a JSON string.

json_loads(s)

Load this object from a JSON string.

load_from_json(file_path)

Load this object from a JSON file with the given path.

save_to_json(file_path)

Save this object to a JSON file using the given path.

Attributes

FORMATTING_SLOTS

START_MID_OR_STOP

START_MID_OR_STOP = 'start'
FORMATTING_SLOTS = {'dash_length', 'placement', 'space_length', 'text'}
to_pymusicxml()[source]

Converts this to a pymusicxml spanner type.

to_abjad()[source]

Converts this to an abjad indicator.

get_abjad_direction()[source]
duplicate() T

Returns a copy of this object by serializing to and from JSON.

json_dumps() str

Dump this object as a JSON string. This uses a custom encoder that recognizes and appropriately converts any attributes that are object inheriting from SavesToJSON.

classmethod json_loads(s: str) T

Load this object from a JSON string. This uses a custom decoder that looks for a “_type” key in any object/dictionary being parsed and converts it to the class specified (assuming it a subclass of SavesToJSON).

Parameters:

s – a string representing this object in JSON format

classmethod load_from_json(file_path: str) T

Load this object from a JSON file with the given path. This uses a custom decoder that looks for a “_type” key in any object/dictionary being parsed and converts it to the class specified (assuming it a subclass of SavesToJSON).

Parameters:

file_path – path for loading the file

save_to_json(file_path: str) None

Save this object to a JSON file using the given path. This uses a custom encoder that recognizes and appropriately converts any attributes that are object inheriting from SavesToJSON.

Parameters:

file_path – path for saving the file