Type alias LyricAttributes

LyricAttributes: {
    color: string | null;
    default-x: number | null;
    default-y: number | null;
    id: string | null;
    justify: "left" | "center" | "right" | null;
    name: string | null;
    number: string | null;
    placement: "above" | "below" | null;
    print-object: "yes" | "no" | null;
    relative-x: number | null;
    relative-y: number | null;
    time-only: string | null;
}

Type declaration

  • color: string | null

    Indicates the color of an element.

  • default-x: number | null

    Changes the computation of the default horizontal position. If the parent is a <notehead-text> element, the origin is changed relative to the left-hand side of the note or the musical position within the bar. Otherwise, the origin is changed relative to the start of the first measure on the system, and these values are used when the current measure or a succeeding measure starts a new system. Positive x is right and negative x is left.

  • default-y: number | null

    Changes the computation of the default vertical position. The origin is changed relative to the top line of the staff. Positive y is up and negative y is down.

  • id: string | null

    Specifies an ID that is unique to the entire document.

  • justify: "left" | "center" | "right" | null

    Indicates left, center, or right justification. The default value varies for different elements. For elements where the justify attribute is present but the halign attribute is not, the justify attribute indicates horizontal alignment as well as justification.

  • name: string | null

    Indicates the name of the lyric type. Common examples are verse and chorus.

  • number: string | null

    Specifies the lyric line when multiple lines are present.

  • placement: "above" | "below" | null

    Indicates whether something is above or below another element, such as a note or a notation.

  • print-object: "yes" | "no" | null

    Specifies whether or not to print an object. It is yes if not specified.

  • relative-x: number | null

    Changes the horizontal position relative to the default position, either as computed by the individual program, or as overridden by the default-x attribute. Positive x is right and negative x is left.

  • relative-y: number | null

    Changes the vertical position relative to the default position, either as computed by the individual program, or as overridden by the default-y attribute. Positive y is up and negative y is down.

  • time-only: string | null

    Specifies which lyrics are to be sung which times through a repeated section.

Settings

Theme

Generated using TypeDoc