Skip to content

Commit 14ace10

Browse files
committed
improve mapbox.style description
1 parent 323e79a commit 14ace10

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/plots/mapbox/layout_attributes.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,16 @@ var attrs = module.exports = overrideAll({
4848
dflt: constants.styleValueDflt,
4949
role: 'style',
5050
description: [
51-
'Sets the Mapbox map style.',
52-
'Either input one of the default Mapbox style names or the URL to a custom style',
53-
'or a valid Mapbox style JSON.',
54-
'From OpenStreetMap raster tiles, use *open-street-map*.'
51+
'Sets the Mapbox base map style.',
52+
'Base map styles are rendered below all traces and layout layers.',
53+
'Either input one of the default Mapbox style names:', constants.styleValuesMapbox, '.',
54+
'Note that to use these, a Mapbox access token must be set either in the `accesstoken` attribute',
55+
'or in the `mapboxAccessToken` config option.',
56+
'From OpenStreetMap raster tiles, use:', constants.styleValueOSM, '.',
57+
'No access token is required to render the', constants.styleValueOSM, 'style.',
58+
'One can also set `style` as a URL to a Mapbox custom style, e.g. created in Mapbox Studio.',
59+
'Finally, one can set `style` as a Mapbox style JSON, see',
60+
'https://docs.mapbox.com/mapbox-gl-js/style-spec for more info.'
5561
].join(' ')
5662
},
5763

0 commit comments

Comments
 (0)