Skip to content

Commit 538b3db

Browse files
committed
Updated more verbose color attribute descriptions
1 parent 826ed94 commit 538b3db

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

src/traces/scatter/attributes.js

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,12 @@ module.exports = {
200200
valType: 'color',
201201
arrayOk: true,
202202
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(' ')
204209
},
205210
maxdisplayed: {
206211
valType: 'number',
@@ -247,15 +252,16 @@ module.exports = {
247252
valType: 'colorscale',
248253
role: 'style',
249254
description: [
250-
'Sets the colorscale.',
255+
'Sets the colorscale and only has an effect',
256+
'if `marker.color` is set to a numerical array.',
251257
'The colorscale must be an array containing',
252258
'arrays mapping a normalized value to an',
253259
'rgb, rgba, hex, hsl, hsv, or named color string.',
254260
'At minimum, a mapping for the lowest (0) and highest (1)',
255261
'values are required. For example,',
256262
'`[[0, \'rgb(0,0,255)\', [1, \'rgb(255,0,0)\']]`.',
257263
'To control the bounds of the colorscale in color space,',
258-
'use cmin and cmax'
264+
'use `marker.cmin` and `marker.cmax`.'
259265
].join(' ')
260266
},
261267
cauto: {
@@ -274,7 +280,8 @@ module.exports = {
274280
role: 'info',
275281
description: [
276282
'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.'
278285
].join(' ')
279286
},
280287
cmin: {
@@ -283,7 +290,8 @@ module.exports = {
283290
role: 'info',
284291
description: [
285292
'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.'
287295
].join(' ')
288296
},
289297
autocolorscale: {
@@ -319,7 +327,12 @@ module.exports = {
319327
valType: 'color',
320328
arrayOk: true,
321329
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(' ')
323336
},
324337
width: {
325338
valType: 'number',
@@ -332,8 +345,16 @@ module.exports = {
332345
valType: 'colorscale',
333346
role: 'style',
334347
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`.'
337358
].join(' ')
338359
},
339360
cauto: {
@@ -352,7 +373,8 @@ module.exports = {
352373
role: 'info',
353374
description: [
354375
'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.'
356378
].join(' ')
357379
},
358380
cmin: {
@@ -361,7 +383,8 @@ module.exports = {
361383
role: 'info',
362384
description: [
363385
'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.'
365388
].join(' ')
366389
},
367390
autocolorscale: {

0 commit comments

Comments
 (0)