@@ -19,7 +19,7 @@ var templatedArray = require('../../plot_api/plot_template').templatedArray;
19
19
20
20
var fontAttr = fontAttrs ( {
21
21
description : [
22
- 'Sets the icon text font.' ,
22
+ 'Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size) .' ,
23
23
'Has an effect only when `type` is set to *symbol*.'
24
24
] . join ( ' ' )
25
25
} ) ;
@@ -71,21 +71,21 @@ var attrs = module.exports = overrideAll({
71
71
valType : 'number' ,
72
72
dflt : 1 ,
73
73
role : 'info' ,
74
- description : 'Sets the zoom level of the map.'
74
+ description : 'Sets the zoom level of the map (mapbox.zoom) .'
75
75
} ,
76
76
bearing : {
77
77
valType : 'number' ,
78
78
dflt : 0 ,
79
79
role : 'info' ,
80
- description : 'Sets the bearing angle of the map ( in degrees counter-clockwise from North).'
80
+ description : 'Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing ).'
81
81
} ,
82
82
pitch : {
83
83
valType : 'number' ,
84
84
dflt : 0 ,
85
85
role : 'info' ,
86
86
description : [
87
87
'Sets the pitch angle of the map' ,
88
- '(in degrees, where *0* means perpendicular to the surface of the map).'
88
+ '(in degrees, where *0* means perpendicular to the surface of the map) (mapbox.pitch) .'
89
89
] . join ( ' ' )
90
90
} ,
91
91
@@ -113,7 +113,7 @@ var attrs = module.exports = overrideAll({
113
113
valType : 'any' ,
114
114
role : 'info' ,
115
115
description : [
116
- 'Sets the source data for this layer.' ,
116
+ 'Sets the source data for this layer (mapbox.layer.source) .' ,
117
117
'Source can be either a URL,' ,
118
118
'a geojson object (with `sourcetype` set to *geojson*)' ,
119
119
'or an array of tile URLS (with `sourcetype` set to *vector*).'
@@ -125,7 +125,7 @@ var attrs = module.exports = overrideAll({
125
125
dflt : '' ,
126
126
role : 'info' ,
127
127
description : [
128
- 'Specifies the layer to use from a vector tile source.' ,
128
+ 'Specifies the layer to use from a vector tile source (mapbox.layer.source-layer) .' ,
129
129
'Required for *vector* source type that supports multiple layers.'
130
130
] . join ( ' ' )
131
131
} ,
@@ -136,7 +136,7 @@ var attrs = module.exports = overrideAll({
136
136
dflt : 'circle' ,
137
137
role : 'info' ,
138
138
description : [
139
- 'Sets the layer type.' ,
139
+ 'Sets the layer type (mapbox.layer.type) .' ,
140
140
'Support for *raster*, *background* types is coming soon.' ,
141
141
'Note that *line* and *fill* are not compatible with Point' ,
142
142
'GeoJSON geometries.'
@@ -161,10 +161,10 @@ var attrs = module.exports = overrideAll({
161
161
role : 'style' ,
162
162
description : [
163
163
'Sets the primary layer color.' ,
164
- 'If `type` is *circle*, color corresponds to the circle color' ,
165
- 'If `type` is *line*, color corresponds to the line color' ,
166
- 'If `type` is *fill*, color corresponds to the fill color' ,
167
- 'If `type` is *symbol*, color corresponds to the icon color'
164
+ 'If `type` is *circle*, color corresponds to the circle color (mapbox.layer.paint.circle-color) ' ,
165
+ 'If `type` is *line*, color corresponds to the line color (mapbox.layer.paint.line-color) ' ,
166
+ 'If `type` is *fill*, color corresponds to the fill color (mapbox.layer.paint.fill-color) ' ,
167
+ 'If `type` is *symbol*, color corresponds to the icon color (mapbox.layer.paint.icon-color) '
168
168
] . join ( ' ' )
169
169
} ,
170
170
opacity : {
@@ -173,7 +173,13 @@ var attrs = module.exports = overrideAll({
173
173
max : 1 ,
174
174
dflt : 1 ,
175
175
role : 'info' ,
176
- description : 'Sets the opacity of the layer.'
176
+ description : [
177
+ 'Sets the opacity of the layer.' ,
178
+ 'If `type` is *circle*, opacity corresponds to the circle opacity (mapbox.layer.paint.circle-opacity)' ,
179
+ 'If `type` is *line*, opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity)' ,
180
+ 'If `type` is *fill*, opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity)' ,
181
+ 'If `type` is *symbol*, opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)'
182
+ ] . join ( ' ' )
177
183
} ,
178
184
minzoom : {
179
185
valType : 'number' ,
@@ -182,8 +188,8 @@ var attrs = module.exports = overrideAll({
182
188
dflt : 0 ,
183
189
role : 'info' ,
184
190
description : [
185
- 'Sets the minimum zoom level.' ,
186
- 'At zoom levels less than the minzoom, the layer will be hidden.'
191
+ 'Sets the minimum zoom level (mapbox.layer.minzoom) .' ,
192
+ 'At zoom levels less than the minzoom, the layer will be hidden.' ,
187
193
] . join ( ' ' )
188
194
} ,
189
195
maxzoom : {
@@ -193,7 +199,7 @@ var attrs = module.exports = overrideAll({
193
199
dflt : 24 ,
194
200
role : 'info' ,
195
201
description : [
196
- 'Sets the maximum zoom level.' ,
202
+ 'Sets the maximum zoom level (mapbox.layer.maxzoom) .' ,
197
203
'At zoom levels equal to or greater than the maxzoom, the layer will be hidden.'
198
204
] . join ( ' ' )
199
205
} ,
@@ -205,7 +211,7 @@ var attrs = module.exports = overrideAll({
205
211
dflt : 15 ,
206
212
role : 'style' ,
207
213
description : [
208
- 'Sets the circle radius.' ,
214
+ 'Sets the circle radius (mapbox.layer.paint.circle-radius) .' ,
209
215
'Has an effect only when `type` is set to *circle*.'
210
216
] . join ( ' ' )
211
217
}
@@ -217,7 +223,15 @@ var attrs = module.exports = overrideAll({
217
223
dflt : 2 ,
218
224
role : 'style' ,
219
225
description : [
220
- 'Sets the line width.' ,
226
+ 'Sets the line width (mapbox.layer.paint.line-width).' ,
227
+ 'Has an effect only when `type` is set to *line*.'
228
+ ] . join ( ' ' )
229
+ } ,
230
+ dash : {
231
+ valType : 'data_array' ,
232
+ role : 'style' ,
233
+ description : [
234
+ 'Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray).' ,
221
235
'Has an effect only when `type` is set to *line*.'
222
236
] . join ( ' ' )
223
237
}
@@ -229,7 +243,7 @@ var attrs = module.exports = overrideAll({
229
243
dflt : defaultLine ,
230
244
role : 'style' ,
231
245
description : [
232
- 'Sets the fill outline color.' ,
246
+ 'Sets the fill outline color (mapbox.layer.paint.fill-outline-color) .' ,
233
247
'Has an effect only when `type` is set to *fill*.'
234
248
] . join ( ' ' )
235
249
}
@@ -241,7 +255,7 @@ var attrs = module.exports = overrideAll({
241
255
dflt : 'marker' ,
242
256
role : 'style' ,
243
257
description : [
244
- 'Sets the symbol icon image.' ,
258
+ 'Sets the symbol icon image (mapbox.layer.layout.icon-image) .' ,
245
259
'Full list: https://www.mapbox.com/maki-icons/'
246
260
] . join ( ' ' )
247
261
} ,
@@ -250,7 +264,7 @@ var attrs = module.exports = overrideAll({
250
264
dflt : 10 ,
251
265
role : 'style' ,
252
266
description : [
253
- 'Sets the symbol icon size.' ,
267
+ 'Sets the symbol icon size (mapbox.layer.layout.icon-size) .' ,
254
268
'Has an effect only when `type` is set to *symbol*.'
255
269
] . join ( ' ' )
256
270
} ,
@@ -259,7 +273,7 @@ var attrs = module.exports = overrideAll({
259
273
dflt : '' ,
260
274
role : 'info' ,
261
275
description : [
262
- 'Sets the symbol text.'
276
+ 'Sets the symbol text (mapbox.layer.layout.text-field) .'
263
277
] . join ( ' ' )
264
278
} ,
265
279
placement : {
@@ -268,7 +282,7 @@ var attrs = module.exports = overrideAll({
268
282
dflt : 'point' ,
269
283
role : 'info' ,
270
284
description : [
271
- 'Sets the symbol placement.' ,
285
+ 'Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement) .' ,
272
286
'If `placement` is *point*, the label is placed where the geometry is located' ,
273
287
'If `placement` is *line*, the label is placed along the line of the geometry' ,
274
288
'If `placement` is *line-center*, the label is placed on the center of the geometry' ,
0 commit comments