Skip to content

Commit b3def92

Browse files
committed
Change default autoRender setting to false
1 parent a00635c commit b3def92

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

lib/node_modules/@stdlib/plot/ctor/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ var plot = new Plot( x, y );
6161

6262
The function accepts the following `options`:
6363

64-
- [**autoRender**](#prop-auto-render): `boolean` indicating whether to re-render on a `change` event. Default: `true`.
64+
- [**autoRender**](#prop-auto-render): `boolean` indicating whether to re-render on a `change` event. Default: `false`.
6565
- [**autoView**](#prop-auto-view): `boolean` indicating whether to generate an updated view on a `render` event. Default: `false`.
6666
- [**colors**](#prop-colors): data color(s). Default: `category10`.
6767
- [**description**](#prop-description): plot description. Default: `''`.
@@ -1438,7 +1438,8 @@ var h = plot( [x], [y], {
14381438
'height': 480,
14391439
'xScale': 'time',
14401440
'xTickFormat': '%H:%M',
1441-
'renderFormat': 'html'
1441+
'renderFormat': 'html',
1442+
'autoRender': true
14421443
});
14431444

14441445
// Render as a virtual DOM tree:

lib/node_modules/@stdlib/plot/ctor/examples/index.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ var plot = new Plot( [x], [y], {
4343
'height': 480,
4444
'xScale': 'time',
4545
'xTickFormat': '%H:%M',
46-
'renderFormat': 'html'
46+
'renderFormat': 'html',
47+
'autoRender': true
4748
});
4849

4950
// Render as a virtual DOM tree:

lib/node_modules/@stdlib/plot/ctor/lib/defaults.js

+4-10
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,11 @@ function defaults() {
4040
o = {};
4141

4242
// Boolean indicating whether to re-render on a change event:
43-
if ( isREPL ) {
44-
o.autoRender = false;
45-
} else {
46-
o.autoRender = true;
47-
}
43+
o.autoRender = false;
44+
4845
// Boolean indicating whether to generate an updated view on a render event:
49-
if ( isREPL ) {
50-
o.autoView = false;
51-
} else {
52-
o.autoView = false;
53-
}
46+
o.autoView = false;
47+
5448
// Data colors:
5549
o.colors = 'category10';
5650

lib/node_modules/@stdlib/plot/ctor/lib/main.js

+7-3
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ var merge = mergeFcn({
100100
* @param {Array} [x] - x-values
101101
* @param {Array} [y] - y-values
102102
* @param {Options} [options] - constructor options
103-
* @param {boolean} [options.autoRender=true] - indicates whether to re-render on a change event
103+
* @param {boolean} [options.autoRender=false] - indicates whether to re-render on a change event
104104
* @param {boolean} [options.autoView=false] - indicates whether to generate an updated view on a render event
105105
* @param {(string|StringArray)} [options.colors='category10'] - data colors
106106
* @param {string} [options.description=''] - plot description
@@ -1486,13 +1486,17 @@ Object.defineProperty( Plot.prototype, 'engine', {
14861486
});
14871487

14881488
/**
1489-
* Rendering mode. If `true`, an instance re-renders on each change event.
1489+
* Rendering mode.
1490+
*
1491+
* ## Notes
1492+
*
1493+
* - If `true`, an instance re-renders on each change event.
14901494
*
14911495
* @name autoRender
14921496
* @memberof Plot.prototype
14931497
* @type {boolean}
14941498
* @throws {TypeError} must be a boolean primitive
1495-
* @default true
1499+
* @default false
14961500
*
14971501
* @example
14981502
* var plot = new Plot({

0 commit comments

Comments
 (0)