PianoStaff - LilyPond program-reference
Description: LilyPond program-reference

Next: RhythmicStaff, Previous: NoteNames, Up: Contexts

#### PianoStaff

Just like `GrandStaff` but with a forced distance between the staves, so cross staff beaming and slurring can be used.

This context also accepts commands for the following context(s):

GrandStaff

This context creates the following layout objects:

Arpeggio, InstrumentName, SpanBar, SystemStartBar, SystemStartBrace, SystemStartBracket, SystemStartSquare and VerticalAlignment.

This context sets the following properties:

- Set translator property `instr` to `'()`
- Set translator property `instrument` to `'()`
- Set grob-property `self-alignment-Y` in VerticalAlignment to `0`.
- Set grob-property `forced-distance` in VerticalAlignment to `12`.
- Set translator property `systemStartDelimiter` to `'SystemStartBrace`
- Set translator property `localKeySignature` to `'()`

Context PianoStaff can contain Staff

This context is built from the following engravers:

`Instrument_name_engraver`
  Creates a system start text for instrument or vocal names.

  Properties (read)

  `vocNam` (markup)
    Name of a vocal line, short version.
  `vocalName` (markup)
    Name of a vocal line.
  `instrument` (markup)
    The name to print left of a staff. The `instrument` property labels the staff in the first system, and the `instr` property labels following lines.
  `instr` (markup)
    See `instrument`
  `currentCommandColumn` (layout object)
    Grob that is X-parent to all current breakable (clef, key signature, etc.) items.
  This engraver creates the following layout objects: InstrumentName.
`Vertical_align_engraver`
  Catch groups (staffs, lyrics lines, etc.) and stack them vertically.

  Properties (read)

  `alignAboveContext` (string)
    Where to insert newly created context in vertiical alignment.
  `alignBelowContext` (string)
    Where to insert newly created context in vertiical alignment.
  This engraver creates the following layout objects: VerticalAlignment.
`System_start_delimiter_engraver`
  Creates a system start delimiter (ie. SystemStart{Bar, Brace, Bracket} spanner

  Properties (read)

  `systemStartDelimiter` (symbol)
    Which grob to make for the start of the system/staff? Set to `SystemStartBrace`, `SystemStartBracket` or `SystemStartBar`.
  `systemStartDelimiterHierarchy` (pair)
    A nested list, indicating the nesting of a start delimiters.
  `currentCommandColumn` (layout object)
    Grob that is X-parent to all current breakable (clef, key signature, etc.) items.
  This engraver creates the following layout objects: SystemStartBar, SystemStartBrace, SystemStartBracket and SystemStartSquare.
`Span_arpeggio_engraver`

  Properties (read)

  `connectArpeggios` (boolean)
    If set, connect arpeggios across piano staff.
  This engraver creates the following layout objects: Arpeggio.
`Span_bar_engraver`
  This engraver makes cross-staff barlines: It catches all normal bar lines, and draws a single span-bar across them.

  This engraver creates the following layout objects: SpanBar.

This page is for LilyPond-2.8.8 (stable-branch).

Other languages: English.
Using automatic language selection.