Skip to content

Commit

Permalink
Merge pull request #4756 from plotly/update-master-with-docs-changes
Browse files Browse the repository at this point in the history
Update master with docs changes
  • Loading branch information
LiamConnors authored Sep 9, 2024
2 parents 8549715 + 2d6efec commit 85bad44
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 10 deletions.
3 changes: 3 additions & 0 deletions doc/apidoc/plotly.graph_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ Map Traces

Scattergeo
Choropleth
Scattermap
Choroplethmap
Densitymap
Scattermapbox
Choroplethmapbox
Densitymapbox
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ fig.show()

> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
The earlier examples using `px.density_mapbox` and `go.Densitymap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24. These trace types are now the recommended way to make tile-based density heatmaps. There are also traces that use [Mapbox](https://docs.mapbox.com): `density_mapbox` and `go.Densitymapbox`.
The earlier examples using `px.density_map` and `go.Densitymap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24. These trace types are now the recommended way to make tile-based density heatmaps. There are also traces that use [Mapbox](https://docs.mapbox.com): `density_mapbox` and `go.Densitymapbox`.

To use these trace types, in some cases you _may_ need a Mapbox account and a public [Mapbox Access Token](https://www.mapbox.com/studio). See our [Mapbox Map Layers](/python/mapbox-layers/) documentation for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jupyter:
display_as: maps
language: python
layout: base
name: Filled Area on Maps
name: Filled Area on Tile Maps
order: 4
page_type: example_index
permalink: python/filled-area-tile-maps/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ jupyter:
display_as: maps
language: python
layout: base
name: Lines on Maps
name: Lines on Tile Maps
order: 3
page_type: example_index
permalink: python/lines-on-tile-maps/
redirect_from: python/lines-on-mapbox/
thumbnail: thumbnail/line_mapbox.jpg
---

### Lines on maps using Plotly Express
### Lines on tile maps using Plotly Express

To draw a line on a map, you either can use `px.line_map` in Plotly Express, or `go.Scattermap` in Plotly Graph Objects. Here's an example of drawing a line on a tile-based map using Plotly Express.

Expand Down
2 changes: 1 addition & 1 deletion doc/python/map-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Plotly supports two different kinds of maps:

- **[Tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map)**

If your figure is created with a `px.scatter_map`, `px.scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`,`go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox` the `layout.map` object in your figure contains configuration information for the map itself.
If your figure is created with a `px.scatter_map`, `px.scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`, `go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox`, the `layout.map` object in your figure contains configuration information for the map itself.

- **Outline-based maps**

Expand Down
2 changes: 1 addition & 1 deletion doc/python/smoothing.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ fig.add_trace(go.Scatter(

fig.add_trace(go.Scatter(
x=x,
y=signal.savgol_filter(y,
y=signal.savgol_filter(y_noise,
53, # window size used for filtering
3), # order of fitted polynomial
mode='markers',
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions doc/python/mapbox-layers.md → doc/python/tile-map-layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ jupyter:
name: Tile Map Layers
order: 9
page_type: u-guide
permalink: /python/tile-map-layers/
redirect_from: /python/mapbox-layers/
permalink: python/tile-map-layers/
redirect_from: python/mapbox-layers/
thumbnail: thumbnail/mapbox-layers.png
---

Expand All @@ -42,7 +42,7 @@ Plotly supports two different kinds of maps:

- **[Tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map)**

If your figure is created with a `px.scatter_map`, `px_scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`,`go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox` the `layout.map` or `layout.mapbox` object in your figure contains configuration information for the map itself.
If your figure is created with a `px.scatter_map`, `px_scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`, `go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox`, the `layout.map` or `layout.mapbox` object in your figure contains configuration information for the map itself.

- **Outline-based maps**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jupyter:
display_as: maps
language: python
layout: base
name: Scatter Plots on Mapbox
name: Scatter Plots on Tile Maps
order: 10
page_type: u-guide
permalink: python/tile-scatter-maps/
Expand Down Expand Up @@ -303,6 +303,7 @@ fig.show()
## Mapbox Maps

> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
The earlier examples using `px.scatter_map` and `go.Scattermap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24 and are now the recommended way to create scatter plots on tile-based maps. There are also traces that use [Mapbox](https://docs.mapbox.com): `px.scatter_mapbox` and `go.Scattermapbox`

To plot on Mapbox maps with Plotly you _may_ need a Mapbox account and a public [Mapbox Access Token](https://www.mapbox.com/studio). See our [Mapbox Map Layers](/python/mapbox-layers/) documentation for more information.
Expand Down

0 comments on commit 85bad44

Please sign in to comment.