@@ -200,7 +200,12 @@ module.exports = {
200
200
valType : 'color' ,
201
201
arrayOk : true ,
202
202
role : 'style' ,
203
- description : 'Sets the marker color.'
203
+ description : [
204
+ 'Sets the marker color. It accepts either a specific color' ,
205
+ 'or an array of values that are mapped to the colorscale' ,
206
+ 'relative to the max and min values of the array or relative to' ,
207
+ '`cmin` and `cmax` if set.'
208
+ ] . join ( ' ' )
204
209
} ,
205
210
maxdisplayed : {
206
211
valType : 'number' ,
@@ -247,15 +252,16 @@ module.exports = {
247
252
valType : 'colorscale' ,
248
253
role : 'style' ,
249
254
description : [
250
- 'Sets the colorscale.' ,
255
+ 'Sets the colorscale and only has an effect' ,
256
+ 'if `marker.color` is set to a numerical array.' ,
251
257
'The colorscale must be an array containing' ,
252
258
'arrays mapping a normalized value to an' ,
253
259
'rgb, rgba, hex, hsl, hsv, or named color string.' ,
254
260
'At minimum, a mapping for the lowest (0) and highest (1)' ,
255
261
'values are required. For example,' ,
256
262
'`[[0, \'rgb(0,0,255)\', [1, \'rgb(255,0,0)\']]`.' ,
257
263
'To control the bounds of the colorscale in color space,' ,
258
- 'use cmin and cmax'
264
+ 'use `marker. cmin` and `marker. cmax`. '
259
265
] . join ( ' ' )
260
266
} ,
261
267
cauto : {
@@ -274,7 +280,8 @@ module.exports = {
274
280
role : 'info' ,
275
281
description : [
276
282
'Has only an effect if `marker.color` is set to a numerical array.' ,
277
- 'Sets the upper bound of the color domain.'
283
+ 'Sets the upper bound of the color domain.' ,
284
+ 'Value should be associated to the `marker.color` array index.'
278
285
] . join ( ' ' )
279
286
} ,
280
287
cmin : {
@@ -283,7 +290,8 @@ module.exports = {
283
290
role : 'info' ,
284
291
description : [
285
292
'Has only an effect if `marker.color` is set to a numerical array.' ,
286
- 'Sets the lower bound of the color domain.'
293
+ 'Sets the lower bound of the color domain.' ,
294
+ 'Value should be associated to the `marker.color` array index.'
287
295
] . join ( ' ' )
288
296
} ,
289
297
autocolorscale : {
@@ -319,7 +327,12 @@ module.exports = {
319
327
valType : 'color' ,
320
328
arrayOk : true ,
321
329
role : 'style' ,
322
- description : 'Sets the color of the lines bounding the marker points.'
330
+ description : [
331
+ 'Sets the marker outline color. It accepts either a specific color' ,
332
+ 'or an array of values that are mapped to the colorscale' ,
333
+ 'relative to the max and min values of the array or relative to' ,
334
+ '`cmin` and `cmax` if set.'
335
+ ] . join ( ' ' )
323
336
} ,
324
337
width : {
325
338
valType : 'number' ,
@@ -332,8 +345,16 @@ module.exports = {
332
345
valType : 'colorscale' ,
333
346
role : 'style' ,
334
347
description : [
335
- 'Has only an effect if `marker.line.color` is set to a numerical array.' ,
336
- 'Sets the colorscale.'
348
+ 'Sets the colorscale and only has an effect' ,
349
+ 'if `marker.line.color` is set to a numerical array.' ,
350
+ 'The colorscale must be an array containing' ,
351
+ 'arrays mapping a normalized value to an' ,
352
+ 'rgb, rgba, hex, hsl, hsv, or named color string.' ,
353
+ 'At minimum, a mapping for the lowest (0) and highest (1)' ,
354
+ 'values are required. For example,' ,
355
+ '`[[0, \'rgb(0,0,255)\', [1, \'rgb(255,0,0)\']]`.' ,
356
+ 'To control the bounds of the colorscale in color space,' ,
357
+ 'use `marker.line.cmin` and `marker.line.cmax`.'
337
358
] . join ( ' ' )
338
359
} ,
339
360
cauto : {
@@ -352,7 +373,8 @@ module.exports = {
352
373
role : 'info' ,
353
374
description : [
354
375
'Has only an effect if `marker.line.color` is set to a numerical array.' ,
355
- 'Sets the upper bound of the color domain.'
376
+ 'Sets the upper bound of the color domain.' ,
377
+ 'Value should be associated to the `marker.line.color` array index.'
356
378
] . join ( ' ' )
357
379
} ,
358
380
cmin : {
@@ -361,7 +383,8 @@ module.exports = {
361
383
role : 'info' ,
362
384
description : [
363
385
'Has only an effect if `marker.line.color` is set to a numerical array.' ,
364
- 'Sets the lower bound of the color domain.'
386
+ 'Sets the lower bound of the color domain.' ,
387
+ 'Value should be associated to the `marker.line.color` array index.'
365
388
] . join ( ' ' )
366
389
} ,
367
390
autocolorscale : {
0 commit comments