tonal-roman-numeral

RomanNumeral

tonal-roman-numeral is a collection of functions to query about tonal keys.

This is part of tonal music theory library.

Example

// es6
import * as RomanNumeral from "tonal-roman-numeral";
// es5
const RomanNumeral = require("tonal-roman-numeral");

Example

RomanNumeral.names(); // => ["I", "II", "III", "IV", "V", "VI", "VII"]
RomanNumeral.props("ii7"); // => { name: 'ii', type: '7', num: 2, major: false }
RomanNumeral.degree(2); // => "II"
RomanNumeral.degree(2, false); // => "ii"

• RomanNumeral
  • .props() ⇒ Object
  • .names([isMajor]) ⇒ Array.<String>
  • .name(name) ⇒ String
  • .type(name) ⇒ String
  • .decimal(name) ⇒ number
  • .fromDegree(degree, [isMajor]) ⇒ String

RomanNumeral.props() ⇒ Object

Get properties of a roman numeral string

Kind: static method of RomanNumeral
Returns: Object - - the roman numeral properties

Type	Description
String	the roman numeral string (can have type, like: Imaj7)

Example

props("VIIb5"); // => { name: "VII", type: "b5", num: 7, major: true }

RomanNumeral.names([isMajor]) ⇒ Array.<String>

Get roman numeral names

Kind: static method of RomanNumeral

Param	Type	Default
[isMajor]	boolean	true

Example

names(); // => ["I", "II", "III", "IV", "V", "VI", "VII"]
names(false); // => ["i", "ii", "iii", "iv", "v", "vi", "vii"]

RomanNumeral.name(name) ⇒ String

Get roman numeral name of a string or null if not valid roman numeral

Kind: static method of RomanNumeral

Param	Type
name	String

Example

name("IIb7"); // => 'II
name("iii"); // => 'iii'
name("Ii"); // => null (mixed case not allowed)

RomanNumeral.type(name) ⇒ String

Get type of a roman numeral

Kind: static method of RomanNumeral

Param	Type
name	String

Example

type("Imaj7"); // => 'maj7'

RomanNumeral.decimal(name) ⇒ number

Get roman numeral number in decimal integer (it accepts numbers from 1 to 7)

Kind: static method of RomanNumeral

Param	Type	Description
name	string | number	roman numeral name (with optional type)

Example

decimal("IVmaj7"); // => 4
decimal(4); // => 4
decimal(10); // => null

RomanNumeral.fromDegree(degree, [isMajor]) ⇒ String

Get a roman numeral from a degree number

Kind: static method of RomanNumeral
Returns: String - the roman numeral

Param	Type	Default
degree	number
[isMajor]	boolean	true

Example

fromDegree(2); // => "II"
fromDegree(2, false); // => "ii"