The <tuplet> element

Parent element: <notations>

A <tuplet> element is present when a tuplet is to be displayed graphically, in addition to the sound data provided by the <time-modification> elements.

Whereas a <time-modification> element shows how the cumulative, sounding effect of tuplets and double-note tremolos compare to the written note type, the <tuplet> element describes how this is displayed. The <tuplet> element also provides more detailed representation information than the <time-modification> element, and is needed to represent nested tuplets and other complex tuplets accurately.

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

Hierarchy

  • Tuplet

Implements

Constructors

Properties

attributes: TupletAttributes
contents: TupletContents
schema: {
    attributes: {
        bracket: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-shape: {
            type: "optional";
            value: {
                choices: readonly ["straight", "curved"];
                type: "choices";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 16;
                min: 1;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        show-number: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        show-type: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        type: {
            type: "optional";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof TupletActual;
    }, {
        type: "optional";
        value: typeof TupletNormal;
    }];
    name: "tuplet";
} = Tuplet.schema

Type declaration

  • Readonly attributes: {
        bracket: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-shape: {
            type: "optional";
            value: {
                choices: readonly ["straight", "curved"];
                type: "choices";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 16;
                min: 1;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        show-number: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        show-type: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        type: {
            type: "optional";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    }
    • Readonly bracket: {
          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 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 id: {
          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 line-shape: {
          type: "optional";
          value: {
              choices: readonly ["straight", "curved"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["straight", "curved"];
            type: "choices";
        }
        • Readonly choices: readonly ["straight", "curved"]
        • Readonly type: "choices"
    • Readonly number: {
          type: "optional";
          value: {
              max: 16;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 16;
            min: 1;
            type: "int";
        }
        • Readonly max: 16
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly placement: {
          type: "optional";
          value: {
              choices: readonly ["above", "below"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["above", "below"];
            type: "choices";
        }
        • Readonly choices: readonly ["above", "below"]
        • Readonly type: "choices"
    • Readonly relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-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 relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-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 show-number: {
          type: "optional";
          value: {
              choices: readonly ["none", "actual", "both"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "actual", "both"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "actual", "both"]
        • Readonly type: "choices"
    • Readonly show-type: {
          type: "optional";
          value: {
              choices: readonly ["none", "actual", "both"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "actual", "both"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "actual", "both"]
        • Readonly type: "choices"
    • Readonly type: {
          type: "optional";
          value: {
              choices: readonly ["start", "stop"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        }
        • Readonly choices: readonly ["start", "stop"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        type: "optional";
        value: typeof TupletActual;
    }, {
        type: "optional";
        value: typeof TupletNormal;
    }]
  • Readonly name: "tuplet"
schema: {
    attributes: {
        bracket: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-shape: {
            type: "optional";
            value: {
                choices: readonly ["straight", "curved"];
                type: "choices";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 16;
                min: 1;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        show-number: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        show-type: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        type: {
            type: "optional";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof TupletActual;
    }, {
        type: "optional";
        value: typeof TupletNormal;
    }];
    name: "tuplet";
} = ...

Type declaration

  • Readonly attributes: {
        bracket: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-shape: {
            type: "optional";
            value: {
                choices: readonly ["straight", "curved"];
                type: "choices";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 16;
                min: 1;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        show-number: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        show-type: {
            type: "optional";
            value: {
                choices: readonly ["none", "actual", "both"];
                type: "choices";
            };
        };
        type: {
            type: "optional";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    }
    • Readonly bracket: {
          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 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 id: {
          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 line-shape: {
          type: "optional";
          value: {
              choices: readonly ["straight", "curved"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["straight", "curved"];
            type: "choices";
        }
        • Readonly choices: readonly ["straight", "curved"]
        • Readonly type: "choices"
    • Readonly number: {
          type: "optional";
          value: {
              max: 16;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 16;
            min: 1;
            type: "int";
        }
        • Readonly max: 16
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly placement: {
          type: "optional";
          value: {
              choices: readonly ["above", "below"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["above", "below"];
            type: "choices";
        }
        • Readonly choices: readonly ["above", "below"]
        • Readonly type: "choices"
    • Readonly relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-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 relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-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 show-number: {
          type: "optional";
          value: {
              choices: readonly ["none", "actual", "both"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "actual", "both"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "actual", "both"]
        • Readonly type: "choices"
    • Readonly show-type: {
          type: "optional";
          value: {
              choices: readonly ["none", "actual", "both"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "actual", "both"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "actual", "both"]
        • Readonly type: "choices"
    • Readonly type: {
          type: "optional";
          value: {
              choices: readonly ["start", "stop"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        }
        • Readonly choices: readonly ["start", "stop"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        type: "optional";
        value: typeof TupletActual;
    }, {
        type: "optional";
        value: typeof TupletNormal;
    }]
  • Readonly name: "tuplet"

Methods

Generated using TypeDoc