Class Notehead

The <notehead> element

Parent element: <note>

The <notehead> element indicates shapes other than the open and closed ovals associated with note durations.

The smufl attribute can be used to specify a particular notehead, allowing application interoperability without requiring every Standard Music Font Layout (SMuFL) glyph to have a MusicXML element equivalent. This attribute can be used either with the other value, or to refine a specific notehead value such as cluster.

Noteheads in the SMuFL Note name noteheads and Note name noteheads supplement ranges (U+E150–U+E1AF and U+EEE0–U+EEFF) should not use the smufl attribute or the other value, but instead use the <notehead-text> element.

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

Hierarchy

  • Notehead

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getColor getFilled getFontFamily getFontSize getFontStyle getFontWeight getNoteheadValue getParentheses getSmufl setColor setFilled setFontFamily setFontSize setFontStyle setFontWeight setNoteheadValue setParentheses setSmufl

Constructors

constructor

Properties

attributes

attributes: NoteheadAttributes

contents

contents: NoteheadContents

Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        filled: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                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";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        smufl: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "notehead-value";
            type: "label";
            value: {
                choices: readonly ["other", "arrow down", "arrow up", "back slashed", "circle dot", "circle-x", "circled", "cluster", "cross", "diamond", "do", "fa", "fa up", "inverted triangle", "la", "left triangle", "mi", "none", "normal", "re", "rectangle", "slash", "slashed", "so", "square", "ti", "triangle", "x"];
                type: "choices";
            };
        };
    }];
    name: "notehead";
} = Notehead.schema

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        filled: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                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";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        smufl: {
            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 filled: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • 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 parentheses: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly smufl: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "notehead-value";
            type: "label";
            value: {
                choices: readonly ["other", "arrow down", "arrow up", "back slashed", "circle dot", "circle-x", "circled", "cluster", "cross", "diamond", "do", "fa", "fa up", "inverted triangle", "la", "left triangle", "mi", "none", "normal", "re", "rectangle", "slash", "slashed", "so", "square", "ti", "triangle", "x"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "notehead"

Static Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        filled: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                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";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        smufl: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "notehead-value";
            type: "label";
            value: {
                choices: readonly ["other", "arrow down", "arrow up", "back slashed", "circle dot", "circle-x", "circled", "cluster", "cross", "diamond", "do", "fa", "fa up", "inverted triangle", "la", "left triangle", "mi", "none", "normal", "re", "rectangle", "slash", "slashed", "so", "square", "ti", "triangle", "x"];
                type: "choices";
            };
        };
    }];
    name: "notehead";
} = ...

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        filled: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                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";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        smufl: {
            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 filled: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • 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 parentheses: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly smufl: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "notehead-value";
            type: "label";
            value: {
                choices: readonly ["other", "arrow down", "arrow up", "back slashed", "circle dot", "circle-x", "circled", "cluster", "cross", "diamond", "do", "fa", "fa up", "inverted triangle", "la", "left triangle", "mi", "none", "normal", "re", "rectangle", "slash", "slashed", "so", "square", "ti", "triangle", "x"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "notehead"

Methods

getColor

getFilled

getFontFamily

getFontSize

  • Gets

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

getFontStyle

getFontWeight

getNoteheadValue

  • Gets

    Returns "none" | "other" | "normal" | "rectangle" | "square" | "triangle" | "diamond" | "slash" | "arrow down" | "arrow up" | "back slashed" | "circle dot" | "circle-x" | "circled" | "cluster" | "cross" | "do" | "fa" | "fa up" | "inverted triangle" | "la" | "left triangle" | "mi" | "re" | "slashed" | "so" | "ti" | "x"

getParentheses

getSmufl

setColor

setFilled

setFontFamily

setFontSize

setFontStyle

setFontWeight

setNoteheadValue

  • Sets

    Parameters

    • noteheadValue: "none" | "other" | "normal" | "rectangle" | "square" | "triangle" | "diamond" | "slash" | "arrow down" | "arrow up" | "back slashed" | "circle dot" | "circle-x" | "circled" | "cluster" | "cross" | "do" | "fa" | "fa up" | "inverted triangle" | "la" | "left triangle" | "mi" | "re" | "slashed" | "so" | "ti" | "x"

    Returns Notehead

setParentheses

setSmufl

Settings

Theme

On This Page

Generated using TypeDoc