BreaksInterface — Abjad v1.1.1 documentation

### Navigation

- index
- modules |
- next |
- previous |
- Project Abjad »
- Abjad v1.1.1 documentation »
- Abjad API »

# BreaksInterface

class `abjad.breaks.interface.` `BreaksInterface`(_client)

  Bases: `abjad.core.interface._Interface`, `abjad.core.formatcontributor._FormatContributor`

  Interface to LilyPond `\break` and `\pageBreak` commands.

  Interface to LilyPond x- and y- system positioning.

  Handle no LilyPond grob.

      abjad> t = Staff(RigidMeasure((2, 8), construct.run(2)) * 2)
      abjad> pitchtools.diatonicize(t)
      abjad> t[0].formatter.number.self = 'comment'
      abjad> t[1].formatter.number.self = 'comment'

      abjad> t[0].breaks.page = True
      abjad> print t.format
      \new Staff {
              % start measure 1
                      \time 2/8
                      c'8
                      d'8
                      \pageBreak
              % stop measure 1
              % start measure 2
                      \time 2/8
                      e'8
                      f'8
              % stop measure 2
      }

  New in version 1.1.1: Affordance for nonstaff whitespace following client.

  New in version 1.1.1: Interface to LilyPond `\adjustEOLMeterBarlineExtraOffset`.

  `alignment_offsets`

    LilyPond `alignment-offsets` list to format as `NonMusicalPaperColumn`.

    Contribution appears before Abjad component.

        abjad> t = Note(0, (1, 4))
        abjad> t.breaks.alignment_offsets = [0, -18, -54, -70]
        abjad> print t.format
        \overrideProperty #"Score.NonMusicalPaperColumn"
        #'line-break-system-details
        #'((alignment-offsets . (0 -18 -54 -70)))
        c'4

  `clear`()

    Set `line`, `page`, `eol_adjustment`, `x` and `y` to `None` and empty `alignment_offsets`.

        abjad> t = Note(0, (1, 4))
        abjad> t.breaks.line = True
        abjad> t.breaks.eol_adjustment = True
        abjad> t.breaks.x = 20
        abjad> t.breaks.y = 40
        abjad> print t.format
        \overrideProperty #"Score.NonMusicalPaperColumn"
        #'line-break-system-details
        #'((X-offset . 20) (Y-offset . 40))
        c'4
        \adjustEOLMeterBarlineExtraOffset
        \break

        abjad> t.breaks.clear( )
        abjad> print t.format
        c'4

    Todo

    Reimplement all _Interface.clear( ) methods with __init__

  `eol_adjustment`

    New in version 1.1.1: Read / write boolean set.

    Set to `True` to apply LilyPond `extra-offset` to both LilyPond TimeSignature and LilyPond BarLine grobs.

    Otherwise, apply no `extra-offset`

    Raise `LineBreakError` when no line break is present.

  `line`

    Boolean setting to contribute LilyPond `\line` break.

    Contribution appears after Abjad component.

  `page`

    Boolean setting to contribute LilyPond `\pageBreak`.

    Contribution appears after Abjad component.

  `whitespace`

    Rational-valued non-durative whitespace following client.

    Fake measure between `\stopStaff`, `\startStaff` commands.

  `x`

    X-value for `line-break-system-details` contribution.

    Contribution appears before Abjad component.

  `y`

    Y-value for `line-break-system-details` contribution.

    Contribution appears before Abjad component.

### Navigation

- index
- modules |
- next |
- previous |
- Project Abjad »
- Abjad v1.1.1 documentation »
- Abjad API »