Skip to content

Commit 3249280

Browse files
committed
Sort properties and options in alphabetical order
1 parent c7c0376 commit 3249280

File tree

1 file changed

+87
-87
lines changed
  • lib/node_modules/@stdlib/plot/components/svg/rug/lib

1 file changed

+87
-87
lines changed

lib/node_modules/@stdlib/plot/components/svg/rug/lib/ctor.js

+87-87
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ var PRIVATE_PROPS = [
3838
*
3939
* @constructor
4040
* @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
4143
* @param {ArrayLike} [options.data=[]] - data
42-
* @param {Function} [options.scale] - scale function
43-
* @param {string} [options.orientation] - orientation
4444
* @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
4745
* @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
4849
* @param {NonNegativeInteger} [options.size=6] - tick (tassel) size
49-
* @param {boolean} [options.autoRender=true] - indicates whether to re-render on a change event
5050
* @throws {TypeError} options argument must be an object
5151
* @throws {TypeError} must provide valid options
5252
* @returns {Rug} Rug instance
@@ -141,73 +141,74 @@ function Rug( options ) {
141141
inherit( Rug, EventEmitter );
142142

143143
/**
144-
* Data.
144+
* Rendering mode. If `true`, an instance re-renders on each change event.
145145
*
146146
* @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
151151
*
152152
* @example
153153
* var node = new Rug({
154-
* 'data': [ 0.1, 0.2, 0.3 ]
154+
* 'autoRender': true
155155
* });
156156
*
157-
* var data = node.data;
158-
* // returns [ 0.1, 0.2, 0.3 ]
157+
* var mode = node.autoRender;
158+
* // returns true
159159
*/
160-
Object.defineProperty( Rug.prototype, 'data', {
160+
Object.defineProperty( Rug.prototype, 'autoRender', {
161161
'configurable': false,
162162
'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' )
165165
});
166166

167167
/**
168-
* Rug orientation.
168+
* Tick color. When retrieved, the returned value is a color accessor.
169169
*
170170
* @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
174174
*
175175
* @example
176176
* var node = new Rug({
177-
* 'orientation': 'left'
177+
* 'color': 'steelblue'
178178
* });
179179
*
180-
* var orient = node.orientation;
181-
* // returns 'left'
180+
* var color = node.color;
181+
* // returns <Function>
182182
*/
183-
Object.defineProperty( Rug.prototype, 'orientation', {
183+
Object.defineProperty( Rug.prototype, 'color', {
184184
'configurable': false,
185185
'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' )
188188
});
189189

190190
/**
191-
* Scale function.
191+
* Data.
192192
*
193193
* @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
197198
*
198199
* @example
199200
* var node = new Rug({
200-
* 'scale': function scale(){}
201+
* 'data': [ 0.1, 0.2, 0.3 ]
201202
* });
202203
*
203-
* var f = node.scale;
204-
* // returns <Function>
204+
* var data = node.data;
205+
* // returns [ 0.1, 0.2, 0.3 ]
205206
*/
206-
Object.defineProperty( Rug.prototype, 'scale', {
207+
Object.defineProperty( Rug.prototype, 'data', {
207208
'configurable': false,
208209
'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' )
211212
});
212213

213214
/**
@@ -246,27 +247,26 @@ Object.defineProperty( Rug.prototype, 'isDefined', {
246247
});
247248

248249
/**
249-
* Tick (tassel) size.
250+
* Tick label. When retrieved, the returned value is a label accessor.
250251
*
251252
* @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
256256
*
257257
* @example
258258
* var node = new Rug({
259-
* 'size': 5
259+
* 'label': 'group-1'
260260
* });
261261
*
262-
* var size = node.size;
263-
* // returns 5
262+
* var label = node.label;
263+
* // returns <Function>
264264
*/
265-
Object.defineProperty( Rug.prototype, 'size', {
265+
Object.defineProperty( Rug.prototype, 'label', {
266266
'configurable': false,
267267
'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' )
270270
});
271271

272272
/**
@@ -295,92 +295,92 @@ Object.defineProperty( Rug.prototype, 'opacity', {
295295
});
296296

297297
/**
298-
* Tick color. When retrieved, the returned value is a color accessor.
298+
* Rug orientation.
299299
*
300300
* @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
304304
*
305305
* @example
306306
* var node = new Rug({
307-
* 'color': 'steelblue'
307+
* 'orientation': 'left'
308308
* });
309309
*
310-
* var color = node.color;
311-
* // returns <Function>
310+
* var orient = node.orientation;
311+
* // returns 'left'
312312
*/
313-
Object.defineProperty( Rug.prototype, 'color', {
313+
Object.defineProperty( Rug.prototype, 'orientation', {
314314
'configurable': false,
315315
'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' )
318318
});
319319

320320
/**
321-
* Tick label. When retrieved, the returned value is a label accessor.
321+
* Function to map values to x coordinate values.
322322
*
323323
* @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}
327326
*
328327
* @example
329-
* var node = new Rug({
330-
* 'label': 'group-1'
331-
* });
328+
* var node = new Rug();
332329
*
333-
* var label = node.label;
330+
* var pos = node.pos;
334331
* // returns <Function>
335332
*/
336-
Object.defineProperty( Rug.prototype, 'label', {
333+
Object.defineProperty( Rug.prototype, 'pos', {
337334
'configurable': false,
338335
'enumerable': true,
339-
'set': require( './props/label/set.js' ),
340-
'get': require( './props/label/get.js' )
336+
'get': require( './props/pos/get.js' )
341337
});
342338

343339
/**
344-
* Rendering mode. If `true`, an instance re-renders on each change event.
340+
* Scale function.
345341
*
346342
* @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
351346
*
352347
* @example
353348
* var node = new Rug({
354-
* 'autoRender': true
349+
* 'scale': function scale(){}
355350
* });
356351
*
357-
* var mode = node.autoRender;
358-
* // returns true
352+
* var f = node.scale;
353+
* // returns <Function>
359354
*/
360-
Object.defineProperty( Rug.prototype, 'autoRender', {
355+
Object.defineProperty( Rug.prototype, 'scale', {
361356
'configurable': false,
362357
'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' )
365360
});
366361

367362
/**
368-
* Function to map values to x coordinate values.
363+
* Tick (tassel) size.
369364
*
370365
* @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
373370
*
374371
* @example
375-
* var node = new Rug();
372+
* var node = new Rug({
373+
* 'size': 5
374+
* });
376375
*
377-
* var pos = node.pos;
378-
* // returns <Function>
376+
* var size = node.size;
377+
* // returns 5
379378
*/
380-
Object.defineProperty( Rug.prototype, 'pos', {
379+
Object.defineProperty( Rug.prototype, 'size', {
381380
'configurable': false,
382381
'enumerable': true,
383-
'get': require( './props/pos/get.js' )
382+
'set': require( './props/size/set.js' ),
383+
'get': require( './props/size/get.js' )
384384
});
385385

386386
/**

0 commit comments

Comments
 (0)