From: Dan Vanderkam Date: Thu, 24 Oct 2013 04:36:30 +0000 (-0500) Subject: Fix some basic Closure type annotation mistakes X-Git-Tag: v1.1.0~75^2~2 X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=1bc8821664d275b8aaeceaa5a3281c90724b7b4c;p=dygraphs.git Fix some basic Closure type annotation mistakes --- diff --git a/dygraph-utils.js b/dygraph-utils.js index 0ca6585..36ad10e 100644 --- a/dygraph-utils.js +++ b/dygraph-utils.js @@ -1075,8 +1075,9 @@ Dygraph.IFrameTarp.prototype.cover = function() { var iframes = document.getElementsByTagName("iframe"); for (var i = 0; i < iframes.length; i++) { var iframe = iframes[i]; - var x = Dygraph.findPosX(iframe), - y = Dygraph.findPosY(iframe), + var pos = Dygraph.findPos(iframe), + x = pos.x, + y = pos.y, width = iframe.offsetWidth, height = iframe.offsetHeight; @@ -1202,7 +1203,7 @@ Dygraph.toRGB_ = function(colorStr) { div.style.backgroundColor = colorStr; div.style.visibility = 'hidden'; document.body.appendChild(div); - var rgbStr = window.getComputedStyle(div).backgroundColor; + var rgbStr = window.getComputedStyle(div, null).backgroundColor; document.body.removeChild(div); var bits = /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/.exec(rgbStr); return { diff --git a/dygraph.js b/dygraph.js index a95b91d..07f2a22 100644 --- a/dygraph.js +++ b/dygraph.js @@ -82,14 +82,14 @@ var Dygraph = function(div, data, opts, opt_fourth_param) { Dygraph.NAME = "Dygraph"; Dygraph.VERSION = "1.0.1"; Dygraph.__repr__ = function() { - return "[" + this.NAME + " " + this.VERSION + "]"; + return "[" + Dygraph.NAME + " " + Dygraph.VERSION + "]"; }; /** * Returns information about the Dygraph class. */ Dygraph.toString = function() { - return this.__repr__(); + return Dygraph.__repr__(); }; // Various default values @@ -112,9 +112,9 @@ Dygraph.KMG2_SMALL_LABELS = [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ]; * @private * Return a string version of a number. This respects the digitsAfterDecimal * and maxNumberWidth options. - * @param {Number} x The number to be formatted + * @param {number} x The number to be formatted * @param {Dygraph} opts An options view - * @param {String} name The name of the point's data series + * @param {string} name The name of the point's data series * @param {Dygraph} g The dygraph object */ Dygraph.numberValueFormatter = function(x, opts, pt, g) { @@ -204,8 +204,8 @@ Dygraph.SHORT_MONTH_NAMES_ = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', ' * Convert a JS date to a string appropriate to display on an axis that * is displaying values at the stated granularity. * @param {Date} date The date to format - * @param {Number} granularity One of the Dygraph granularity constants - * @return {String} The formatted date + * @param {number} granularity One of the Dygraph granularity constants + * @return {string} The formatted date * @private */ Dygraph.dateAxisFormatter = function(date, granularity) { @@ -393,7 +393,7 @@ Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) { * and context <canvas> inside of it. See the constructor for details. * on the parameters. * @param {Element} div the Element to render the graph into. - * @param {String | Function} file Source data + * @param {string | Function} file Source data * @param {Object} attrs Miscellaneous other options * @private */ @@ -616,8 +616,8 @@ Dygraph.prototype.toString = function() { * Returns the value of an option. This may be set by the user (either in the * constructor or by calling updateOptions) or by dygraphs, and may be set to a * per-series value. - * @param { String } name The name of the option, e.g. 'rollPeriod'. - * @param { String } [seriesName] The name of the series to which the option + * @param {string} name The name of the option, e.g. 'rollPeriod'. + * @param {string} [seriesName] The name of the series to which the option * will be applied. If no per-series value of this option is available, then * the global value is returned. This is optional. * @return { ... } The value of the option. @@ -646,9 +646,9 @@ Dygraph.prototype.attr_ = function(name, seriesName) { * dygraphs will remain in a consistent state. If you want to modify an option, * use updateOptions() instead. * - * @param { String } name The name of the option (e.g. 'strokeWidth') - * @param { String } [opt_seriesName] Series name to get per-series values. - * @return { ... } The value of the option. + * @param {string} name The name of the option (e.g. 'strokeWidth') + * @param {string=} opt_seriesName Series name to get per-series values. + * @return {*} The value of the option. */ Dygraph.prototype.getOption = function(name, opt_seriesName) { return this.attr_(name, opt_seriesName); @@ -741,7 +741,7 @@ Dygraph.prototype.optionsViewForAxis_ = function(axis) { /** * Returns the current rolling period, as set by the user or an option. - * @return {Number} The number of points in the rolling window + * @return {number} The number of points in the rolling window */ Dygraph.prototype.rollPeriod = function() { return this.rollPeriod_; @@ -936,9 +936,9 @@ Dygraph.prototype.toDataYCoord = function(y, axis) { * If y is null, this returns null. * if axis is null, this uses the first axis. * - * @param { Number } y The data y-coordinate. - * @param { Number } [axis] The axis number on which the data coordinate lives. - * @return { Number } A fraction in [0, 1] where 0 = the top edge. + * @param {number} y The data y-coordinate. + * @param {number} [axis] The axis number on which the data coordinate lives. + * @return {number} A fraction in [0, 1] where 0 = the top edge. */ Dygraph.prototype.toPercentYCoord = function(y, axis) { if (y === null) { @@ -972,8 +972,8 @@ Dygraph.prototype.toPercentYCoord = function(y, axis) { * values can fall outside the canvas. * * If x is null, this returns null. - * @param { Number } x The data x-coordinate. - * @return { Number } A fraction in [0, 1] where 0 = the left edge. + * @param {number} x The data x-coordinate. + * @return {number} A fraction in [0, 1] where 0 = the left edge. */ Dygraph.prototype.toPercentXCoord = function(x) { if (x === null) { @@ -986,7 +986,7 @@ Dygraph.prototype.toPercentXCoord = function(x) { /** * Returns the number of columns (including the independent variable). - * @return { Integer } The number of columns. + * @return {number} The number of columns. */ Dygraph.prototype.numColumns = function() { if (!this.rawData_) return 0; @@ -995,7 +995,7 @@ Dygraph.prototype.numColumns = function() { /** * Returns the number of rows (excluding any header/label row). - * @return { Integer } The number of rows, less any header. + * @return {number} The number of rows, less any header. */ Dygraph.prototype.numRows = function() { if (!this.rawData_) return 0; @@ -1006,11 +1006,11 @@ Dygraph.prototype.numRows = function() { * Returns the value in the given row and column. If the row and column exceed * the bounds on the data, returns null. Also returns null if the value is * missing. - * @param { Number} row The row number of the data (0-based). Row 0 is the - * first row of data, not a header row. - * @param { Number} col The column number of the data (0-based) - * @return { Number } The value in the specified cell or null if the row/col - * were out of range. + * @param {number} row The row number of the data (0-based). Row 0 is the + * first row of data, not a header row. + * @param {number} col The column number of the data (0-based) + * @return {number} The value in the specified cell or null if the row/col + * were out of range. */ Dygraph.prototype.getValue = function(row, col) { if (row < 0 || row > this.rawData_.length) return null; @@ -1416,20 +1416,20 @@ Dygraph.prototype.createDragInterface_ = function() { * avoid extra redrawing, but it's tricky to avoid interactions with the status * dots. * - * @param {Number} direction the direction of the zoom rectangle. Acceptable - * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL. - * @param {Number} startX The X position where the drag started, in canvas - * coordinates. - * @param {Number} endX The current X position of the drag, in canvas coords. - * @param {Number} startY The Y position where the drag started, in canvas - * coordinates. - * @param {Number} endY The current Y position of the drag, in canvas coords. - * @param {Number} prevDirection the value of direction on the previous call to - * this function. Used to avoid excess redrawing - * @param {Number} prevEndX The value of endX on the previous call to this - * function. Used to avoid excess redrawing - * @param {Number} prevEndY The value of endY on the previous call to this - * function. Used to avoid excess redrawing + * @param {number} direction the direction of the zoom rectangle. Acceptable + * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL. + * @param {number} startX The X position where the drag started, in canvas + * coordinates. + * @param {number} endX The current X position of the drag, in canvas coords. + * @param {number} startY The Y position where the drag started, in canvas + * coordinates. + * @param {number} endY The current Y position of the drag, in canvas coords. + * @param {number} prevDirection the value of direction on the previous call to + * this function. Used to avoid excess redrawing + * @param {number} prevEndX The value of endX on the previous call to this + * function. Used to avoid excess redrawing + * @param {number} prevEndY The value of endY on the previous call to this + * function. Used to avoid excess redrawing * @private */ Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY, @@ -1481,8 +1481,8 @@ Dygraph.prototype.clearZoomRect_ = function() { * points near lowX or highX. Don't confuse this function with doZoomXDates, * which accepts dates that match the raw data. This function redraws the graph. * - * @param {Number} lowX The leftmost pixel value that should be visible. - * @param {Number} highX The rightmost pixel value that should be visible. + * @param {number} lowX The leftmost pixel value that should be visible. + * @param {number} highX The rightmost pixel value that should be visible. * @private */ Dygraph.prototype.doZoomX_ = function(lowX, highX) { @@ -1509,8 +1509,8 @@ Dygraph.zoomAnimationFunction = function(frame, numFrames) { * method with doZoomX which accepts pixel coordinates. This function redraws * the graph. * - * @param {Number} minDate The minimum date that should be visible. - * @param {Number} maxDate The maximum date that should be visible. + * @param {number} minDate The minimum date that should be visible. + * @param {number} maxDate The maximum date that should be visible. * @private */ Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) { @@ -1533,8 +1533,8 @@ Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) { * Zoom to something containing [lowY, highY]. These are pixel coordinates in * the canvas. This function redraws the graph. * - * @param {Number} lowY The topmost pixel value that should be visible. - * @param {Number} highY The lowest pixel value that should be visible. + * @param {number} lowY The topmost pixel value that should be visible. + * @param {number} highY The lowest pixel value that should be visible. * @private */ Dygraph.prototype.doZoomY_ = function(lowY, highY) { @@ -1726,8 +1726,8 @@ Dygraph.prototype.eventToDomCoords = function(event) { /** * Given a canvas X coordinate, find the closest row. - * @param {Number} domX graph-relative DOM X coordinate - * Returns: row number, integer + * @param {number} domX graph-relative DOM X coordinate + * Returns {number} row number. * @private */ Dygraph.prototype.findClosestRow = function(domX) { @@ -1758,8 +1758,8 @@ Dygraph.prototype.findClosestRow = function(domX) { * that's closest to the supplied DOM coordinates using the standard * Euclidean X,Y distance. * - * @param {Number} domX graph-relative DOM X coordinate - * @param {Number} domY graph-relative DOM Y coordinate + * @param {number} domX graph-relative DOM X coordinate + * @param {number} domY graph-relative DOM Y coordinate * Returns: {row, seriesName, point} * @private */ @@ -1797,8 +1797,8 @@ Dygraph.prototype.findClosestPoint = function(domX, domY) { * then finds the series which puts the Y coordinate on top of its filled area, * using linear interpolation between adjacent point pairs. * - * @param {Number} domX graph-relative DOM X coordinate - * @param {Number} domY graph-relative DOM Y coordinate + * @param {number} domX graph-relative DOM X coordinate + * @param {number} domY graph-relative DOM Y coordinate * Returns: {row, seriesName, point} * @private */ @@ -2024,9 +2024,9 @@ Dygraph.prototype.updateSelection_ = function(opt_animFraction) { * Manually set the selected points and display information about them in the * legend. The selection can be cleared using clearSelection() and queried * using getSelection(). - * @param { Integer } row number that should be highlighted (i.e. appear with + * @param {number} row Row number that should be highlighted (i.e. appear with * hover dots on the chart). Set to false to clear any selection. - * @param { seriesName } optional series name to highlight that series with the + * @param {seriesName} optional series name to highlight that series with the * the highlightSeriesOpts setting. * @param { locked } optional If true, keep seriesName selected when mousing * over the graph, disabling closest-series highlighting. Call clearSelection() @@ -2113,7 +2113,7 @@ Dygraph.prototype.clearSelection = function() { /** * Returns the number of the currently selected row. To get data for this row, * you can use the getValue method. - * @return { Integer } row number, or -1 if nothing is selected + * @return {number} row number, or -1 if nothing is selected */ Dygraph.prototype.getSelection = function() { if (!this.selPoints_ || this.selPoints_.length < 1) { @@ -2149,7 +2149,7 @@ Dygraph.prototype.isSeriesLocked = function() { /** * Fires when there's data available to be graphed. - * @param {String} data Raw CSV data to be plotted + * @param {string} data Raw CSV data to be plotted * @private */ Dygraph.prototype.loadedEvent_ = function(data) { @@ -2661,7 +2661,7 @@ Dygraph.prototype.computeYAxes_ = function() { /** * Returns the number of y-axes on the chart. - * @return {Number} the number of axes. + * @return {number} the number of axes. */ Dygraph.prototype.numAxes = function() { return this.attributes_.numAxes(); @@ -2670,9 +2670,9 @@ Dygraph.prototype.numAxes = function() { /** * @private * Returns axis properties for the given series. - * @param { String } setName The name of the series for which to get axis + * @param {string} setName The name of the series for which to get axis * properties, e.g. 'Y1'. - * @return { Object } The axis properties. + * @return {Object} The axis properties. */ Dygraph.prototype.axisPropertiesForSeries = function(series) { // TODO(danvk): handle errors. @@ -2867,7 +2867,7 @@ Dygraph.prototype.computeYAxisRanges_ = function(extremes) { /** * Detects the type of the str (date or numeric) and sets the various * formatting attributes in this.attrs_ based on this type. - * @param {String} str An x value. + * @param {string} str An x value. * @private */ Dygraph.prototype.detectTypeFromString_ = function(str) { @@ -3124,7 +3124,7 @@ Dygraph.prototype.parseArray_ = function(data) { * number. All subsequent columns must be numbers. If there is a clear mismatch * between this.xValueParser_ and the type of the first column, it will be * fixed. Fills out rawData_. - * @param {[Object]} data See above. + * @param {!google.visualization.DataTable} data See above. * @private */ Dygraph.prototype.parseDataTable_ = function(data) { @@ -3433,8 +3433,8 @@ Dygraph.mapLegacyOptions_ = function(attrs) { * This is far more efficient than destroying and re-instantiating a * Dygraph, since it doesn't have to reparse the underlying data. * - * @param {Number} [width] Width (in pixels) - * @param {Number} [height] Height (in pixels) + * @param {number} width Width (in pixels) + * @param {number} height Height (in pixels) */ Dygraph.prototype.resize = function(width, height) { if (this.resize_lock) { @@ -3474,7 +3474,7 @@ Dygraph.prototype.resize = function(width, height) { /** * Adjusts the number of points in the rolling average. Updates the graph to * reflect the new averaging period. - * @param {Number} length Number of points over which to average the data. + * @param {number} length Number of points over which to average the data. */ Dygraph.prototype.adjustRoll = function(length) { this.rollPeriod_ = length;