Class Harmony

The <harmony> element

Parent elements: <measure> (partwise), <part> (timewise)

The <harmony> element represents harmony analysis, including chord symbols in popular music as well as functional harmony analysis in classical music.

The print-object attribute controls whether or not anything is printed due to the <harmony> element. The print suggestion attributes set the defaults for the harmony, but individual elements can override this with their own values.

A <harmony> element can contain many stacked chords (e.g. V of II). Each individual chord including a required <kind> element is referred to as a harmony-chord. Stacked chords or secondary functions are represented using a sequence of harmony-chords. For example, V of II would be represented by a harmony-chord with a 5 numeral followed by a harmony-chord with a 2 numeral.

A <root> is a pitch name like C, D, E, while a <numeral> is a scale degree like 1, 2, 3. The <root> element is generally used with pop chord symbols, while the <numeral> element is generally used with classical functional harmony and Nashville numbers. It is an either/or choice to avoid data inconsistency. The <function> element, which represents Roman numerals with roman numeral text, has been deprecated as of MusicXML 4.0.

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

Hierarchy

Harmony

Implements

XMLElement<"harmony", HarmonyAttributes, HarmonyContents>

Constructors

constructor

new Harmony(opts?): Harmony
Parameters
- Optional opts: {
  attributes?: Partial<HarmonyAttributes>;
  contents?: HarmonyContents;
  }
  - Optional attributes?: Partial<HarmonyAttributes>
  - Optional contents?: HarmonyContents
Returns Harmony
- Defined in generated/elements.ts:56244

Properties

attributes

attributes: HarmonyAttributes

contents: HarmonyContents

`Readonly` schema

schema: {
    attributes: {
        arrangement: {
            type: "optional";
            value: {
                choices: readonly ["horizontal", "vertical", "diagonal"];
                type: "choices";
            };
        };
        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";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        print-frame: {
            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";
                };
            };
        };
        system: {
            type: "optional";
            value: {
                choices: readonly ["none", "only-top", "also-top"];
                type: "choices";
            };
        };
        type: {
            type: "optional";
            value: {
                choices: readonly ["alternate", "explicit", "implied"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "values";
        type: "label";
        value: {
            type: "oneOrMore";
            value: readonly [{
                choices: readonly [typeof Root, typeof Numeral, typeof Function];
                type: "choices";
            }, {
                type: "required";
                value: typeof Kind;
            }, {
                type: "optional";
                value: typeof Inversion;
            }, {
                type: "optional";
                value: typeof Bass;
            }, {
                type: "zeroOrMore";
                value: typeof Degree;
            }];
        };
    }, {
        type: "optional";
        value: typeof Frame;
    }, {
        type: "optional";
        value: typeof Offset;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Staff;
    }];
    name: "harmony";
} = Harmony.schema

Type declaration

Readonly attributes: {
    arrangement: {
        type: "optional";
        value: {
            choices: readonly ["horizontal", "vertical", "diagonal"];
            type: "choices";
        };
    };
    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";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    placement: {
        type: "optional";
        value: {
            choices: readonly ["above", "below"];
            type: "choices";
        };
    };
    print-frame: {
        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";
            };
        };
    };
    system: {
        type: "optional";
        value: {
            choices: readonly ["none", "only-top", "also-top"];
            type: "choices";
        };
    };
    type: {
        type: "optional";
        value: {
            choices: readonly ["alternate", "explicit", "implied"];
            type: "choices";
        };
    };
}
- Readonly arrangement: {
      type: "optional";
      value: {
          choices: readonly ["horizontal", "vertical", "diagonal"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["horizontal", "vertical", "diagonal"];
    type: "choices";
    }
    - Readonly choices: readonly ["horizontal", "vertical", "diagonal"]
    - Readonly 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 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 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 print-frame: {
      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 system: {
      type: "optional";
      value: {
          choices: readonly ["none", "only-top", "also-top"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "only-top", "also-top"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "only-top", "also-top"]
    - Readonly type: "choices"
- Readonly type: {
      type: "optional";
      value: {
          choices: readonly ["alternate", "explicit", "implied"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["alternate", "explicit", "implied"];
    type: "choices";
    }
    - Readonly choices: readonly ["alternate", "explicit", "implied"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "values";
    type: "label";
    value: {
        type: "oneOrMore";
        value: readonly [{
            choices: readonly [typeof Root, typeof Numeral, typeof Function];
            type: "choices";
        }, {
            type: "required";
            value: typeof Kind;
        }, {
            type: "optional";
            value: typeof Inversion;
        }, {
            type: "optional";
            value: typeof Bass;
        }, {
            type: "zeroOrMore";
            value: typeof Degree;
        }];
    };
}, {
    type: "optional";
    value: typeof Frame;
}, {
    type: "optional";
    value: typeof Offset;
}, {
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}, {
    type: "optional";
    value: typeof Staff;
}]
Readonly name: "harmony"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    arrangement: {
        type: "optional";
        value: {
            choices: readonly ["horizontal", "vertical", "diagonal"];
            type: "choices";
        };
    };
    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";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    placement: {
        type: "optional";
        value: {
            choices: readonly ["above", "below"];
            type: "choices";
        };
    };
    print-frame: {
        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";
            };
        };
    };
    system: {
        type: "optional";
        value: {
            choices: readonly ["none", "only-top", "also-top"];
            type: "choices";
        };
    };
    type: {
        type: "optional";
        value: {
            choices: readonly ["alternate", "explicit", "implied"];
            type: "choices";
        };
    };
}
- Readonly arrangement: {
      type: "optional";
      value: {
          choices: readonly ["horizontal", "vertical", "diagonal"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["horizontal", "vertical", "diagonal"];
    type: "choices";
    }
    - Readonly choices: readonly ["horizontal", "vertical", "diagonal"]
    - Readonly 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 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 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 print-frame: {
      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 system: {
      type: "optional";
      value: {
          choices: readonly ["none", "only-top", "also-top"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "only-top", "also-top"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "only-top", "also-top"]
    - Readonly type: "choices"
- Readonly type: {
      type: "optional";
      value: {
          choices: readonly ["alternate", "explicit", "implied"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["alternate", "explicit", "implied"];
    type: "choices";
    }
    - Readonly choices: readonly ["alternate", "explicit", "implied"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "values";
    type: "label";
    value: {
        type: "oneOrMore";
        value: readonly [{
            choices: readonly [typeof Root, typeof Numeral, typeof Function];
            type: "choices";
        }, {
            type: "required";
            value: typeof Kind;
        }, {
            type: "optional";
            value: typeof Inversion;
        }, {
            type: "optional";
            value: typeof Bass;
        }, {
            type: "zeroOrMore";
            value: typeof Degree;
        }];
    };
}, {
    type: "optional";
    value: typeof Frame;
}, {
    type: "optional";
    value: typeof Offset;
}, {
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}, {
    type: "optional";
    value: typeof Staff;
}]
Readonly name: "harmony"

Methods

getArrangement

getArrangement(): null | "diagonal" | "horizontal" | "vertical"
Gets

Returns null | "diagonal" | "horizontal" | "vertical"
- Defined in generated/elements.ts:56249

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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:56294

getFontStyle

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

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

getFontWeight

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

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

getFootnote

getFootnote(): null | Footnote
Gets

Returns null | Footnote
- Defined in generated/elements.ts:56422

getFrame

getFrame(): null | Frame
Gets

Returns null | Frame
- Defined in generated/elements.ts:56404

getId

getId(): null | string
Gets

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

getLevel

getLevel(): null | Level
Gets

Returns null | Level
- Defined in generated/elements.ts:56431

getOffset

getOffset(): null | Offset
Gets

Returns null | Offset
- Defined in generated/elements.ts:56413

getPlacement

getPlacement(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:56332

getPrintFrame

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

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

getPrintObject

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getStaff

getStaff(): null | Staff
Gets

Returns null | Staff
- Defined in generated/elements.ts:56440

getSystem

getSystem(): null | "none" | "only-top" | "also-top"
Gets

Returns null | "none" | "only-top" | "also-top"
- Defined in generated/elements.ts:56377

getType

getType(): null | "alternate" | "explicit" | "implied"
Gets

Returns null | "alternate" | "explicit" | "implied"
- Defined in generated/elements.ts:56386

getValues

getValues(): [Root | Numeral | Function, Kind, null | Inversion, null | Bass, Degree[]][]
Gets

Returns [Root | Numeral | Function, Kind, null | Inversion, null | Bass, Degree[]][]
- Defined in generated/elements.ts:56395

setArrangement

setArrangement(arrangement): Harmony
Sets
Parameters
- arrangement: null | "diagonal" | "horizontal" | "vertical"
Returns Harmony
- Defined in generated/elements.ts:56253

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setFootnote

setFootnote(footnote): Harmony
Sets
Parameters
- footnote: null | Footnote
Returns Harmony
- Defined in generated/elements.ts:56426

setFrame

setFrame(frame): Harmony
Sets
Parameters
- frame: null | Frame
Returns Harmony
- Defined in generated/elements.ts:56408

setId

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

setLevel

setLevel(level): Harmony
Sets
Parameters
- level: null | Level
Returns Harmony
- Defined in generated/elements.ts:56435

setOffset

setOffset(offset): Harmony
Sets
Parameters
- offset: null | Offset
Returns Harmony
- Defined in generated/elements.ts:56417

setPlacement

setPlacement(placement): Harmony
Sets
Parameters
- placement: null | "above" | "below"
Returns Harmony
- Defined in generated/elements.ts:56336

setPrintFrame

setPrintFrame(printFrame): Harmony
Sets
Parameters
- printFrame: null | "yes" | "no"
Returns Harmony
- Defined in generated/elements.ts:56345

setPrintObject

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

setRelativeX

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

setRelativeY

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

setStaff

setStaff(staff): Harmony
Sets
Parameters
- staff: null | Staff
Returns Harmony
- Defined in generated/elements.ts:56444

setSystem

setSystem(system): Harmony
Sets
Parameters
- system: null | "none" | "only-top" | "also-top"
Returns Harmony
- Defined in generated/elements.ts:56381

setType

setType(type): Harmony
Sets
Parameters
- type: null | "alternate" | "explicit" | "implied"
Returns Harmony
- Defined in generated/elements.ts:56390

setValues

setValues(values): Harmony
Sets
Parameters
- values: [Root | Numeral | Function, Kind, null | Inversion, null | Bass, Degree[]][]
Returns Harmony
- Defined in generated/elements.ts:56399

Class Harmony

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<HarmonyAttributes>; contents?: HarmonyContents; }

Optional attributes?: Partial<HarmonyAttributes>

Optional contents?: HarmonyContents

Returns Harmony

Properties

attributes

contents

Readonly schema

Type declaration

Readonly arrangement: { type: "optional"; value: { choices: readonly ["horizontal", "vertical", "diagonal"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["horizontal", "vertical", "diagonal"]; type: "choices"; }

Readonly choices: readonly ["horizontal", "vertical", "diagonal"]

Readonly 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 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 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"

`Optional` opts: {
attributes?: Partial<HarmonyAttributes>;
contents?: HarmonyContents;
}

`Optional` attributes?: Partial<HarmonyAttributes>

`Optional` contents?: HarmonyContents

`Readonly` schema

`Readonly` arrangement: {
type: "optional";
value: {
choices: readonly ["horizontal", "vertical", "diagonal"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["horizontal", "vertical", "diagonal"];
type: "choices";
}

`Readonly` choices: readonly ["horizontal", "vertical", "diagonal"]

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