diff --git a/packages/core/pianoroll.mjs b/packages/core/pianoroll.mjs index 60cab07c..c10460a4 100644 --- a/packages/core/pianoroll.mjs +++ b/packages/core/pianoroll.mjs @@ -62,30 +62,30 @@ Pattern.prototype.pianoroll = function (options = {}) { * * @name pianoroll * @param {Object} options Object containing all the optional following parameters as key value pairs: - * @param {integer} cycles defaults to 4 - number of cycles to be displayed at the same time - * @param {number} playhead 0 to 1, defaults to 0.5 - location of the active notes on the time axis - * @param {integer} vertical 0 (default) or 1 - displays the roll vertically - * @param {boolean} labels false (default) or true - displays labels on individual notes (see the label function) - * @param {integer} flipTime 0 (default) or 1 - reverse the direction of the roll - * @param {integer} flipValues 0 (default) or 1 - reverse the relative location of notes on the value axis - * @param {number} overscan 1 (default) - lookup X cycles outside of the cycles window to display notes in advance - * @param {boolean} hideNegative false (default) or true - hide notes with negative time (before starting playing the pattern) - * @param {integer} smear 0 (default) or 1 - notes leave a solid trace - * @param {integer} fold 0 (default) or 1 - notes takes the full value axis width - * @param {string} active hexadecimal or CSS color (defaults to #FFCA28) - color of the active notes - * @param {string} inactive hexadecimal or CSS color (defaults to #7491D2) - color of the inactive notes - * @param {string} background hexadecimal or CSS color (defaults to transparent) - color of the background - * @param {string} playheadColor hexadecimal or CSS color (defaults to transparent) - color of the line representing the play head - * @param {integer} fill 1 (default) or 0 - notes are filled with color (otherwise only the label is displayed) - * @param {boolean} fillActive false (default) or true - active notes are filled with color - * @param {integer} stroke 0 (default) or 1 - notes are shown with colored borders - * @param {boolean} strokeActive false (default) or true - active notes are shown with colored borders - * @param {integer} hideInactive 0 (default) or 1 - only active notes are shown - * @param {integer} colorizeInactive 1 (default) or 0 - use note color for inactive notes - * @param {string} fontFamily defaults to 'monospace' - define the font used by notes labels - * @param {integer} minMidi integer, defaults to 10 - minimum note value to display on the value axis - * @param {integer} maxMidi integer, defaults to 90 - maximum note value to display on the value axis - * @param {integer} autorange 0 (default) or 1 - automatically calculate the minMidi and maxMidi parameters + * @param {integer} cycles number of cycles to be displayed at the same time - defaults to 4 + * @param {number} playhead location of the active notes on the time axis - 0 to 1, defaults to 0.5 + * @param {boolean} vertical displays the roll vertically - 0 by default + * @param {boolean} labels displays labels on individual notes (see the label function) - 0 by default + * @param {boolean} flipTime reverse the direction of the roll - 0 by default + * @param {boolean} flipValues reverse the relative location of notes on the value axis - 0 by default + * @param {number} overscan lookup X cycles outside of the cycles window to display notes in advance - 1 by default + * @param {boolean} hideNegative hide notes with negative time (before starting playing the pattern) - 0 by default + * @param {boolean} smear notes leave a solid trace - 0 by default + * @param {boolean} fold notes takes the full value axis width - 0 by default + * @param {string} active hexadecimal or CSS color of the active notes - defaults to #FFCA28 + * @param {string} inactive hexadecimal or CSS color of the inactive notes - defaults to #7491D2 + * @param {string} background hexadecimal or CSS color of the background - defaults to transparent + * @param {string} playheadColor hexadecimal or CSS color of the line representing the play head - defaults to white + * @param {boolean} fill notes are filled with color (otherwise only the label is displayed) - 0 by default + * @param {boolean} fillActive active notes are filled with color - 0 by default + * @param {boolean} stroke notes are shown with colored borders - 0 by default + * @param {boolean} strokeActive active notes are shown with colored borders - 0 by default + * @param {boolean} hideInactive only active notes are shown - 0 by default + * @param {boolean} colorizeInactive use note color for inactive notes - 1 by default + * @param {string} fontFamily define the font used by notes labels - defaults to 'monospace' + * @param {integer} minMidi minimum note value to display on the value axis - defaults to 10 + * @param {integer} maxMidi maximum note value to display on the value axis - defaults to 90 + * @param {boolean} autorange automatically calculate the minMidi and maxMidi parameters - 0 by default * * @example * note("C2 A2 G2").euclid(5,8).s('piano').clip(1).color('salmon').pianoroll({vertical:1, labels:1})