Class Metronome

The <metronome> element

Parent element: <direction-type>

The <metronome> element represents metronome marks and other metric relationships. The <beat-unit> element group and <per-minute> element specify regular metronome marks. The <metronome-note> and <metronome-relation> elements allow for the specification of metric modulations and other metric relationships, such as swing tempo marks where two eighths are equated to a quarter note / eighth note triplet. Tied notes can be represented in both types of metronome marks by using the <beat-unit-tied> and <metronome-tied> elements. The print-object attribute is set to no in cases where the <metronome> element represents a relationship or range that is not displayed in the music notation.

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

Hierarchy

Metronome

Implements

XMLElement<"metronome", MetronomeAttributes, MetronomeContents>

Constructors

constructor

new Metronome(opts?): Metronome
Parameters
- Optional opts: {
  attributes?: Partial<MetronomeAttributes>;
  contents?: MetronomeContents;
  }
  - Optional attributes?: Partial<MetronomeAttributes>
  - Optional contents?: MetronomeContents
Returns Metronome
- Defined in generated/elements.ts:40415

Properties

attributes

attributes: MetronomeAttributes

contents: MetronomeContents

`Readonly` schema

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";
                };
            };
        };
        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";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        justify: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                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";
                };
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "metronome";
        type: "label";
        value: {
            choices: readonly [{
                label: "beat-spec";
                type: "label";
                value: readonly [{
                    type: "required";
                    value: typeof BeatUnit;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitDot;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitTied;
                }, {
                    choices: readonly [typeof PerMinute, readonly [{
                        type: "required";
                        value: typeof BeatUnit;
                    }, {
                        type: "zeroOrMore";
                        value: typeof BeatUnitDot;
                    }, {
                        type: "zeroOrMore";
                        value: typeof BeatUnitTied;
                    }]];
                    type: "choices";
                }];
            }, {
                label: "metronome-spec";
                type: "label";
                value: readonly [{
                    type: "optional";
                    value: typeof MetronomeArrows;
                }, {
                    type: "oneOrMore";
                    value: typeof MetronomeNote;
                }, {
                    type: "optional";
                    value: readonly [{
                        type: "required";
                        value: typeof MetronomeRelation;
                    }, {
                        type: "oneOrMore";
                        value: typeof MetronomeNote;
                    }];
                }];
            }];
            type: "choices";
        };
    }];
    name: "metronome";
} = Metronome.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";
            };
        };
    };
    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";
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    justify: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    parentheses: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    print-object: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            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";
            };
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        };
    };
}
- 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 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 halign: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - Readonly type: "choices"
- 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 justify: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - 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 print-object: {
      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 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 valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom", "baseline"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom", "baseline"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "metronome";
    type: "label";
    value: {
        choices: readonly [{
            label: "beat-spec";
            type: "label";
            value: readonly [{
                type: "required";
                value: typeof BeatUnit;
            }, {
                type: "zeroOrMore";
                value: typeof BeatUnitDot;
            }, {
                type: "zeroOrMore";
                value: typeof BeatUnitTied;
            }, {
                choices: readonly [typeof PerMinute, readonly [{
                    type: "required";
                    value: typeof BeatUnit;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitDot;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitTied;
                }]];
                type: "choices";
            }];
        }, {
            label: "metronome-spec";
            type: "label";
            value: readonly [{
                type: "optional";
                value: typeof MetronomeArrows;
            }, {
                type: "oneOrMore";
                value: typeof MetronomeNote;
            }, {
                type: "optional";
                value: readonly [{
                    type: "required";
                    value: typeof MetronomeRelation;
                }, {
                    type: "oneOrMore";
                    value: typeof MetronomeNote;
                }];
            }];
        }];
        type: "choices";
    };
}]
Readonly name: "metronome"

`Static` `Readonly` 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";
            };
        };
    };
    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";
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    justify: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    parentheses: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    print-object: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            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";
            };
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        };
    };
}
- 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 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 halign: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - Readonly type: "choices"
- 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 justify: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - 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 print-object: {
      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 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 valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom", "baseline"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom", "baseline"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "metronome";
    type: "label";
    value: {
        choices: readonly [{
            label: "beat-spec";
            type: "label";
            value: readonly [{
                type: "required";
                value: typeof BeatUnit;
            }, {
                type: "zeroOrMore";
                value: typeof BeatUnitDot;
            }, {
                type: "zeroOrMore";
                value: typeof BeatUnitTied;
            }, {
                choices: readonly [typeof PerMinute, readonly [{
                    type: "required";
                    value: typeof BeatUnit;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitDot;
                }, {
                    type: "zeroOrMore";
                    value: typeof BeatUnitTied;
                }]];
                type: "choices";
            }];
        }, {
            label: "metronome-spec";
            type: "label";
            value: readonly [{
                type: "optional";
                value: typeof MetronomeArrows;
            }, {
                type: "oneOrMore";
                value: typeof MetronomeNote;
            }, {
                type: "optional";
                value: readonly [{
                    type: "required";
                    value: typeof MetronomeRelation;
                }, {
                    type: "oneOrMore";
                    value: typeof MetronomeNote;
                }];
            }];
        }];
        type: "choices";
    };
}]
Readonly name: "metronome"

Methods

getColor

getColor(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:40420

getDefaultX

getDefaultX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:40429

getDefaultY

getDefaultY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:40438

getFontFamily

getFontFamily(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:40447

getFontSize

getFontSize(): null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Gets

Returns null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
- Defined in generated/elements.ts:40456

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:40467

getFontWeight

getFontWeight(): null | "bold" | "normal"
Gets

Returns null | "bold" | "normal"
- Defined in generated/elements.ts:40476

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:40485

getId

getId(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:40494

getJustify

getJustify(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:40503

getMetronome

getMetronome(): BeatSpec | MetronomeSpec
Gets

Returns BeatSpec | MetronomeSpec
- Defined in generated/elements.ts:40557

getParentheses

getParentheses(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:40512

getPrintObject

getPrintObject(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:40521

getRelativeX

getRelativeX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:40530

getRelativeY

getRelativeY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:40539

getValign

getValign(): null | "top" | "middle" | "bottom" | "baseline"
Gets

Returns null | "top" | "middle" | "bottom" | "baseline"
- Defined in generated/elements.ts:40548

setColor

setColor(color): Metronome
Sets
Parameters
- color: null | string
Returns Metronome
- Defined in generated/elements.ts:40424

setDefaultX

setDefaultX(defaultX): Metronome
Sets
Parameters
- defaultX: null | number
Returns Metronome
- Defined in generated/elements.ts:40433

setDefaultY

setDefaultY(defaultY): Metronome
Sets
Parameters
- defaultY: null | number
Returns Metronome
- Defined in generated/elements.ts:40442

setFontFamily

setFontFamily(fontFamily): Metronome
Sets
Parameters
- fontFamily: null | string
Returns Metronome
- Defined in generated/elements.ts:40451

setFontSize

setFontSize(fontSize): Metronome
Sets
Parameters
- fontSize: null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Returns Metronome
- Defined in generated/elements.ts:40460

setFontStyle

setFontStyle(fontStyle): Metronome
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns Metronome
- Defined in generated/elements.ts:40471

setFontWeight

setFontWeight(fontWeight): Metronome
Sets
Parameters
- fontWeight: null | "bold" | "normal"
Returns Metronome
- Defined in generated/elements.ts:40480

setHalign

setHalign(halign): Metronome
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns Metronome
- Defined in generated/elements.ts:40489

setId

setId(id): Metronome
Sets
Parameters
- id: null | string
Returns Metronome
- Defined in generated/elements.ts:40498

setJustify

setJustify(justify): Metronome
Sets
Parameters
- justify: null | "left" | "center" | "right"
Returns Metronome
- Defined in generated/elements.ts:40507

setMetronome

setMetronome(metronome): Metronome
Sets
Parameters
- metronome: BeatSpec | MetronomeSpec
Returns Metronome
- Defined in generated/elements.ts:40561

setParentheses

setParentheses(parentheses): Metronome
Sets
Parameters
- parentheses: null | "yes" | "no"
Returns Metronome
- Defined in generated/elements.ts:40516

setPrintObject

setPrintObject(printObject): Metronome
Sets
Parameters
- printObject: null | "yes" | "no"
Returns Metronome
- Defined in generated/elements.ts:40525

setRelativeX

setRelativeX(relativeX): Metronome
Sets
Parameters
- relativeX: null | number
Returns Metronome
- Defined in generated/elements.ts:40534

setRelativeY

setRelativeY(relativeY): Metronome
Sets
Parameters
- relativeY: null | number
Returns Metronome
- Defined in generated/elements.ts:40543

setValign

setValign(valign): Metronome
Sets
Parameters
- valign: null | "top" | "middle" | "bottom" | "baseline"
Returns Metronome
- Defined in generated/elements.ts:40552

Class Metronome

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MetronomeAttributes>; contents?: MetronomeContents; }

Optional attributes?: Partial<MetronomeAttributes>

Optional contents?: MetronomeContents

Returns Metronome

Properties

attributes

contents

Readonly schema

Type declaration

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 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 halign: { type: "optional"; value: { choices: readonly ["left", "center", "right"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["left", "center", "right"]; type: "choices"; }

Readonly choices: readonly ["left", "center", "right"]

Readonly type: "choices"

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 justify: { type: "optional"; value: { choices: readonly ["left", "center", "right"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["left", "center", "right"]; type: "choices"; }

Readonly choices: readonly ["left", "center", "right"]

Readonly type: "choices"

`Optional` opts: {
attributes?: Partial<MetronomeAttributes>;
contents?: MetronomeContents;
}

`Optional` attributes?: Partial<MetronomeAttributes>

`Optional` contents?: MetronomeContents

`Readonly` schema

`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` 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` halign: {
type: "optional";
value: {
choices: readonly ["left", "center", "right"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["left", "center", "right"];
type: "choices";
}

`Readonly` choices: readonly ["left", "center", "right"]

`Readonly` type: "choices"

`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` justify: {
type: "optional";
value: {
choices: readonly ["left", "center", "right"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["left", "center", "right"];
type: "choices";
}

`Readonly` choices: readonly ["left", "center", "right"]

`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` print-object: {
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` 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"