Skip to content

Commit b933528

Browse files
committed
mprove mapbox.style description (take 3)
1 parent 81f9d53 commit b933528

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

src/plots/mapbox/layout_attributes.js

+19-10
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,26 @@ var attrs = module.exports = overrideAll({
5151
dflt: constants.styleValueDflt,
5252
role: 'style',
5353
description: [
54-
'Sets the base map style.',
55-
'Base map styles are rendered below all traces and layout layers.',
56-
'Base map styles can include multiple layers.',
57-
'Either input one of the default Mapbox style names: ', constants.styleValuesMapbox.join(', '), '.',
58-
'Note that to use these, a Mapbox access token must be set either in the `accesstoken` attribute',
54+
'Defines the map layers that are rendered by default below the trace layers defined in `data`,',
55+
'which are themselves by default rendered below the layers defined in `layout.mapbox.layers`.',
56+
'',
57+
'These layers can be defined either explicitly as a Mapbox Style object which can contain multiple',
58+
'layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS)',
59+
'or implicitly by using one of the built-in style objects which use WMSes which do not require any',
60+
'access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of',
61+
'which require a Mapbox access token',
62+
'',
63+
'Note that Mapbox access token can be set in the `accesstoken` attribute',
5964
'or in the `mapboxAccessToken` config option.',
60-
'For OpenStreetMap raster tiles, use: ', constants.styleValueOSM, '.',
61-
'No access token is required to render the', constants.styleValueOSM, 'style.',
62-
'One can also set `style` as a URL to a Mapbox custom style, e.g. created in Mapbox Studio.',
63-
'Finally, one can set `style` as a Mapbox style JSON, see',
64-
'https://docs.mapbox.com/mapbox-gl-js/style-spec for more info.'
65+
'',
66+
'Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at',
67+
'https://docs.mapbox.com/mapbox-gl-js/style-spec',
68+
'',
69+
'The built-in plotly.js styles objects are:', constants.styleValuesNonMapbox.join(', '),
70+
'',
71+
'The built-in Mapbox styles are:', constants.styleValuesMapbox.join(', '),
72+
'',
73+
'Mapbox style URLs are of the form: mapbox://mapbox.mapbox-<name>-<version>'
6574
].join(' ')
6675
},
6776

0 commit comments

Comments
 (0)