p5 2.2.1-rc.0 → 2.2.1

package/dist/io/p5.Table.js

@@ -39,8 +39,6 @@ class Table {
    *  @return  {p5.TableRow} the row that was added
    *
    * @example
-   * <div>
-   * <code>
    * // Given the CSV file "mammals.csv"
    * // in the project's "assets" folder:
    * //
@@ -80,8 +78,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   addRow (row) {
   // make sure it is a valid TableRow
@@ -99,12 +95,10 @@ class Table {
   /**
    * Removes a row from the table object.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
    * @param   {Integer} id ID number of the row to remove
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -136,8 +130,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   removeRow (id) {
     this.rows[id].table = null; // remove reference to table
@@ -155,8 +147,6 @@ class Table {
    * @return {p5.TableRow} <a href="#/p5.TableRow">p5.TableRow</a> object
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -181,22 +171,18 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getRow (r) {
     return this.rows[r];
   }
 
   /**
-   *  Gets all rows from the table. Returns an array of <a href="#/p5.TableRow">p5.TableRow</a>s.
+   * Gets all rows from the table. Returns an array of <a href="#/p5.TableRow">p5.TableRow</a>s.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @return {p5.TableRow[]}   Array of <a href="#/p5.TableRow">p5.TableRow</a>s
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @return {p5.TableRow[]}   Array of <a href="#/p5.TableRow">p5.TableRow</a>s
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -233,29 +219,25 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getRows () {
     return this.rows;
   }
 
   /**
-   *  Finds the first row in the Table that contains the value
-   *  provided, and returns a reference to that row. Even if
-   *  multiple rows are possible matches, only the first matching
-   *  row is returned. The column to search may be specified by
-   *  either its ID or title.
+   * Finds the first row in the Table that contains the value
+   * provided, and returns a reference to that row. Even if
+   * multiple rows are possible matches, only the first matching
+   * row is returned. The column to search may be specified by
+   * either its ID or title.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param  {String} value  The value to match
-   *  @param  {Integer|String} column ID number or title of the
-   *                                 column to search
-   *  @return {p5.TableRow}
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param  {String} value  The value to match
+   * @param  {Integer|String} column ID number or title of the
+   *                                column to search
+   * @return {p5.TableRow}
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -279,8 +261,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   findRow (value, column) {
   // try the Object
@@ -303,21 +283,19 @@ class Table {
   }
 
   /**
-   *  Finds the rows in the Table that contain the value
-   *  provided, and returns references to those rows. Returns an
-   *  Array, so for must be used to iterate through all the rows,
-   *  as shown in the example above. The column to search may be
-   *  specified by either its ID or title.
+   * Finds the rows in the Table that contain the value
+   * provided, and returns references to those rows. Returns an
+   * Array, so for must be used to iterate through all the rows,
+   * as shown in the example above. The column to search may be
+   * specified by either its ID or title.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param  {String} value  The value to match
-   *  @param  {Integer|String} column ID number or title of the
-   *                                 column to search
-   *  @return {p5.TableRow[]}        An Array of TableRow objects
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param  {String} value  The value to match
+   * @param  {Integer|String} column ID number or title of the
+   *                                column to search
+   * @return {p5.TableRow[]}        An Array of TableRow objects
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -346,8 +324,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   findRows (value, column) {
     const ret = [];
@@ -382,8 +358,6 @@ class Table {
    * @return {p5.TableRow}        TableRow object
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -407,8 +381,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   matchRow (regexp, column) {
     if (typeof column === 'number') {
@@ -439,8 +411,6 @@ class Table {
    *                                  title (string)
    * @return {p5.TableRow[]}          An Array of TableRow objects
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * function setup() {
@@ -454,15 +424,15 @@ class Table {
    *   table.addColumn('type');
    *
    *   // Add rows to the table
-   *    let newRow = table.addRow();
+   *   let newRow = table.addRow();
    *   newRow.setString('name', 'Lion');
-   *    newRow.setString('type', 'Mammal');
+   *   newRow.setString('type', 'Mammal');
    *
    *   newRow = table.addRow();
    *   newRow.setString('name', 'Snake');
    *   newRow.setString('type', 'Reptile');
    *
-   *    newRow = table.addRow();
+   *   newRow = table.addRow();
    *   newRow.setString('name', 'Mosquito');
    *   newRow.setString('type', 'Insect');
    *
@@ -485,8 +455,6 @@ class Table {
    *     y += 20;
    *   }
    * }
-   * </code>
-   * </div>
    */
   matchRows (regexp, column) {
     const ret = [];
@@ -515,8 +483,7 @@ class Table {
    *  @return {Array}       Array of column values
    *
    * @example
-   * <div class="norender">
-   * <code>
+   * // META:norender
    * // Given the CSV file "mammals.csv"
    * // in the project's "assets" folder:
    * //
@@ -537,8 +504,6 @@ class Table {
    *   //outputs ["Capra hircus", "Panthera pardus", "Equus zebra"]
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getColumn (value) {
     const ret = [];
@@ -555,14 +520,12 @@ class Table {
   }
 
   /**
-   *  Removes all rows from a Table. While all rows are removed,
-   *  columns and column titles are maintained.
+   * Removes all rows from a Table. While all rows are removed,
+   * columns and column titles are maintained.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
    *
    * @example
-   * <div>
-   * <code>
    * // Given the CSV file "mammals.csv"
    * // in the project's "assets" folder:
    * //
@@ -593,8 +556,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   clearRows () {
     delete this.rows;
@@ -602,17 +563,15 @@ class Table {
   }
 
   /**
-   *  Use <a href="/reference/p5.Table/addColumn/">addColumn()</a> to add a new column to a <a href="#/p5.Table">Table</a> object.
-   *  Typically, you will want to specify a title, so the column
-   *  may be easily referenced later by name. (If no title is
-   *  specified, the new column's title will be null.)
+   * Use <a href="/reference/p5.Table/addColumn/">addColumn()</a> to add a new column to a <a href="#/p5.Table">Table</a> object.
+   * Typically, you will want to specify a title, so the column
+   * may be easily referenced later by name. (If no title is
+   * specified, the new column's title will be null.)
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param {String} [title] title of the given column
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param {String} [title] title of the given column
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -639,8 +598,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   addColumn (title) {
     const t = title || null;
@@ -648,13 +605,11 @@ class Table {
   }
 
   /**
-   *  Returns the total number of columns in a Table.
+   * Returns the total number of columns in a Table.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @return {Integer} Number of columns in this table
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @return {Integer} Number of columns in this table
    * @example
-   * <div>
-   * <code>
    * // given the cvs file "blobs.csv" in /assets directory
    * // ID, Name, Flavor, Shape, Color
    * // Blob1, Blobby, Sweet, Blob, Pink
@@ -674,21 +629,17 @@ class Table {
    *   let numOfColumn = table.getColumnCount();
    *   text('There are ' + numOfColumn + ' columns in the table.', 100, 50);
    * }
-   * </code>
-   * </div>
    */
   getColumnCount () {
     return this.columns.length;
   }
 
   /**
-   *  Returns the total number of rows in a Table.
+   * Returns the total number of rows in a Table.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @return {Integer} Number of rows in this table
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @return {Integer} Number of rows in this table
    * @example
-   * <div>
-   * <code>
    * // given the cvs file "blobs.csv" in /assets directory
    * //
    * // ID, Name, Flavor, Shape, Color
@@ -708,27 +659,25 @@ class Table {
    * function draw() {
    *   text('There are ' + table.getRowCount() + ' rows in the table.', 100, 50);
    * }
-   * </code>
-   * </div>
    */
   getRowCount () {
     return this.rows.length;
   }
 
   /**
-   *  Removes any of the specified characters (or "tokens").
+   * Removes any of the specified characters (or "tokens").
    *
-   *  If no column is specified, then the values in all columns and
-   *  rows are processed. A specific column may be referenced by
-   *  either its ID or title.
+   * If no column is specified, then the values in all columns and
+   * rows are processed. A specific column may be referenced by
+   * either its ID or title.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param  {String} chars  String listing characters to be removed
-   *  @param  {String|Integer} [column] Column ID (number)
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param  {String} chars  String listing characters to be removed
+   * @param  {String|Integer} [column] Column ID (number)
    *                                   or name (string)
    *
    * @example
-   * <div class="norender"><code>
+   * // META:norender
    * function setup() {
    *   let table = new p5.Table();
    *
@@ -750,7 +699,6 @@ class Table {
    * // prints:
    * //  0  "Lion"   "Mamal"
    * //  1  "Snake"  "Reptile"
-   * </code></div>
    */
   removeTokens (chars, column) {
     const escape = s => s.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
@@ -788,16 +736,16 @@ class Table {
   }
 
   /**
-   *  Trims leading and trailing whitespace, such as spaces and tabs,
-   *  from String table values. If no column is specified, then the
-   *  values in all columns and rows are trimmed. A specific column
-   *  may be referenced by either its ID or title.
+   * Trims leading and trailing whitespace, such as spaces and tabs,
+   * from String table values. If no column is specified, then the
+   * values in all columns and rows are trimmed. A specific column
+   * may be referenced by either its ID or title.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param  {String|Integer} [column] Column ID (number)
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param  {String|Integer} [column] Column ID (number)
    *                                   or name (string)
    * @example
-   * <div class="norender"><code>
+   * // META:norender
    * function setup() {
    *   let table = new p5.Table();
    *
@@ -819,7 +767,6 @@ class Table {
    * // prints:
    * //  0  "Lion"   "Mamal"
    * //  1  "Snake"  "Reptile"
-   * </code></div>
    */
   trim (column) {
     const regex = new RegExp(' ', 'g');
@@ -852,18 +799,16 @@ class Table {
   }
 
   /**
-   *  Use <a href="/reference/p5.Table/removeColumn/">removeColumn()</a> to remove an existing column from a Table
-   *  object. The column to be removed may be identified by either
-   *  its title (a String) or its index value (an int).
-   *  removeColumn(0) would remove the first column, removeColumn(1)
-   *  would remove the second column, and so on.
+   * Use <a href="/reference/p5.Table/removeColumn/">removeColumn()</a> to remove an existing column from a Table
+   * object. The column to be removed may be identified by either
+   * its title (a String) or its index value (an int).
+   * removeColumn(0) would remove the first column, removeColumn(1)
+   * would remove the second column, and so on.
    *
-   *  @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
-   *  @param  {String|Integer} column columnName (string) or ID (number)
+   * @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
+   * @param  {String|Integer} column columnName (string) or ID (number)
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -889,8 +834,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   removeColumn (c) {
     let cString;
@@ -929,8 +872,6 @@ class Table {
    * @param {String|Number} value  value to assign
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -963,8 +904,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   set (row, column, value) {
     this.rows[row].set(column, value);
@@ -982,8 +921,6 @@ class Table {
    * @param {Number} value  value to assign
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1008,8 +945,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   setNum (row, column, value) {
     this.rows[row].setNum(column, value);
@@ -1026,8 +961,6 @@ class Table {
    *                               or title (String)
    * @param {String} value  value to assign
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1062,8 +995,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   setString (row, column, value) {
     this.rows[row].setString(column, value);
@@ -1081,8 +1012,6 @@ class Table {
    * @return {String|Number}
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1107,8 +1036,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   get (row, column) {
     if(typeof column === 'string'){
@@ -1130,8 +1057,6 @@ class Table {
    * @return {Number}
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1152,8 +1077,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getNum (row, column) {
     return this.rows[row].getNum(column);
@@ -1171,8 +1094,6 @@ class Table {
    * @return {String}
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1210,8 +1131,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getString (row, column) {
     return this.rows[row].getString(column);
@@ -1228,8 +1147,7 @@ class Table {
    * @return {Object}
    *
    * @example
-   * <div class="norender">
-   * <code>
+   * // META:norender
    * // Given the CSV file "mammals.csv"
    * // in the project's "assets" folder:
    * //
@@ -1252,8 +1170,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getObject (headerColumn) {
     const tableObject = {};
@@ -1284,8 +1200,6 @@ class Table {
    * @return {Array}
    *
    * @example
-   * <div>
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1312,8 +1226,6 @@ class Table {
    *
    *   describe('no image displayed');
    * }
-   * </code>
-   * </div>
    */
   getArray () {
     const tableArray = [];
@@ -1368,8 +1280,6 @@ function table(p5, fn){
    * @for p5.Table
    * @name columns
    * @example
-   * <div >
-   * <code>
    * let table;
    *
    * async function setup() {
@@ -1388,8 +1298,6 @@ function table(p5, fn){
    *     text('column ' + c + ' is named ' + table.columns[c], 10, 30 + c * 20);
    *   }
    * }
-   * </code>
-   * </div>
    */
 
   /**