Style
Defined in: style/style.ts:166
The Style base class
Extends
Methods
addLayer()
addLayer(
layerObject:AddLayerObject,before?:string,options?:StyleSetterOptions):this
Defined in: style/style.ts:697
Add a layer to the map style. The layer will be inserted before the layer with
ID before, or appended if before is omitted.
Parameters
| Parameter | Type | Description |
|---|---|---|
layerObject |
AddLayerObject |
The style layer to add. |
before? |
string |
ID of an existing layer to insert before |
options? |
StyleSetterOptions |
Style setter options. |
Returns
this
getLayer()
getLayer(
id:string):StyleLayer
Defined in: style/style.ts:887
Return the style layer object with the given id.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
id of the desired layer |
Returns
a layer, if one with the given id exists
getLayersOrder()
getLayersOrder():
string[]
Defined in: style/style.ts:896
Return the ids of all layers currently in the style, including custom layers, in order.
Returns
string[]
ids of layers, in order
getSource()
getSource(
id:string):Source
Defined in: style/style.ts:686
Get a source by ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
ID of the desired source |
Returns
source
hasLayer()
hasLayer(
id:string):boolean
Defined in: style/style.ts:906
Checks if a specific layer is present within the style.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
the id of the desired layer |
Returns
boolean
a boolean specifying if the given layer is present
listens()
listens(
type:string):boolean
Defined in: util/evented.ts:167
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type |
Returns
boolean
true if there is at least one registered listener for specified event type, false otherwise
Inherited from
moveLayer()
moveLayer(
id:string,before?:string):void
Defined in: style/style.ts:799
Moves a layer to a different z-position. The layer will be inserted before the layer with
ID before, or appended if before is omitted.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
ID of the layer to move |
before? |
string |
ID of an existing layer to insert before |
Returns
void
off()
off(
type:string,listener:Listener):Style
Defined in: util/evented.ts:86
Removes a previously registered event listener.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to remove listeners for. |
listener |
Listener |
The listener function to remove. |
Returns
Style
Inherited from
on()
on(
type:string,listener:Listener):this
Defined in: util/evented.ts:73
Adds a listener to a specified event type.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to add a listen for. |
listener |
Listener |
The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties. |
Returns
this
Inherited from
once()
once(
type:string,listener?:Listener):Promise<any> |Style
Defined in: util/evented.ts:102
Adds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to listen for. |
listener? |
Listener |
The function to be called when the event is fired the first time. |
Returns
Promise<any> | Style
this or a promise if a listener is not provided
Inherited from
removeLayer()
removeLayer(
id:string):void
Defined in: style/style.ts:842
Remove the layer with the given id from the style. A ErrorEvent event will be fired if no such layer exists.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
id of the layer to remove |
Returns
void
removeSource()
removeSource(
id:string):this
Defined in: style/style.ts:652
Remove a source from this stylesheet, given its id.
Parameters
| Parameter | Type | Description |
|---|---|---|
id |
string |
id of the source to remove |
Returns
this
Throws
if no source is found with the given ID
setEventedParent()
setEventedParent(
parent?:Evented,data?:any):Style
Defined in: util/evented.ts:180
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
| Parameter | Type |
|---|---|
parent? |
Evented |
data? |
any |
Returns
Style
Inherited from
setState()
setState(
nextState:StyleSpecification,options:StyleSwapOptions&StyleSetterOptions):boolean
Defined in: style/style.ts:532
Update this style's state to match the given style JSON, performing only the necessary mutations.
May throw an Error ('Unimplemented: METHOD') if the mapbox-gl-style-spec diff algorithm produces an operation that is not supported.
Parameters
| Parameter | Type |
|---|---|
nextState |
StyleSpecification |
options |
StyleSwapOptions & StyleSetterOptions |
Returns
boolean
true if any changes were made; false otherwise