Skip to content

Expose mapbox minzoom, maxzoom, and symbol-placement properties #3399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 19, 2019
Merged

Expose mapbox minzoom, maxzoom, and symbol-placement properties #3399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b4dfd57
Expose mapbox minzoom, maxzoom, and symbol-placement properties
rockg Jan 4, 2019
3fb5dd3
Support dash-array, add mapbox mapping, and mock
rockg Feb 19, 2019
f99527b
Trailing newline
rockg Feb 19, 2019
89d873a
add baseline for mapbox_geojson-attributes mock
etpinard Feb 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/plots/mapbox/layers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ proto.updateLayer = function(opts) {
source: this.idSource,
'source-layer': opts.sourcelayer || '',
type: opts.type,
minzoom: opts.minzoom,
maxzoom: opts.maxzoom,
layout: convertedOpts.layout,
paint: convertedOpts.paint
}, opts.below);
Expand Down Expand Up @@ -151,7 +153,8 @@ function convertOpts(opts) {
Lib.extendFlat(paint, {
'line-width': opts.line.width,
'line-color': opts.color,
'line-opacity': opts.opacity
'line-opacity': opts.opacity,
'line-dasharray': opts.line.dash
});
break;

Expand All @@ -176,7 +179,8 @@ function convertOpts(opts) {
'text-field': symbol.text,
'text-size': symbol.textfont.size,
'text-anchor': textOpts.anchor,
'text-offset': textOpts.offset
'text-offset': textOpts.offset,
'symbol-placement': symbol.placement,

// TODO font family
// 'text-font': symbol.textfont.family.split(', '),
Expand Down
84 changes: 66 additions & 18 deletions src/plots/mapbox/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ var templatedArray = require('../../plot_api/plot_template').templatedArray;

var fontAttr = fontAttrs({
description: [
'Sets the icon text font.',
'Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size).',
'Has an effect only when `type` is set to *symbol*.'
].join(' ')
});
Expand Down Expand Up @@ -71,21 +71,21 @@ var attrs = module.exports = overrideAll({
valType: 'number',
dflt: 1,
role: 'info',
description: 'Sets the zoom level of the map.'
description: 'Sets the zoom level of the map (mapbox.zoom).'
},
bearing: {
valType: 'number',
dflt: 0,
role: 'info',
description: 'Sets the bearing angle of the map (in degrees counter-clockwise from North).'
description: 'Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).'
},
pitch: {
valType: 'number',
dflt: 0,
role: 'info',
description: [
'Sets the pitch angle of the map',
'(in degrees, where *0* means perpendicular to the surface of the map).'
'(in degrees, where *0* means perpendicular to the surface of the map) (mapbox.pitch).'
].join(' ')
},

Expand Down Expand Up @@ -113,7 +113,7 @@ var attrs = module.exports = overrideAll({
valType: 'any',
role: 'info',
description: [
'Sets the source data for this layer.',
'Sets the source data for this layer (mapbox.layer.source).',
'Source can be either a URL,',
'a geojson object (with `sourcetype` set to *geojson*)',
'or an array of tile URLS (with `sourcetype` set to *vector*).'
Expand All @@ -125,7 +125,7 @@ var attrs = module.exports = overrideAll({
dflt: '',
role: 'info',
description: [
'Specifies the layer to use from a vector tile source.',
'Specifies the layer to use from a vector tile source (mapbox.layer.source-layer).',
'Required for *vector* source type that supports multiple layers.'
].join(' ')
},
Expand All @@ -136,7 +136,7 @@ var attrs = module.exports = overrideAll({
dflt: 'circle',
role: 'info',
description: [
'Sets the layer type.',
'Sets the layer type (mapbox.layer.type).',
'Support for *raster*, *background* types is coming soon.',
'Note that *line* and *fill* are not compatible with Point',
'GeoJSON geometries.'
Expand All @@ -161,10 +161,10 @@ var attrs = module.exports = overrideAll({
role: 'style',
description: [
'Sets the primary layer color.',
'If `type` is *circle*, color corresponds to the circle color',
'If `type` is *line*, color corresponds to the line color',
'If `type` is *fill*, color corresponds to the fill color',
'If `type` is *symbol*, color corresponds to the icon color'
'If `type` is *circle*, color corresponds to the circle color (mapbox.layer.paint.circle-color)',
'If `type` is *line*, color corresponds to the line color (mapbox.layer.paint.line-color)',
'If `type` is *fill*, color corresponds to the fill color (mapbox.layer.paint.fill-color)',
'If `type` is *symbol*, color corresponds to the icon color (mapbox.layer.paint.icon-color)'
].join(' ')
},
opacity: {
Expand All @@ -173,7 +173,35 @@ var attrs = module.exports = overrideAll({
max: 1,
dflt: 1,
role: 'info',
description: 'Sets the opacity of the layer.'
description: [
'Sets the opacity of the layer.',
'If `type` is *circle*, opacity corresponds to the circle opacity (mapbox.layer.paint.circle-opacity)',
'If `type` is *line*, opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity)',
'If `type` is *fill*, opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity)',
'If `type` is *symbol*, opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)'
].join(' ')
},
minzoom: {
valType: 'number',
min: 0,
max: 24,
dflt: 0,
role: 'info',
description: [
'Sets the minimum zoom level (mapbox.layer.minzoom).',
'At zoom levels less than the minzoom, the layer will be hidden.',
].join(' ')
},
maxzoom: {
valType: 'number',
min: 0,
max: 24,
dflt: 24,
role: 'info',
description: [
'Sets the maximum zoom level (mapbox.layer.maxzoom).',
'At zoom levels equal to or greater than the maxzoom, the layer will be hidden.'
].join(' ')
},

// type-specific style attributes
Expand All @@ -183,7 +211,7 @@ var attrs = module.exports = overrideAll({
dflt: 15,
role: 'style',
description: [
'Sets the circle radius.',
'Sets the circle radius (mapbox.layer.paint.circle-radius).',
'Has an effect only when `type` is set to *circle*.'
].join(' ')
}
Expand All @@ -195,7 +223,15 @@ var attrs = module.exports = overrideAll({
dflt: 2,
role: 'style',
description: [
'Sets the line width.',
'Sets the line width (mapbox.layer.paint.line-width).',
'Has an effect only when `type` is set to *line*.'
].join(' ')
},
dash: {
valType: 'data_array',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does mapbox.layer.paint.line-dasharray also support scalars?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Optional array of numbers greater than or equal to 0" here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

role: 'style',
description: [
'Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray).',
'Has an effect only when `type` is set to *line*.'
].join(' ')
}
Expand All @@ -207,7 +243,7 @@ var attrs = module.exports = overrideAll({
dflt: defaultLine,
role: 'style',
description: [
'Sets the fill outline color.',
'Sets the fill outline color (mapbox.layer.paint.fill-outline-color).',
'Has an effect only when `type` is set to *fill*.'
].join(' ')
}
Expand All @@ -219,7 +255,7 @@ var attrs = module.exports = overrideAll({
dflt: 'marker',
role: 'style',
description: [
'Sets the symbol icon image.',
'Sets the symbol icon image (mapbox.layer.layout.icon-image).',
'Full list: https://www.mapbox.com/maki-icons/'
].join(' ')
},
Expand All @@ -228,7 +264,7 @@ var attrs = module.exports = overrideAll({
dflt: 10,
role: 'style',
description: [
'Sets the symbol icon size.',
'Sets the symbol icon size (mapbox.layer.layout.icon-size).',
'Has an effect only when `type` is set to *symbol*.'
].join(' ')
},
Expand All @@ -237,7 +273,19 @@ var attrs = module.exports = overrideAll({
dflt: '',
role: 'info',
description: [
'Sets the symbol text.'
'Sets the symbol text (mapbox.layer.layout.text-field).'
].join(' ')
},
placement: {
valType: 'enumerated',
values: ['point', 'line', 'line-center'],
dflt: 'point',
role: 'info',
description: [
'Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement).',
'If `placement` is *point*, the label is placed where the geometry is located',
'If `placement` is *line*, the label is placed along the line of the geometry',
'If `placement` is *line-center*, the label is placed on the center of the geometry',
].join(' ')
},
textfont: fontAttr,
Expand Down
4 changes: 4 additions & 0 deletions src/plots/mapbox/layout_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,16 @@ function handleLayerDefaults(layerIn, layerOut) {
coerce('below');
coerce('color');
coerce('opacity');
coerce('minzoom');
coerce('maxzoom');

if(type === 'circle') {
coerce('circle.radius');
}

if(type === 'line') {
coerce('line.width');
coerce('line.dash');
}

if(type === 'fill') {
Expand All @@ -82,6 +85,7 @@ function handleLayerDefaults(layerIn, layerOut) {
coerce('symbol.text');
Lib.coerceFont(coerce, 'symbol.textfont');
coerce('symbol.textposition');
coerce('symbol.placement');
}
}
}
Binary file added test/image/baselines/mapbox_geojson-attributes.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions test/image/mocks/mapbox_geojson-attributes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"data": [
{
"type": "scattermapbox"
}
],
"layout": {
"mapbox": {
"style": "outdoors",
"layers": [
{
"sourcetype": "geojson",
"type": "line",
"minzoom": 4,
"maxzoom": 12,
"color": "gray",
"line": {
"dash": [2.5, 1]
},
"source": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [[-0.5, 52], [0.5, 50]]
},
"properties": {
"title": "Line Text Example"
}
}
]
}
},
{
"sourcetype": "geojson",
"type": "symbol",
"symbol": {
"text": "{title}",
"textfont": {
"size": 10,
"color": "red"
},
"iconsize": 0,
"placement": "line"
},
"source": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [[-0.5, 52], [0.5, 50]]
},
"properties": {
"title": "Line Text Example"
}
}
]
}
}
],
"zoom": 5,
"center": {
"lon": 0,
"lat": 51
}
},
"showlegend": false,
"height": 450,
"width": 1100,
"autosize": true
}
}