22
22
23
23
// MODULES //
24
24
25
- var logger = require ( 'debug' ) ;
26
25
var EventEmitter = require ( 'events' ) . EventEmitter ;
26
+ var logger = require ( 'debug' ) ;
27
27
var getKeys = require ( 'object-keys' ) . shim ( ) ;
28
28
var linear = require ( 'd3-scale' ) . scaleLinear ; // TODO: remove
29
29
var setReadOnly = require ( '@stdlib/utils/define-read-only-property' ) ;
@@ -170,11 +170,11 @@ Path.prototype.constructor = Path;
170
170
/**
171
171
* `x` values.
172
172
*
173
- * @memberof Path.prototype
174
173
* @name x
174
+ * @memberof Path.prototype
175
175
* @type {ArrayLike }
176
- * @default []
177
176
* @throws {TypeError } must be array-like
177
+ * @default []
178
178
*
179
179
* @example
180
180
* var path = new Path({
@@ -194,11 +194,11 @@ Object.defineProperty( Path.prototype, 'x', {
194
194
/**
195
195
* `y` values.
196
196
*
197
- * @memberof Path.prototype
198
197
* @name y
198
+ * @memberof Path.prototype
199
199
* @type {ArrayLike }
200
- * @default []
201
200
* @throws {TypeError } must be array-like
201
+ * @default []
202
202
*
203
203
* @example
204
204
* var path = new Path({
@@ -218,8 +218,8 @@ Object.defineProperty( Path.prototype, 'y', {
218
218
/**
219
219
* `x` scale function.
220
220
*
221
- * @memberof Path.prototype
222
221
* @name xScale
222
+ * @memberof Path.prototype
223
223
* @type {Function }
224
224
* @throws {TypeError } must be a function
225
225
*
@@ -241,8 +241,8 @@ Object.defineProperty( Path.prototype, 'xScale', {
241
241
/**
242
242
* `y` scale function.
243
243
*
244
- * @memberof Path.prototype
245
244
* @name yScale
245
+ * @memberof Path.prototype
246
246
* @type {Function }
247
247
* @throws {TypeError } must be a function
248
248
*
@@ -264,8 +264,8 @@ Object.defineProperty( Path.prototype, 'yScale', {
264
264
/**
265
265
* Accessor which defines whether a datum is defined. This accessor is used to define how missing values are encoded. The default behavior is to ignore values which are `NaN`.
266
266
*
267
- * @memberof Path.prototype
268
267
* @name isDefined
268
+ * @memberof Path.prototype
269
269
* @type {Function }
270
270
* @throws {TypeError } must be a function
271
271
*
@@ -297,8 +297,8 @@ Object.defineProperty( Path.prototype, 'isDefined', {
297
297
/**
298
298
* Path color.
299
299
*
300
- * @memberof Path.prototype
301
300
* @name color
301
+ * @memberof Path.prototype
302
302
* @type {string }
303
303
* @throws {TypeError } must be a primitive string
304
304
*
@@ -320,8 +320,8 @@ Object.defineProperty( Path.prototype, 'color', {
320
320
/**
321
321
* Path label.
322
322
*
323
- * @memberof Path.prototype
324
323
* @name label
324
+ * @memberof Path.prototype
325
325
* @type {string }
326
326
* @throws {TypeError } must be a primitive string
327
327
*
@@ -343,12 +343,12 @@ Object.defineProperty( Path.prototype, 'label', {
343
343
/**
344
344
* Path opacity.
345
345
*
346
- * @memberof Path.prototype
347
346
* @name opacity
347
+ * @memberof Path.prototype
348
348
* @type {number }
349
- * @default 0.9
350
349
* @throws {TypeError } must be a number
351
350
* @throws {RangeError } must be a number on the interval `[0,1]`
351
+ * @default 0.9
352
352
*
353
353
* @example
354
354
* var path = new Path({
@@ -368,11 +368,11 @@ Object.defineProperty( Path.prototype, 'opacity', {
368
368
/**
369
369
* Path width.
370
370
*
371
- * @memberof Path.prototype
372
371
* @name width
372
+ * @memberof Path.prototype
373
373
* @type {NonNegativeInteger }
374
- * @default 2
375
374
* @throws {TypeError } must be a nonnegative integer
375
+ * @default 2
376
376
*
377
377
* @example
378
378
* var path = new Path({
@@ -392,11 +392,11 @@ Object.defineProperty( Path.prototype, 'width', {
392
392
/**
393
393
* Path style.
394
394
*
395
- * @memberof Path.prototype
396
395
* @name style
396
+ * @memberof Path.prototype
397
397
* @type {string }
398
- * @default '-'
399
398
* @throws {TypeError } must be a string primitive
399
+ * @default '-'
400
400
*
401
401
* @example
402
402
* var path = new Path({
@@ -416,11 +416,11 @@ Object.defineProperty( Path.prototype, 'style', {
416
416
/**
417
417
* Rendering mode. If `true`, an instance re-renders on each change event.
418
418
*
419
- * @memberof Path.prototype
420
419
* @name autoRender
420
+ * @memberof Path.prototype
421
421
* @type {boolean }
422
- * @default true
423
422
* @throws {TypeError } must be a boolean primitive
423
+ * @default true
424
424
*
425
425
* @example
426
426
* var path = new Path({
@@ -440,8 +440,8 @@ Object.defineProperty( Path.prototype, 'autoRender', {
440
440
/**
441
441
* Returns a function to generate a line as an SVG path.
442
442
*
443
- * @memberof Path.prototype
444
443
* @name line
444
+ * @memberof Path.prototype
445
445
* @type {Function }
446
446
*
447
447
* @example
@@ -459,9 +459,9 @@ Object.defineProperty( Path.prototype, 'line', {
459
459
/**
460
460
* Function to map values to x coordinate values.
461
461
*
462
+ * @name xPos
462
463
* @memberof Path.prototype
463
464
* @type {Function }
464
- * @name xPos
465
465
*
466
466
* @example
467
467
* var path = new Path();
@@ -477,9 +477,9 @@ Object.defineProperty( Path.prototype, 'xPos', {
477
477
/**
478
478
* Function to map values to y coordinate values.
479
479
*
480
+ * @name yPos
480
481
* @memberof Path.prototype
481
482
* @type {Function }
482
- * @name yPos
483
483
*
484
484
* @example
485
485
* var path = new Path();
@@ -495,8 +495,8 @@ Object.defineProperty( Path.prototype, 'yPos', {
495
495
/**
496
496
* Renders a virtual DOM tree.
497
497
*
498
- * @memberof Path.prototype
499
498
* @name render
499
+ * @memberof Path.prototype
500
500
* @type {Function }
501
501
* @returns {VTree } virtual tree
502
502
*
0 commit comments