The <text> element

Parent element: <lyric>

The <text> element represents a syllable or portion of a syllable for lyric text underlay. A hyphen in the element content should only be used for an actual hyphenated word.

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/text/

Hierarchy

  • Text

Implements

Constructors

Properties

attributes: TextAttributes
contents: TextContents
schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        dir: {
            type: "optional";
            value: {
                choices: readonly ["ltr", "rtl", "lro", "rlo"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        letter-spacing: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        rotation: {
            type: "optional";
            value: {
                max: 180;
                min: -180;
                type: "float";
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        xml:lang: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [{
        type: "string";
    }];
    name: "text";
} = Text.schema

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        dir: {
            type: "optional";
            value: {
                choices: readonly ["ltr", "rtl", "lro", "rlo"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        letter-spacing: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        rotation: {
            type: "optional";
            value: {
                max: 180;
                min: -180;
                type: "float";
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        xml:lang: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly dir: {
          type: "optional";
          value: {
              choices: readonly ["ltr", "rtl", "lro", "rlo"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["ltr", "rtl", "lro", "rlo"];
            type: "choices";
        }
        • Readonly choices: readonly ["ltr", "rtl", "lro", "rlo"]
        • Readonly type: "choices"
    • Readonly font-family: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: " ";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: " ";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: " "
    • Readonly font-size: {
          type: "optional";
          value: {
              choices: readonly [{
                  choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                  type: "choices";
              }, {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly font-style: {
          type: "optional";
          value: {
              choices: readonly ["normal", "italic"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "italic"]
        • Readonly type: "choices"
    • Readonly font-weight: {
          type: "optional";
          value: {
              choices: readonly ["normal", "bold"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "bold"]
        • Readonly type: "choices"
    • Readonly letter-spacing: {
          type: "optional";
          value: {
              choices: readonly ["normal", {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly line-through: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly overline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly rotation: {
          type: "optional";
          value: {
              max: 180;
              min: -180;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 180;
            min: -180;
            type: "float";
        }
        • Readonly max: 180
        • Readonly min: -180
        • Readonly type: "float"
    • Readonly underline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly xml:lang: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly [{
        type: "string";
    }]
  • Readonly name: "text"
schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        dir: {
            type: "optional";
            value: {
                choices: readonly ["ltr", "rtl", "lro", "rlo"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        letter-spacing: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        rotation: {
            type: "optional";
            value: {
                max: 180;
                min: -180;
                type: "float";
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        xml:lang: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [{
        type: "string";
    }];
    name: "text";
} = ...

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        dir: {
            type: "optional";
            value: {
                choices: readonly ["ltr", "rtl", "lro", "rlo"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        letter-spacing: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        rotation: {
            type: "optional";
            value: {
                max: 180;
                min: -180;
                type: "float";
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        xml:lang: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly dir: {
          type: "optional";
          value: {
              choices: readonly ["ltr", "rtl", "lro", "rlo"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["ltr", "rtl", "lro", "rlo"];
            type: "choices";
        }
        • Readonly choices: readonly ["ltr", "rtl", "lro", "rlo"]
        • Readonly type: "choices"
    • Readonly font-family: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: " ";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: " ";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: " "
    • Readonly font-size: {
          type: "optional";
          value: {
              choices: readonly [{
                  choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                  type: "choices";
              }, {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly font-style: {
          type: "optional";
          value: {
              choices: readonly ["normal", "italic"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "italic"]
        • Readonly type: "choices"
    • Readonly font-weight: {
          type: "optional";
          value: {
              choices: readonly ["normal", "bold"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "bold"]
        • Readonly type: "choices"
    • Readonly letter-spacing: {
          type: "optional";
          value: {
              choices: readonly ["normal", {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly line-through: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly overline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly rotation: {
          type: "optional";
          value: {
              max: 180;
              min: -180;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 180;
            min: -180;
            type: "float";
        }
        • Readonly max: 180
        • Readonly min: -180
        • Readonly type: "float"
    • Readonly underline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly xml:lang: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly [{
        type: "string";
    }]
  • Readonly name: "text"

Methods

  • Gets

    Returns null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"

  • Sets

    Parameters

    • fontSize: null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"

    Returns Text

Generated using TypeDoc