Skip to content

Commit ca762e9

Browse files
committed
improve mapbox.* descriptions (take 2)
1 parent 14ace10 commit ca762e9

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

src/plots/mapbox/layout_attributes.js

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ var attrs = module.exports = overrideAll({
3939
description: [
4040
'Sets the mapbox access token to be used for this mapbox map.',
4141
'Alternatively, the mapbox access token can be set in the',
42-
'configuration options under `mapboxAccessToken`.'
42+
'configuration options under `mapboxAccessToken`.',
43+
'Note that accessToken are only required when `style`',
44+
'(e.g with values :', constants.styleValuesMapbox.join(', '), ')',
45+
'and/or a layout layer references the Mapbox server.'
4346
].join(' ')
4447
},
4548
style: {
@@ -48,12 +51,13 @@ var attrs = module.exports = overrideAll({
4851
dflt: constants.styleValueDflt,
4952
role: 'style',
5053
description: [
51-
'Sets the Mapbox base map style.',
54+
'Sets the base map style.',
5255
'Base map styles are rendered below all traces and layout layers.',
53-
'Either input one of the default Mapbox style names:', constants.styleValuesMapbox, '.',
56+
'Base map styles can include multiple layers.',
57+
'Either input one of the default Mapbox style names: ', constants.styleValuesMapbox.join(', '), '.',
5458
'Note that to use these, a Mapbox access token must be set either in the `accesstoken` attribute',
5559
'or in the `mapboxAccessToken` config option.',
56-
'From OpenStreetMap raster tiles, use:', constants.styleValueOSM, '.',
60+
'For OpenStreetMap raster tiles, use: ', constants.styleValueOSM, '.',
5761
'No access token is required to render the', constants.styleValueOSM, 'style.',
5862
'One can also set `style` as a URL to a Mapbox custom style, e.g. created in Mapbox Studio.',
5963
'Finally, one can set `style` as a Mapbox style JSON, see',
@@ -123,7 +127,7 @@ var attrs = module.exports = overrideAll({
123127
'Sets the source data for this layer (mapbox.layer.source).',
124128
'Source can be either a URL,',
125129
'a geojson object (with `sourcetype` set to *geojson*)',
126-
'or an array of tile URLS (with `sourcetype` set to *vector*).'
130+
'or an array of URLs (with `sourcetype` set to *vector* or *raster*).'
127131
].join(' ')
128132
},
129133

@@ -144,9 +148,11 @@ var attrs = module.exports = overrideAll({
144148
role: 'info',
145149
description: [
146150
'Sets the layer type (mapbox.layer.type).',
147-
'Support for *raster*, *background* types is coming soon.',
148-
'Note that *line* and *fill* are not compatible with Point',
149-
'GeoJSON geometries.'
151+
'With `sourcetype` set to *geojson*, *circle*, *line*, *fill* and *symbol* are available',
152+
'but note that *line* and *fill* are not compatible with Point',
153+
'GeoJSON geometries.',
154+
'With `sourcetype` set to *vector*, *circle*, *line*, *fill* and *symbol* are available.',
155+
'With `sourcetype` set to *raster* or `*image*`, only the *raster* value is available.'
150156
].join(' ')
151157
},
152158

0 commit comments

Comments
 (0)