Skip to content

Commit

Permalink
[docsprint] Clarify how map.moveLayer works (#9566)
Browse files Browse the repository at this point in the history
* clarify how map.moveLayer works

* fix wording

* small wording fix

* fix id capitalization
  • Loading branch information
Mal Wood-Santoro authored Apr 20, 2020
1 parent 0f4a3f0 commit ce1e98d
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/ui/map.js
Original file line number Diff line number Diff line change
Expand Up @@ -1790,13 +1790,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

0 comments on commit ce1e98d

Please sign in to comment.