spannertools.TextSpanner

class abjad.tools.spannertools.TextSpanner.TextSpanner.TextSpanner(components=None)

New in version 2.0.

Abjad text spanner:

abjad> staff = Staff("c'8 d'8 e'8 f'8")
abjad> text_spanner = spannertools.TextSpanner(staff[:])

abjad> markup = markuptools.Markup('(markup #:bold #:italic "foo")', style_string = 'scheme')
abjad> text_spanner.override.text_spanner.bound_details__left__text = markup
abjad> markup = markuptools.Markup("(markup #:draw-line '(0 . -1))", style_string = 'scheme')
abjad> text_spanner.override.text_spanner.bound_details__right__text = markup
abjad> text_spanner.override.text_spanner.dash_fraction = 1

abjad> f(staff)
\new Staff {
    \override TextSpanner #'bound-details #'left #'text = #(markup #:bold #:italic "foo")
    \override TextSpanner #'bound-details #'right #'text = #(markup #:draw-line '(0 . -1))
    \override TextSpanner #'dash-fraction = #1
    c'8 \startTextSpan
    d'8
    e'8
    f'8 \stopTextSpan
    \revert TextSpanner #'bound-details #'left #'text
    \revert TextSpanner #'bound-details #'right #'text
    \revert TextSpanner #'dash-fraction
}

Override LilyPond TextSpanner grob.

Return text spanner.

Read-only Properties

TextSpanner.components

Return read-only tuple of components in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner.components
(Note("c'8"), Note("d'8"))

Changed in version 1.1: Now returns an (immutable) tuple instead of a (mutable) list.

Note

Inherited from spannertools.Spanner

TextSpanner.duration_in_seconds

Sum of duration of all leaves in spanner, in seconds.

Note

Inherited from spannertools.Spanner

TextSpanner.leaves

Return read-only tuple of leaves in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner.leaves
(Note("c'8"), Note("d'8"))

Changed in version 1.1: Now returns an (immutable) tuple instead of a (mutable) list.

Note

When dealing with large, complex scores accessing this attribute can take some time. Best to make a local copy with leaves = spanner.leaves first. Or use spanner- specific iteration tools.

Note

Inherited from spannertools.Spanner

TextSpanner.offset

New in version 1.1.

Return read-only reference to spanner offset interface.

Spanner offset interface implements start and stop attributes.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner._offset.start
Offset(1, 4)

abjad> spanner._offset.stop
Offset(1, 2)

Return duration.

Note

Inherited from spannertools.Spanner

TextSpanner.override

LilyPond grob override component plug-in.

Note

Inherited from spannertools.Spanner

TextSpanner.preprolated_duration

Sum of preprolated duration of all components in spanner.

Note

Inherited from spannertools.Spanner

TextSpanner.prolated_duration

Sum of prolated duration of all components in spanner.

Note

Inherited from spannertools.Spanner

TextSpanner.set

LilyPond context setting component plug-in.

Note

Inherited from spannertools.Spanner

TextSpanner.written_duration

Sum of written duration of all components in spanner.

Note

Inherited from spannertools.Spanner

Methods

TextSpanner.append(component)

Add component to right of spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner
Spanner(c'8, d'8)

abjad> spanner.append(voice[2])
abjad> spanner
Spanner(c'8, d'8, e'8)

Return none.

Note

Inherited from spannertools.Spanner

TextSpanner.append_left(component)

Add component to left of spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.append_left(voice[1])
abjad> spanner
Spanner(d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

TextSpanner.clear()

Remove all components from spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.clear()
abjad> spanner
Spanner()

Return none.

Note

Inherited from spannertools.Spanner

TextSpanner.extend(components)

Add iterable components to right of spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner
Spanner(c'8, d'8)

abjad> spanner.extend(voice[2:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

TextSpanner.extend_left(components)

Add iterable components to left of spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.extend_left(voice[:2])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

TextSpanner.fracture(i, direction='both')

Fracture spanner at direction of component at index i.

Valid values for direction are 'left', 'right' and 'both'.

Return original, left and right spanners.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> beam = spannertools.BeamSpanner(voice[:])
abjad> beam
BeamSpanner(c'8, d'8, e'8, f'8)

abjad> beam.fracture(1, direction = 'left')
(BeamSpanner(c'8, d'8, e'8, f'8), BeamSpanner(c'8), BeamSpanner(d'8, e'8, f'8))

abjad> print voice.format
\new Voice {
    c'8 [ ]
    d'8 [
    e'8
    f'8 ]
}

Return tuple.

Note

Inherited from spannertools.Spanner

TextSpanner.fuse(spanner)

Fuse contiguous spanners.

Return new spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> left_beam = spannertools.BeamSpanner(voice[:2])
abjad> right_beam = spannertools.BeamSpanner(voice[2:])

abjad> print voice.format
\new Voice {
    c'8 [
    d'8 ]
    e'8 [
    f'8 ]
}

abjad> left_beam.fuse(right_beam)
[(BeamSpanner(c'8, d'8), BeamSpanner(e'8, f'8), BeamSpanner(c'8, d'8, e'8, f'8))]

abjad> print voice.format
\new Voice {
    c'8 [
    d'8
    e'8
    f'8 ]
}

Todo

Return (immutable) tuple instead of (mutable) list.

Note

Inherited from spannertools.Spanner

TextSpanner.index(component)

Return nonnegative integer index of component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.index(voice[-2])
0

Return nonnegative integer.

Note

Inherited from spannertools.Spanner

TextSpanner.pop()

Remove and return rightmost component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.pop()
Note("f'8")

abjad> spanner
Spanner(c'8, d'8, e'8)

Return component.

Note

Inherited from spannertools.Spanner

TextSpanner.pop_left()

Remove and return leftmost component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.pop_left()
Note("c'8")

abjad> spanner
Spanner(d'8, e'8, f'8)

Return component.

Note

Inherited from spannertools.Spanner

Special Methods

TextSpanner.__contains__(expr)

Note

Inherited from spannertools.Spanner

TextSpanner.__delattr__()

x.__delattr__(‘name’) <==> del x.name

Note

Inherited from __builtin__.object

TextSpanner.__eq__(arg)

True when id(self) equals id(arg).

Return boolean.

Note

Inherited from abctools.AbjadObject

TextSpanner.__ge__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

TextSpanner.__getitem__(expr)

Note

Inherited from spannertools.Spanner

TextSpanner.__gt__(arg)

Abjad objects by default do not implement this method.

Raise exception

Note

Inherited from abctools.AbjadObject

TextSpanner.__hash__() <==> hash(x)

Note

Inherited from __builtin__.object

TextSpanner.__le__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

TextSpanner.__len__()

Note

Inherited from spannertools.Spanner

TextSpanner.__lt__(other)

Trivial comparison to allow doctests to work.

Note

Inherited from spannertools.Spanner

TextSpanner.__ne__(arg)

True when id(self) does not equal id(arg).

Return boolean.

Note

Inherited from abctools.AbjadObject

TextSpanner.__repr__()

Note

Inherited from spannertools.Spanner

TextSpanner.__setattr__()

x.__setattr__(‘name’, value) <==> x.name = value

Note

Inherited from __builtin__.object

TextSpanner.__str__() <==> str(x)

Note

Inherited from __builtin__.object