3.2.95 script-interface

An object that is put above or below a note.

User settable properties:

avoid-slur (symbol)

Method of handling slur collisions. Choices are inside, outside, around, and ignore. inside adjusts the slur if needed to keep the grob inside the slur. outside moves the grob vertically to the outside of the slur. around moves the grob vertically to the outside of the slur only if there is a collision. ignore does not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.), outside and around behave like ignore.

script-priority (number)

A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.

side-relative-direction (direction)

Multiply direction of direction-source with this to get the direction of this object.

slur-padding (number)

Extra distance between slur and script.

toward-stem-shift (number)

Amount by which scripts are shifted toward the stem if their direction coincides with the stem direction. 0.0 means keep the default position (centered on the note head), 1.0 means centered on the stem. Interpolated values are possible.

Internal properties:

direction-source (graphical (layout) object)

In case side-relative-direction is set, which grob to get the direction from.

positioning-done (boolean)

Used to signal that a positioning element did its job. This ensures that a positioning is only done once.

script-stencil (pair)

A pair (type . arg) which acts as an index for looking up a Stencil object.

slur (graphical (layout) object)

A pointer to a Slur object.

This grob interface is used in the following graphical object(s): AccidentalSuggestion, DynamicText and Script.

Internals Reference v2.18.2 (stable-branch).