@@ -38,15 +38,15 @@ var PRIVATE_PROPS = [
38
38
*
39
39
* @constructor
40
40
* @param {Options } options - constructor options
41
+ * @param {boolean } [options.autoRender=true] - indicates whether to re-render on a change event
42
+ * @param {(string|Function) } [options.color] - color
41
43
* @param {ArrayLike } [options.data=[]] - data
42
- * @param {Function } [options.scale] - scale function
43
- * @param {string } [options.orientation] - orientation
44
44
* @param {Function } [options.isDefined] - accessor indicating whether a datum is defined
45
- * @param {(number|Function) } [options.opacity=0.9] - opacity
46
- * @param {(string|Function) } [options.color] - color
47
45
* @param {(string|Function) } [options.label] - label
46
+ * @param {(number|Function) } [options.opacity=0.9] - opacity
47
+ * @param {string } [options.orientation] - orientation
48
+ * @param {Function } [options.scale] - scale function
48
49
* @param {NonNegativeInteger } [options.size=6] - tick (tassel) size
49
- * @param {boolean } [options.autoRender=true] - indicates whether to re-render on a change event
50
50
* @throws {TypeError } options argument must be an object
51
51
* @throws {TypeError } must provide valid options
52
52
* @returns {Rug } Rug instance
@@ -141,73 +141,74 @@ function Rug( options ) {
141
141
inherit ( Rug , EventEmitter ) ;
142
142
143
143
/**
144
- * Data .
144
+ * Rendering mode. If `true`, an instance re-renders on each change event .
145
145
*
146
146
* @memberof Rug.prototype
147
- * @name data
148
- * @type {ArrayLike }
149
- * @default []
150
- * @throws {TypeError } must be array-like
147
+ * @name autoRender
148
+ * @type {boolean }
149
+ * @default true
150
+ * @throws {TypeError } must be a boolean primitive
151
151
*
152
152
* @example
153
153
* var node = new Rug({
154
- * 'data ': [ 0.1, 0.2, 0.3 ]
154
+ * 'autoRender ': true
155
155
* });
156
156
*
157
- * var data = node.data ;
158
- * // returns [ 0.1, 0.2, 0.3 ]
157
+ * var mode = node.autoRender ;
158
+ * // returns true
159
159
*/
160
- Object . defineProperty ( Rug . prototype , 'data ' , {
160
+ Object . defineProperty ( Rug . prototype , 'autoRender ' , {
161
161
'configurable' : false ,
162
162
'enumerable' : true ,
163
- 'set' : require ( './props/data /set.js' ) ,
164
- 'get' : require ( './props/data /get.js' )
163
+ 'set' : require ( './props/auto-render /set.js' ) ,
164
+ 'get' : require ( './props/auto-render /get.js' )
165
165
} ) ;
166
166
167
167
/**
168
- * Rug orientation .
168
+ * Tick color. When retrieved, the returned value is a color accessor .
169
169
*
170
170
* @memberof Rug.prototype
171
- * @name orientation
172
- * @type {string }
173
- * @throws {TypeError } must be a supported orientation
171
+ * @name color
172
+ * @type {( string|Function) }
173
+ * @throws {TypeError } must be a primitive string or function
174
174
*
175
175
* @example
176
176
* var node = new Rug({
177
- * 'orientation ': 'left '
177
+ * 'color ': 'steelblue '
178
178
* });
179
179
*
180
- * var orient = node.orientation ;
181
- * // returns 'left'
180
+ * var color = node.color ;
181
+ * // returns <Function>
182
182
*/
183
- Object . defineProperty ( Rug . prototype , 'orientation ' , {
183
+ Object . defineProperty ( Rug . prototype , 'color ' , {
184
184
'configurable' : false ,
185
185
'enumerable' : true ,
186
- 'set' : require ( './props/orientation /set.js' ) ,
187
- 'get' : require ( './props/orientation /get.js' )
186
+ 'set' : require ( './props/color /set.js' ) ,
187
+ 'get' : require ( './props/color /get.js' )
188
188
} ) ;
189
189
190
190
/**
191
- * Scale function .
191
+ * Data .
192
192
*
193
193
* @memberof Rug.prototype
194
- * @name scale
195
- * @type {Function }
196
- * @throws {TypeError } must be a function
194
+ * @name data
195
+ * @type {ArrayLike }
196
+ * @default []
197
+ * @throws {TypeError } must be array-like
197
198
*
198
199
* @example
199
200
* var node = new Rug({
200
- * 'scale ': function scale(){}
201
+ * 'data ': [ 0.1, 0.2, 0.3 ]
201
202
* });
202
203
*
203
- * var f = node.scale ;
204
- * // returns <Function>
204
+ * var data = node.data ;
205
+ * // returns [ 0.1, 0.2, 0.3 ]
205
206
*/
206
- Object . defineProperty ( Rug . prototype , 'scale ' , {
207
+ Object . defineProperty ( Rug . prototype , 'data ' , {
207
208
'configurable' : false ,
208
209
'enumerable' : true ,
209
- 'set' : require ( './props/scale /set.js' ) ,
210
- 'get' : require ( './props/scale /get.js' )
210
+ 'set' : require ( './props/data /set.js' ) ,
211
+ 'get' : require ( './props/data /get.js' )
211
212
} ) ;
212
213
213
214
/**
@@ -246,27 +247,26 @@ Object.defineProperty( Rug.prototype, 'isDefined', {
246
247
} ) ;
247
248
248
249
/**
249
- * Tick (tassel) size .
250
+ * Tick label. When retrieved, the returned value is a label accessor .
250
251
*
251
252
* @memberof Rug.prototype
252
- * @name size
253
- * @type {NonNegativeInteger }
254
- * @default 6
255
- * @throws {TypeError } must be a nonnegative integer
253
+ * @name label
254
+ * @type {(string|Function) }
255
+ * @throws {TypeError } must be a primitive string or function
256
256
*
257
257
* @example
258
258
* var node = new Rug({
259
- * 'size ': 5
259
+ * 'label ': 'group-1'
260
260
* });
261
261
*
262
- * var size = node.size ;
263
- * // returns 5
262
+ * var label = node.label ;
263
+ * // returns <Function>
264
264
*/
265
- Object . defineProperty ( Rug . prototype , 'size ' , {
265
+ Object . defineProperty ( Rug . prototype , 'label ' , {
266
266
'configurable' : false ,
267
267
'enumerable' : true ,
268
- 'set' : require ( './props/size /set.js' ) ,
269
- 'get' : require ( './props/size /get.js' )
268
+ 'set' : require ( './props/label /set.js' ) ,
269
+ 'get' : require ( './props/label /get.js' )
270
270
} ) ;
271
271
272
272
/**
@@ -295,92 +295,92 @@ Object.defineProperty( Rug.prototype, 'opacity', {
295
295
} ) ;
296
296
297
297
/**
298
- * Tick color. When retrieved, the returned value is a color accessor .
298
+ * Rug orientation .
299
299
*
300
300
* @memberof Rug.prototype
301
- * @name color
302
- * @type {( string|Function) }
303
- * @throws {TypeError } must be a primitive string or function
301
+ * @name orientation
302
+ * @type {string }
303
+ * @throws {TypeError } must be a supported orientation
304
304
*
305
305
* @example
306
306
* var node = new Rug({
307
- * 'color ': 'steelblue '
307
+ * 'orientation ': 'left '
308
308
* });
309
309
*
310
- * var color = node.color ;
311
- * // returns <Function>
310
+ * var orient = node.orientation ;
311
+ * // returns 'left'
312
312
*/
313
- Object . defineProperty ( Rug . prototype , 'color ' , {
313
+ Object . defineProperty ( Rug . prototype , 'orientation ' , {
314
314
'configurable' : false ,
315
315
'enumerable' : true ,
316
- 'set' : require ( './props/color /set.js' ) ,
317
- 'get' : require ( './props/color /get.js' )
316
+ 'set' : require ( './props/orientation /set.js' ) ,
317
+ 'get' : require ( './props/orientation /get.js' )
318
318
} ) ;
319
319
320
320
/**
321
- * Tick label. When retrieved, the returned value is a label accessor .
321
+ * Function to map values to x coordinate values .
322
322
*
323
323
* @memberof Rug.prototype
324
- * @name label
325
- * @type {(string|Function) }
326
- * @throws {TypeError } must be a primitive string or function
324
+ * @name pos
325
+ * @type {Function }
327
326
*
328
327
* @example
329
- * var node = new Rug({
330
- * 'label': 'group-1'
331
- * });
328
+ * var node = new Rug();
332
329
*
333
- * var label = node.label ;
330
+ * var pos = node.pos ;
334
331
* // returns <Function>
335
332
*/
336
- Object . defineProperty ( Rug . prototype , 'label ' , {
333
+ Object . defineProperty ( Rug . prototype , 'pos ' , {
337
334
'configurable' : false ,
338
335
'enumerable' : true ,
339
- 'set' : require ( './props/label/set.js' ) ,
340
- 'get' : require ( './props/label/get.js' )
336
+ 'get' : require ( './props/pos/get.js' )
341
337
} ) ;
342
338
343
339
/**
344
- * Rendering mode. If `true`, an instance re-renders on each change event .
340
+ * Scale function .
345
341
*
346
342
* @memberof Rug.prototype
347
- * @name autoRender
348
- * @type {boolean }
349
- * @default true
350
- * @throws {TypeError } must be a boolean primitive
343
+ * @name scale
344
+ * @type {Function }
345
+ * @throws {TypeError } must be a function
351
346
*
352
347
* @example
353
348
* var node = new Rug({
354
- * 'autoRender ': true
349
+ * 'scale ': function scale(){}
355
350
* });
356
351
*
357
- * var mode = node.autoRender ;
358
- * // returns true
352
+ * var f = node.scale ;
353
+ * // returns <Function>
359
354
*/
360
- Object . defineProperty ( Rug . prototype , 'autoRender ' , {
355
+ Object . defineProperty ( Rug . prototype , 'scale ' , {
361
356
'configurable' : false ,
362
357
'enumerable' : true ,
363
- 'set' : require ( './props/auto-render /set.js' ) ,
364
- 'get' : require ( './props/auto-render /get.js' )
358
+ 'set' : require ( './props/scale /set.js' ) ,
359
+ 'get' : require ( './props/scale /get.js' )
365
360
} ) ;
366
361
367
362
/**
368
- * Function to map values to x coordinate values .
363
+ * Tick (tassel) size .
369
364
*
370
365
* @memberof Rug.prototype
371
- * @name pos
372
- * @type {Function }
366
+ * @name size
367
+ * @type {NonNegativeInteger }
368
+ * @default 6
369
+ * @throws {TypeError } must be a nonnegative integer
373
370
*
374
371
* @example
375
- * var node = new Rug();
372
+ * var node = new Rug({
373
+ * 'size': 5
374
+ * });
376
375
*
377
- * var pos = node.pos ;
378
- * // returns <Function>
376
+ * var size = node.size ;
377
+ * // returns 5
379
378
*/
380
- Object . defineProperty ( Rug . prototype , 'pos ' , {
379
+ Object . defineProperty ( Rug . prototype , 'size ' , {
381
380
'configurable' : false ,
382
381
'enumerable' : true ,
383
- 'get' : require ( './props/pos/get.js' )
382
+ 'set' : require ( './props/size/set.js' ) ,
383
+ 'get' : require ( './props/size/get.js' )
384
384
} ) ;
385
385
386
386
/**
0 commit comments