Skip to content

Commit d763670

Browse files
kgrytekgryte
committed
Update REPL help
1 parent f4e56a6 commit d763670

2 files changed

Lines changed: 38 additions & 31 deletions

File tree

‎lib/node_modules/@stdlib/plot/ctor/docs/repl.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,14 +396,14 @@
396396
plot.engine
397397
Plot rendering engine. The following engines are supported: 'svg'.
398398

399-
plot.autoRender
400-
Rendering mode. If `true`, an instance renders on each 'change' event;
401-
otherwise, rendering must be triggered manually.
402-
403399
plot.renderFormat
404400
Plot render format. The following formats are supported: 'vdom' and
405401
'html'.
406402

403+
plot.autoRender
404+
Rendering mode. If `true`, an instance renders on each 'change' event;
405+
otherwise, rendering must be triggered manually.
406+
407407
plot.viewer
408408
Plot viewer. The following viewers are supported: 'none', 'stdout',
409409
'window', and 'browser'.

‎lib/node_modules/@stdlib/plot/docs/repl.txt‎

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@
6363
options.paddingTop: integer (optional)
6464
Top padding (in pixels). Default: 80.
6565

66+
options.renderFormat: string (optional)
67+
Plot render format. Must be one of 'vdom' or 'html'. Default: 'vdom'.
68+
6669
options.symbols: string|Array<string> (optional)
6770
Data symbols. Must be one of 'closed-circle', 'open-circle', or 'none'.
6871
Default: 'none'.
@@ -73,94 +76,94 @@
7376
options.symbolsSize: integer|Array<integer> (optional)
7477
Symbols size (in pixels). Default: 6.
7578

76-
title: string (optional)
79+
options.title: string (optional)
7780
Plot title.
7881

79-
viewer: string (optional)
82+
options.viewer: string (optional)
8083
Plot viewer. Must be one of 'browser', 'terminal', 'stdout', 'window',
8184
or 'none'. Default: 'none'.
8285

83-
width: number (optional)
86+
options.width: number (optional)
8487
Plot width (in pixels). Default: 400.
8588

86-
x: Array<Array>|Array<TypedArray> (optional)
89+
options.x: Array<Array>|Array<TypedArray> (optional)
8790
x-coordinate values.
8891

89-
xAxisOrient: string (optional)
92+
options.xAxisOrient: string (optional)
9093
x-axis orientation. Must be either 'bottom' or 'top'. Default: 'bottom'.
9194

92-
xLabel: string (optional)
95+
options.xLabel: string (optional)
9396
x-axis label. Default: 'x'.
9497

95-
xMax: number|null (optional)
98+
options.xMax: number|null (optional)
9699
Maximum value of the x-axis domain. If `null`, the maximum value is
97100
calculated from the data. Default: null.
98101

99-
xMin: number|null (optional)
102+
options.xMin: number|null (optional)
100103
Minimum value of the x-axis domain. If `null`, the minimum value is
101104
calculated from the data. Default: null.
102105

103-
xNumTicks: integer (optional)
106+
options.xNumTicks: integer (optional)
104107
Number of x-axis tick marks. Default: 5.
105108

106-
xRug: boolean|Array<boolean> (optional)
109+
options.xRug: boolean|Array<boolean> (optional)
107110
Boolean flag(s) indicating whether to render one or more rug plots along
108111
the x-axis.
109112

110-
xRugOrient: string|Array<string> (optional)
113+
options.xRugOrient: string|Array<string> (optional)
111114
x-axis rug plot orientation(s). Must be either 'bottom' or 'top'.
112115
Default: 'bottom'.
113116

114-
xRugOpacity: number|Array<number> (optional)
117+
options.xRugOpacity: number|Array<number> (optional)
115118
x-axis rug plot opacity. Must be on the interval [0,1]. Default: 0.1.
116119

117-
xRugSize: integer|Array<integer> (optional)
120+
options.xRugSize: integer|Array<integer> (optional)
118121
x-axis rug tick (tassel) size (in pixels). Default: 6.
119122

120-
xScale: string
123+
options.xScale: string
121124
x-axis scale. Default: 'linear'.
122125

123-
xTickFormat: string|null
126+
options.xTickFormat: string|null
124127
x-axis tick format. Default: null.
125128

126-
y: Array<Array>|Array<TypedArray> (optional)
129+
options.y: Array<Array>|Array<TypedArray> (optional)
127130
y-coordinate values.
128131

129-
yAxisOrient: string (optional)
132+
options.yAxisOrient: string (optional)
130133
x-axis orientation. Must be either 'left' or 'right'. Default: 'left'.
131134

132-
yLabel: string (optional)
135+
options.yLabel: string (optional)
133136
y-axis label. Default: 'y'.
134137

135-
yMax: number|null (optional)
138+
options.yMax: number|null (optional)
136139
Maximum value of the y-axis domain. If `null`, the maximum value is
137140
calculated from the data. Default: null.
138141

139-
yMin: number|null (optional)
142+
options.yMin: number|null (optional)
140143
Minimum value of the y-axis domain. If `null`, the minimum value is
141144
calculated from the data. Default: null.
142145

143-
yNumTicks: integer (optional)
146+
options.yNumTicks: integer (optional)
144147
Number of x-axis tick marks. Default: 5.
145148

146-
yRug: boolean|Array<boolean> (optional)
149+
options.yRug: boolean|Array<boolean> (optional)
147150
Boolean flag(s) indicating whether to render one or more rug plots along
148151
the y-axis.
149152

150-
yRugOrient: string|Array<string> (optional)
153+
options.yRugOrient: string|Array<string> (optional)
151154
y-axis rug plot orientation(s). Must be either 'left' or 'right'.
152155
Default: 'left'.
153156

154-
yRugOpacity: number|Array<number> (optional)
157+
options.yRugOpacity: number|Array<number> (optional)
155158
y-axis rug plot opacity. Must be on the interval [0,1]. Default: 0.1.
156159

157-
yRugSize: integer|Array<integer> (optional)
160+
options.yRugSize: integer|Array<integer> (optional)
158161
y-axis rug tick (tassel) size (in pixels). Default: 6.
159162

160-
yScale: string
163+
options.yScale: string
161164
y-axis scale. Default: 'linear'.
162165

163-
yTickFormat: string|null
166+
options.yTickFormat: string|null
164167
y-axis tick format. Default: null.
165168

166169
Returns
@@ -393,6 +396,10 @@
393396
plot.engine
394397
Plot rendering engine. The following engines are supported: 'svg'.
395398

399+
plot.renderFormat
400+
Plot render format. The following formats are supported: 'vdom' and
401+
'html'.
402+
396403
plot.autoRender
397404
Rendering mode. If `true`, an instance renders on each 'change' event;
398405
otherwise, rendering must be triggered manually.

0 commit comments

Comments
 (0)