Skip to content
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

Jump to bottom

[docsprint] Clarify how map.moveLayer works #9566

Merged
merged 4 commits into from
Apr 20, 2020
Merged

[docsprint] Clarify how map.moveLayer works #9566

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c06b83
clarify how map.moveLayer works
malwoodsantoro Apr 15, 2020
790220e
fix wording
malwoodsantoro Apr 15, 2020
24fcc56
small wording fix
malwoodsantoro Apr 15, 2020
a9ff27c
fix id capitalization
malwoodsantoro Apr 15, 2020
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
7 changes: 3 additions & 4 deletions src/ui/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1704,13 +1704,12 @@ class Map extends Camera {
* Moves a layer to a different z-position.
*
* @param {string} id The ID of the layer to move.
* @param {string} [beforeId] The ID of an existing layer to insert the new layer before.
* If this argument is omitted, the layer will be appended to the end of the layers array.
* @param {string} [beforeId] The ID of an existing layer to insert the new layer before. When viewing the map, the `id` layer will appear beneath the `beforeId` layer. If `beforeId` is omitted, the layer will be appended to the end of the layers array and appear above all other layers on the map.
* @returns {Map} `this`
*
* @example
* // Move a layer with ID 'label' before the layer with ID 'waterways'.
* map.moveLayer('label', 'waterways');
* // Move a layer with ID 'polygon' before the layer with ID 'country-label'. The `polygon` layer will appear beneath the `country-label` layer on the map.
* map.moveLayer('polygon', 'country-label');
*/
moveLayer(id: string, beforeId?: string) {
this.style.moveLayer(id, beforeId);
Expand Down