Music properties
X-offset
(number)- Offset of resulting grob; only used for balloon texts.
Y-offset
(number)- Offset of resulting grob; only used for balloon texts.
absolute-octave
(integer)- The absolute octave for a octave check note.
alteration
(number)- Alteration for figured bass.
articulation-type
(string)- Key for script definitions alist.
TODO: Consider making type into symbol.
articulations
(list of music)- Articulation events specifically for this note.
associated-context
(string)- Name of the Voice context associated with
this
\newaddlyrics
section.
augmented
(boolean)- This figure is for an augmented figured bass
(with
+
sign).
augmented-slash
(boolean)- This figure is for an augmented figured bass
(back-slashed number).
bass
(boolean)- Set if this note is a bass note in a chord.
bracket-start
(boolean)- Start a bracket here.
TODO: Use SpanEvents?
bracket-stop
(boolean)- Stop a bracket here.
break-penalty
(number)- Penalty for line break hint.
break-permission
(symbol)- Whether to allow, forbid or force a line break.
cautionary
(boolean)- If set, this alteration needs a
cautionary accidental.
change-to-id
(string)- Name of the context to change to.
change-to-type
(symbol)- Type of the context to change to.
compress-procedure
(procedure)- Compress this music expression.
Arg 1: the music, arg 2: factor.
context-id
(string)- Name of context.
context-type
(symbol)- Type of context.
create-new
(boolean)- Create a fresh context.
delta-step
(number)- How much should a fall change pitch?
denominator
(integer)- Denominator in a time signature.
descend-only
(boolean)- If set, this
\context
only descends
in the context tree.
digit
(integer)- Digit for fingering.
diminished
(boolean)- This bass figure should be slashed.
direction
(direction)- Print this up or down?
drum-type
(symbol)- Which percussion instrument to play this note on.
duration
(duration)- Duration of this note or lyric.
element
(music)- The single child of a Music_wrapper music object,
or the body of a repeat.
elements
(list of music)- A list of elements for sequential of
simultaneous music, or the alternatives of repeated music.
elements-callback
(procedure)- Return a list of children, for use by
a sequential iterator. Takes a single music parameter.
error-found
(boolean)- If true, a parsing error was found in this expression.
expected-beam-count
(integer)- Expected number of non-tremolo beams
in a tremolo repeat.
figure
(integer)- A bass figure.
force-accidental
(boolean)- If set, a cautionary accidental should
always be printed on this note.
grob-property
(symbol)- The symbol of the grob property to set.
grob-property-path
(list)- A list of symbols, locating a nested grob
property, e.g.,
(beamed-lengths details)
.
grob-value
(any type)- The value of the grob property to set.
input-tag
(any type)- Arbitrary marker to relate input and output.
inversion
(boolean)- If set, this chord note is inverted.
iterator-ctor
(procedure)- Function to construct a
music-event-iterator
object for this music.
label
(markup)- Label of a mark.
last-pitch
(pitch)- The last pitch after relativization.
length
(moment)- The duration of this music.
length-callback
(procedure)- How to compute the duration of this music.
This property can only be defined as initializer in
scm/define-music-types.scm.
line-break-permission
(symbol)- When the music is at top-level,
whether to allow, forbid or force a line break.
metronome-count
(number)- How many beats in a minute?
name
(symbol)- Name of this music object.
no-continuation
(boolean)- If set, disallow continuation lines.
numerator
(integer)- Numerator of a time signature.
octavation
(integer)- This pitch was octavated by how many octaves?
For chord inversions, this is negative.
once
(boolean)- Apply this operation only during one time step?
origin
(input location)- Where was this piece of music defined?
page-break-permission
(symbol)- When the music is at top-level,
whether to allow, forbid or force a page break.
page-label
(symbol)- The label of a page marker.
page-marker
(boolean)- If true, and the music expression is found at
top-level, a page marker object is instanciated instead of a score.
page-turn-permission
(symbol)- When the music is at top-level,
whether to allow, forbid or force a page turn.
parenthesize
(boolean)- Enclose resulting objects in parentheses?
part-combine-status
(symbol)- Change to what kind of state?
Options are
solo1
, solo2
and unisono
.
pitch
(pitch)- The pitch of this note.
pitch-alist
(list)- A list of pitches jointly forming the scale
of a key signature.
pop-first
(boolean)- Do a revert before we try to do a override
on some grob property.
prob-property
(symbol)- The symbol of the prob property to set.
procedure
(procedure)- The function to run with
\applycontext
.
It must take a single argument, being the context.
property-operations
(list)- Do these operations for instantiating
the context.
quoted-context-id
(string)- The ID of the context to direct quotes to,
e.g.,
cue
.
quoted-context-type
(symbol)- The name of the context to
direct quotes to, e.g.,
Voice
.
quoted-events
(vector)- A vector of with
moment
and
event-list
entries.
quoted-music-name
(string)- The name of the voice to quote.
quoted-transposition
(pitch)- The pitch used for the quote,
overriding
\transposition
.
quoted-voice-direction
(direction)- Should the quoted voice be up-stem
or down-stem?
repeat-count
(integer)- Do a
\repeat
how often?
span-direction
(direction)- Does this start or stop a spanner?
span-type
(string)- What kind of spanner should be created?
TODO: Consider making type into symbol.
split-list
(list)- Splitting moments for part combiner.
start-callback
(procedure)- Function to compute the negative length
of starting grace notes. This property can only be defined as initializer
in scm/define-music-types.scm.
string-number
(integer)- The number of the string in
a
StringNumberEvent.
symbol
(symbol)- Grob name to perform an override or revert on.
tags
(list)- List of symbols that for denoting extra details, e.g.,
\tag #'part ...
could tag a piece of music as only being active
in a part.
tempo-unit
(duration)- The unit for the metronome count.
text
(markup)- Markup expression to be printed.
text-type
(symbol)- Particular type of text script (e.g., finger, dynamic).
to-relative-callback
(procedure)- How to transform a piece of music
to relative pitches.
tonic
(pitch)- Base of the scale.
tremolo-type
(integer)- Speed of tremolo, e.g., 16 for
c4:16
.
trill-pitch
(pitch)- Pitch of other note of the trill.
tweaks
(list)- An alist of properties to override in the backend
for the grob made of this event.
type
(symbol)- The type of this music object.
Determines iteration in some cases.
types
(list)- The types of this music object; determines by what
engraver this music expression is processed.
untransposable
(boolean)- If set, this music is not transposed.
value
(any type)- Assignment value for a translation property.
void
(boolean)- If this property is
#t
, then the
music expression is to be discarded by the toplevel music handler.
what
(symbol)- What to change for auto-change.
FIXME: Naming.