<!-- header_tag -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on January 24, 2009 by texi2html 1.79
texi2html was written by:
Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>LilyPond program-reference: 1.3 Music properties</title>
<meta name="description" content="LilyPond program-reference: 1.3 Music properties">
<meta name="keywords" content="LilyPond program-reference: 1.3 Music properties">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.79">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="GNU LilyPond – Internals Reference">
<link href="Indices.html#Indices" rel="index" title="A. Indices">
<link href="index_toc.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index_abt.html#SEC_About" rel="help" title="About This Document">
<link href="Music-definitions.html#Music-definitions" rel="up" title="1. Music definitions">
<link href="Indices.html#Indices" rel="next" title="A.2 Function index">
<link href="unisono_002devent.html#unisono_002devent" rel="previous" title="1.2.67 unisono-event">
<link rel="stylesheet" type="text/css" title="Patrick McCarty's design" href="lilypond-mccarty.css">
<link rel="alternate stylesheet" type="text/css" href="lilypond.css" title="Andrew Hawryluk's design">
<link rel="alternate stylesheet" type="text/css" href="lilypond-blue.css" title="Kurt Kroon's blue design">
<!--[if lte IE 7]>
<link href="lilypond-ie-fixes.css" rel="stylesheet" type="text/css">
<![endif]-->
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<div id="main">
<a name="Music-properties"></a>
<table class="nav_table">
<tr><td valign="middle" align="left" colspan="1">[<a href="Music-definitions.html#Music-definitions" title="Beginning of this chapter or previous chapter"> << Music definitions </a>]</td><td valign="middle" align="center" colspan="3">[<a href="index.html#Top" title="Cover (top) of document" rel="start">Top</a>][<a href="index_toc.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>][<a href="index_abt.html#SEC_About" title="About (help)" rel="help"> ? </a>]</td><td valign="middle" align="right" colspan="1">[<a href="Translation.html#Translation" title="Next chapter"> Translation >> </a>]</td></tr><tr><td valign="middle" align="left" colspan="2">[<a href="unisono_002devent.html#unisono_002devent" title="Previous section in reading order" accesskey="p" rel="previous"> < unisono-event </a>]</td><td valign="middle" align="center" colspan="1">[<a href="Music-definitions.html#Music-definitions" title="Up section" accesskey="u" rel="up"> Up : Music definitions </a>]</td><td valign="middle" align="right" colspan="2">[<a href="Translation.html#Translation" title="Next section in reading order" accesskey="n" rel="next"> Translation > </a>]</td></tr></table>
<a name="Music-properties"></a>
<h2 class="section">1.3 Music properties</h2>
<dl compact="compact">
<dt> <code>X-offset</code> (number)</dt>
<dd><p>Offset of resulting grob; only used for balloon texts.
</p></dd>
<dt> <code>Y-offset</code> (number)</dt>
<dd><p>Offset of resulting grob; only used for balloon texts.
</p></dd>
<dt> <code>absolute-octave</code> (integer)</dt>
<dd><p>The absolute octave for a octave check note.
</p></dd>
<dt> <code>alteration</code> (number)</dt>
<dd><p>Alteration for figured bass.
</p></dd>
<dt> <code>articulation-type</code> (string)</dt>
<dd><p>Key for script definitions alist.
</p>
<p>TODO: Consider making type into symbol.
</p></dd>
<dt> <code>articulations</code> (list of music)</dt>
<dd><p>Articulation events specifically for this note.
</p></dd>
<dt> <code>associated-context</code> (string)</dt>
<dd><p>Name of the Voice context associated with
this <code>\newaddlyrics</code> section.
</p></dd>
<dt> <code>augmented</code> (boolean)</dt>
<dd><p>This figure is for an augmented figured bass
(with <code>+</code> sign).
</p></dd>
<dt> <code>augmented-slash</code> (boolean)</dt>
<dd><p>This figure is for an augmented figured bass
(back-slashed number).
</p></dd>
<dt> <code>bass</code> (boolean)</dt>
<dd><p>Set if this note is a bass note in a chord.
</p></dd>
<dt> <code>bracket-start</code> (boolean)</dt>
<dd><p>Start a bracket here.
</p>
<p>TODO: Use SpanEvents?
</p></dd>
<dt> <code>bracket-stop</code> (boolean)</dt>
<dd><p>Stop a bracket here.
</p></dd>
<dt> <code>break-penalty</code> (number)</dt>
<dd><p>Penalty for line break hint.
</p></dd>
<dt> <code>break-permission</code> (symbol)</dt>
<dd><p>Whether to allow, forbid or force a line break.
</p></dd>
<dt> <code>cautionary</code> (boolean)</dt>
<dd><p>If set, this alteration needs a
cautionary accidental.
</p></dd>
<dt> <code>change-to-id</code> (string)</dt>
<dd><p>Name of the context to change to.
</p></dd>
<dt> <code>change-to-type</code> (symbol)</dt>
<dd><p>Type of the context to change to.
</p></dd>
<dt> <code>compress-procedure</code> (procedure)</dt>
<dd><p>Compress this music expression.
Arg 1: the music, arg 2: factor.
</p></dd>
<dt> <code>context-id</code> (string)</dt>
<dd><p>Name of context.
</p></dd>
<dt> <code>context-type</code> (symbol)</dt>
<dd><p>Type of context.
</p></dd>
<dt> <code>create-new</code> (boolean)</dt>
<dd><p>Create a fresh context.
</p></dd>
<dt> <code>delta-step</code> (number)</dt>
<dd><p>How much should a fall change pitch?
</p></dd>
<dt> <code>denominator</code> (integer)</dt>
<dd><p>Denominator in a time signature.
</p></dd>
<dt> <code>descend-only</code> (boolean)</dt>
<dd><p>If set, this <code>\context</code> only descends
in the context tree.
</p></dd>
<dt> <code>digit</code> (integer)</dt>
<dd><p>Digit for fingering.
</p></dd>
<dt> <code>diminished</code> (boolean)</dt>
<dd><p>This bass figure should be slashed.
</p></dd>
<dt> <code>direction</code> (direction)</dt>
<dd><p>Print this up or down?
</p></dd>
<dt> <code>drum-type</code> (symbol)</dt>
<dd><p>Which percussion instrument to play this note on.
</p></dd>
<dt> <code>duration</code> (duration)</dt>
<dd><p>Duration of this note or lyric.
</p></dd>
<dt> <code>element</code> (music)</dt>
<dd><p>The single child of a Music_wrapper music object,
or the body of a repeat.
</p></dd>
<dt> <code>elements</code> (list of music)</dt>
<dd><p>A list of elements for sequential of
simultaneous music, or the alternatives of repeated music.
</p></dd>
<dt> <code>elements-callback</code> (procedure)</dt>
<dd><p>Return a list of children, for use by
a sequential iterator. Takes a single music parameter.
</p></dd>
<dt> <code>error-found</code> (boolean)</dt>
<dd><p>If true, a parsing error was found in this expression.
</p></dd>
<dt> <code>expected-beam-count</code> (integer)</dt>
<dd><p>Expected number of non-tremolo beams
in a tremolo repeat.
</p></dd>
<dt> <code>figure</code> (integer)</dt>
<dd><p>A bass figure.
</p></dd>
<dt> <code>force-accidental</code> (boolean)</dt>
<dd><p>If set, a cautionary accidental should
always be printed on this note.
</p></dd>
<dt> <code>grob-property</code> (symbol)</dt>
<dd><p>The symbol of the grob property to set.
</p></dd>
<dt> <code>grob-property-path</code> (list)</dt>
<dd><p>A list of symbols, locating a nested grob
property, e.g., <code>(beamed-lengths details)</code>.
</p></dd>
<dt> <code>grob-value</code> (any type)</dt>
<dd><p>The value of the grob property to set.
</p></dd>
<dt> <code>input-tag</code> (any type)</dt>
<dd><p>Arbitrary marker to relate input and output.
</p></dd>
<dt> <code>inversion</code> (boolean)</dt>
<dd><p>If set, this chord note is inverted.
</p></dd>
<dt> <code>iterator-ctor</code> (procedure)</dt>
<dd><p>Function to construct a
<code>music-event-iterator</code> object for this music.
</p></dd>
<dt> <code>label</code> (markup)</dt>
<dd><p>Label of a mark.
</p></dd>
<dt> <code>last-pitch</code> (pitch)</dt>
<dd><p>The last pitch after relativization.
</p></dd>
<dt> <code>length</code> (moment)</dt>
<dd><p>The duration of this music.
</p></dd>
<dt> <code>length-callback</code> (procedure)</dt>
<dd><p>How to compute the duration of this music.
This property can only be defined as initializer in
‘<tt>scm/define-music-types.scm</tt>’.
</p></dd>
<dt> <code>line-break-permission</code> (symbol)</dt>
<dd><p>When the music is at top-level,
whether to allow, forbid or force a line break.
</p></dd>
<dt> <code>metronome-count</code> (number)</dt>
<dd><p>How many beats in a minute?
</p></dd>
<dt> <code>name</code> (symbol)</dt>
<dd><p>Name of this music object.
</p></dd>
<dt> <code>no-continuation</code> (boolean)</dt>
<dd><p>If set, disallow continuation lines.
</p></dd>
<dt> <code>numerator</code> (integer)</dt>
<dd><p>Numerator of a time signature.
</p></dd>
<dt> <code>octavation</code> (integer)</dt>
<dd><p>This pitch was octavated by how many octaves?
For chord inversions, this is negative.
</p></dd>
<dt> <code>once</code> (boolean)</dt>
<dd><p>Apply this operation only during one time step?
</p></dd>
<dt> <code>origin</code> (input location)</dt>
<dd><p>Where was this piece of music defined?
</p></dd>
<dt> <code>page-break-permission</code> (symbol)</dt>
<dd><p>When the music is at top-level,
whether to allow, forbid or force a page break.
</p></dd>
<dt> <code>page-label</code> (symbol)</dt>
<dd><p>The label of a page marker.
</p></dd>
<dt> <code>page-marker</code> (boolean)</dt>
<dd><p>If true, and the music expression is found at
top-level, a page marker object is instanciated instead of a score.
</p></dd>
<dt> <code>page-turn-permission</code> (symbol)</dt>
<dd><p>When the music is at top-level,
whether to allow, forbid or force a page turn.
</p></dd>
<dt> <code>parenthesize</code> (boolean)</dt>
<dd><p>Enclose resulting objects in parentheses?
</p></dd>
<dt> <code>part-combine-status</code> (symbol)</dt>
<dd><p>Change to what kind of state?
Options are <code>solo1</code>, <code>solo2</code> and <code>unisono</code>.
</p></dd>
<dt> <code>pitch</code> (pitch)</dt>
<dd><p>The pitch of this note.
</p></dd>
<dt> <code>pitch-alist</code> (list)</dt>
<dd><p>A list of pitches jointly forming the scale
of a key signature.
</p></dd>
<dt> <code>pop-first</code> (boolean)</dt>
<dd><p>Do a revert before we try to do a override
on some grob property.
</p></dd>
<dt> <code>prob-property</code> (symbol)</dt>
<dd><p>The symbol of the prob property to set.
</p></dd>
<dt> <code>procedure</code> (procedure)</dt>
<dd><p>The function to run with <code>\applycontext</code>.
It must take a single argument, being the context.
</p></dd>
<dt> <code>property-operations</code> (list)</dt>
<dd><p>Do these operations for instantiating
the context.
</p></dd>
<dt> <code>quoted-context-id</code> (string)</dt>
<dd><p>The ID of the context to direct quotes to,
e.g., <code>cue</code>.
</p></dd>
<dt> <code>quoted-context-type</code> (symbol)</dt>
<dd><p>The name of the context to
direct quotes to, e.g., <code>Voice</code>.
</p></dd>
<dt> <code>quoted-events</code> (vector)</dt>
<dd><p>A vector of with <code>moment</code> and
<code>event-list</code> entries.
</p></dd>
<dt> <code>quoted-music-name</code> (string)</dt>
<dd><p>The name of the voice to quote.
</p></dd>
<dt> <code>quoted-transposition</code> (pitch)</dt>
<dd><p>The pitch used for the quote,
overriding <code>\transposition</code>.
</p></dd>
<dt> <code>quoted-voice-direction</code> (direction)</dt>
<dd><p>Should the quoted voice be up-stem
or down-stem?
</p></dd>
<dt> <code>repeat-count</code> (integer)</dt>
<dd><p>Do a <code>\repeat</code> how often?
</p></dd>
<dt> <code>span-direction</code> (direction)</dt>
<dd><p>Does this start or stop a spanner?
</p></dd>
<dt> <code>span-type</code> (string)</dt>
<dd><p>What kind of spanner should be created?
</p>
<p>TODO: Consider making type into symbol.
</p></dd>
<dt> <code>split-list</code> (list)</dt>
<dd><p>Splitting moments for part combiner.
</p></dd>
<dt> <code>start-callback</code> (procedure)</dt>
<dd><p>Function to compute the negative length
of starting grace notes. This property can only be defined as initializer
in ‘<tt>scm/define-music-types.scm</tt>’.
</p></dd>
<dt> <code>string-number</code> (integer)</dt>
<dd><p>The number of the string in
a <code>StringNumberEvent.</code>
</p></dd>
<dt> <code>symbol</code> (symbol)</dt>
<dd><p>Grob name to perform an override or revert on.
</p></dd>
<dt> <code>tags</code> (list)</dt>
<dd><p>List of symbols that for denoting extra details, e.g.,
<code>\tag #'part …</code> could tag a piece of music as only being active
in a part.
</p></dd>
<dt> <code>tempo-unit</code> (duration)</dt>
<dd><p>The unit for the metronome count.
</p></dd>
<dt> <code>text</code> (markup)</dt>
<dd><p>Markup expression to be printed.
</p></dd>
<dt> <code>text-type</code> (symbol)</dt>
<dd><p>Particular type of text script (e.g., finger, dynamic).
</p></dd>
<dt> <code>to-relative-callback</code> (procedure)</dt>
<dd><p>How to transform a piece of music
to relative pitches.
</p></dd>
<dt> <code>tonic</code> (pitch)</dt>
<dd><p>Base of the scale.
</p></dd>
<dt> <code>tremolo-type</code> (integer)</dt>
<dd><p>Speed of tremolo, e.g., 16 for <code>c4:16</code>.
</p></dd>
<dt> <code>trill-pitch</code> (pitch)</dt>
<dd><p>Pitch of other note of the trill.
</p></dd>
<dt> <code>tweaks</code> (list)</dt>
<dd><p>An alist of properties to override in the backend
for the grob made of this event.
</p></dd>
<dt> <code>type</code> (symbol)</dt>
<dd><p>The type of this music object.
Determines iteration in some cases.
</p></dd>
<dt> <code>types</code> (list)</dt>
<dd><p>The types of this music object; determines by what
engraver this music expression is processed.
</p></dd>
<dt> <code>untransposable</code> (boolean)</dt>
<dd><p>If set, this music is not transposed.
</p></dd>
<dt> <code>value</code> (any type)</dt>
<dd><p>Assignment value for a translation property.
</p></dd>
<dt> <code>void</code> (boolean)</dt>
<dd><p>If this property is <code>#t</code>, then the
music expression is to be discarded by the toplevel music handler.
</p></dd>
<dt> <code>what</code> (symbol)</dt>
<dd><p>What to change for auto-change.
</p>
<p>FIXME: Naming.
</p></dd>
</dl>
<hr size="6">
<table class="nav_table">
<tr><td valign="middle" align="left" colspan="1">[<a href="Music-definitions.html#Music-definitions" title="Beginning of this chapter or previous chapter"> << Music definitions </a>]</td><td valign="middle" align="center" colspan="3">[<a href="index.html#Top" title="Cover (top) of document" rel="start">Top</a>][<a href="index_toc.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>][<a href="index_abt.html#SEC_About" title="About (help)" rel="help"> ? </a>]</td><td valign="middle" align="right" colspan="1">[<a href="Translation.html#Translation" title="Next chapter"> Translation >> </a>]</td></tr><tr><td valign="middle" align="left" colspan="2">[<a href="unisono_002devent.html#unisono_002devent" title="Previous section in reading order" accesskey="p" rel="previous"> < unisono-event </a>]</td><td valign="middle" align="center" colspan="1">[<a href="Music-definitions.html#Music-definitions" title="Up section" accesskey="u" rel="up"> Up : Music definitions </a>]</td><td valign="middle" align="right" colspan="2">[<a href="Translation.html#Translation" title="Next section in reading order" accesskey="n" rel="next"> Translation > </a>]</td></tr></table>
<!-- footer_tag -->
<div class="footer">
<p class="footer_version">
This page is for LilyPond-2.12.2 (stable-branch).
</p>
<p class="footer_report">
Your <a href="http://lilypond.org/web/devel/participating/documentation-adding">suggestions for the documentation</a> are welcome, please report errors to our <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">bug list</a>.
</p>
</div>
<!-- FOOTER -->
<!-- end div#main here -->
</div>
<div id="tocframe">
<p class="toc_uplink"><a href="../index.html"
title="Documentation Index"><< Back to Documentation Index</a></p>
<h4 class="toc_header"> <a href="index.html#Top" title="Start of the manual">Internals Reference</a></h4>
<div class="contents">
<ul class="toc">
<li class="toc_current"><a name="toc-Music-definitions-1" href="Music-definitions.html#Music-definitions">1. Music definitions</a>
<ul class="toc">
<li><a name="toc-Music-expressions-1" href="Music-expressions.html#Music-expressions">1.1 Music expressions</a> </li>
<li><a name="toc-Music-classes-1" href="Music-classes.html#Music-classes">1.2 Music classes</a> </li>
<li class="toc_current"><a name="toc-Music-properties-1" href="Music-properties.html#Music-properties">1.3 Music properties</a> </li>
</ul>
</li>
<li><a name="toc-Translation-1" href="Translation.html#Translation">2. Translation</a>
<ul class="toc">
<li><a name="toc-Contexts-1" href="Contexts.html#Contexts">2.1 Contexts</a> </li>
<li><a name="toc-Engravers-and-Performers-1" href="Engravers-and-Performers.html#Engravers-and-Performers">2.2 Engravers and Performers</a> </li>
<li><a name="toc-Tunable-context-properties-1" href="Tunable-context-properties.html#Tunable-context-properties">2.3 Tunable context properties</a> </li>
<li><a name="toc-Internal-context-properties-1" href="Internal-context-properties.html#Internal-context-properties">2.4 Internal context properties</a> </li>
</ul>
</li>
<li><a name="toc-Backend-1" href="Backend.html#Backend">3. Backend</a>
<ul class="toc">
<li><a name="toc-All-layout-objects-1" href="All-layout-objects.html#All-layout-objects">3.1 All layout objects</a> </li>
<li><a name="toc-Graphical-Object-Interfaces-1" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">3.2 Graphical Object Interfaces</a> </li>
<li><a name="toc-User-backend-properties-1" href="User-backend-properties.html#User-backend-properties">3.3 User backend properties</a> </li>
<li><a name="toc-Internal-backend-properties-1" href="Internal-backend-properties.html#Internal-backend-properties">3.4 Internal backend properties</a> </li>
</ul>
</li>
<li><a name="toc-Scheme-functions-1" href="Scheme-functions.html#Scheme-functions">4. Scheme functions</a> </li>
<li><a name="toc-Indices-1" href="Indices.html#Indices">A. Indices</a>
<ul class="toc">
<li><a name="toc-Concept-index" href="Indices.html#Indices">A.1 Concept index</a> </li>
<li><a name="toc-Function-index" href="Indices.html#Indices">A.2 Function index</a> </li>
</ul>
</li>
</ul>
</div>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ffe16b32b9f5eec0add70c0a6bc8cec8
>
files
>
5125
