Methods

addGroup(groupId, layers, beforeId)

index.js, line 41

Add a layer group to the map.

Parameters:

Name	Type	Description
groupId	string	The id of the new group (use group/sub-group format to create a sub group)
layers	Array.<Object>	The Mapbox style spec layers of the new group
beforeId	string	The id of an existing layer or group to insert the new layers group before. If this argument is omitted, the layers group will be appended to the end of the layers array.

addLayerToGroup(groupId, layer, beforeId)

index.js, line 64

Add a single layer to an existing layer group.

Parameters:

Name	Type	Description
groupId	string	The id of group
layer	Object	The Mapbox style spec layer
beforeId	string	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 group.

createGroupId() → {string}

index.js, line 53

Create a group id from a list of group names.

Returns:

string -

group id

getGroupFirstLayerId(groupId) → {string}

index.js, line 140

Get the id of the first layer in a group.

Parameters:

Name	Type	Description
groupId	string	The id of the group.

Returns:

string

getGroupLastLayerId(groupId) → {string}

index.js, line 150

Get the id of the last layer in a group.

Parameters:

Name	Type	Description
groupId	string	The id of the group.

Returns:

string

getLayerGroupIds(id) → {array}

index.js, line 172

Get an array of group ids for a specified layer id.

Parameters:

Name	Type	Description
id	string	The layer id.

Returns:

array -

array of strings

getLayersInGroup(groupId) → {array}

index.js, line 181

List all layers that belongs to the group id.

Parameters:

Name	Type	Description
groupId	string	group id to test.

Returns:

array -

array of layers

moveGroup(groupId, beforeId)

index.js, line 126

Remove a layer group and all of its layers from the map.

Parameters:

Name	Type	Description
groupId	string	The id of the group to be moved.
beforeId	string	The id of an existing layer or group to insert the new layers group before. If this argument is omitted, the layer will be appended to the end of the layers array.

removeGroup(groupId)

index.js, line 113

Remove a layer group and all of its layers from the map.

Parameters:

Name	Type	Description
groupId	string	The id of the group to be removed.