map-gl-utils

0.50.4
Need help reading this?

Overview

Map-GL-Utils (formerly Mapbox-GL-Utils) adds a number of utility functions and syntactic sugar to a Mapbox GL JS or Maplibre GL JS map instance. If you write a lot of interactive map code, you may appreciate the more concise form, and simpler API.

Docs: https://stevage.github.io/map-gl-utils

Package: https://npmjs.com/package/map-gl-utils

Code: https://github.com/stevage/map-gl-utils

Major features:

  • No need to distinguish between paint, layout and other properties.

  • All properties can be expressed as camelCase (lineWidth) rather than kebab-case (line-width).

  • Layer operations can act on multiple layers (given by array, regex or filter function): setLineColor(/road-*/, 'red').

  • Source types, layer types and property names are incorporated into function names: addGeoJSON(), addCircleLayer(), setCircleRadius(), getTextFont()...

  • Adding layers and sources is idempotent: call addLineLayer() multiple times to create, then update the layer.

  • Some other convenience functions:

    • show(), hide(), toggle(true/false): hide/show one or more layers
    • onLoad(): async function triggers after load, or immediately if map is already loaded
    • setData(): conveniently update a GeoJSON source
    • fontsInUse(): list of all fonts in the current style
    • lockOrientation(): disable rotation and tilting behaviour
    • layerStyle(id): retrieve the layer definition for a layer
    • setTransition(): set the transition property of the style

  • Better click and hover functions: hoverPointer(), hoverFeatureState(), hoverPopup(), clickLayer()

  • Some functions behave better:

    • removeLayer() (not an error if layer doesn't exist),
    • removeSource() (removes attached layers automatically),
    • setFilter() (works on multiple layers at once),
    • setData() clears data if no GeoJSON provided.
    • loadImage() loads and adds an image in one step.

  • Expression syntactic sugar (called statically):

    • U.stepZoom(2, { 8: 3 }) => ['step', ['zoom'], 2, 8, 3]
    • U.interpolateZoom({ 14: 2, 16: 4 }) => ['interpolate', ['linear'], ['zoom'], 14, 2, 16, 4]
    • U.interpolate('size', {2: 15, 4: 30 }') => ['interpolate', ['get', 'size'], 2, 15, 4, 13]
    • U.match('size', { small: 12, medium: 18, default: 24 }) => ['match', ['get', 'size'], 'small', 12, 'medium', 18, 24]

Usage

To use without any build process:

<script src="https://unpkg.com/map-gl-utils"></script>

then

U.init(map)

With Webpack etc:

import mapgl from ('maplibre-gl'); // or require('mapbox-gl');
import U from 'map-gl-utils'
const map = new mapgl.Map({ ... });
U.init(map);

// if you need to explicitly import the ESM version:
import U from 'map-gl-utils/dist/index.esm.js'




// A small number of methods (eg hoverPopup) require access to the maplibre-gl/mapbox-gl
// library itself, in order to instantiate other objects.
require('map-gl-utils').init(map, mapgl);

The default distribution is an ES2015 module with no transpiling. If you experience any syntax issues (such as using older JavaScript versions), use the UMD bundle instead:

// Adds U property to map, containing these methods.
require('map-gl-utils/umd').init(map);

Typescript types are included in dist/types/index.d.ts.

Guide

Working with layers

The props object passed when adding a layer can freely mix paint, layout and other properties. Property keys can be specified in camelCase or kebab-case:

map.U.addCircleLayer('trees-circle', 'trees', {
    circleColor: 'green', // paint property
    circleRadius: ['interpolate', ['zoom'], 12, 3, 15, 5], // paint property
    circleSortKey: ['get', 'tree-sort-key'], // layout property
    filter: ['!=', 'type', 'stump'], // other property
});

Almost every method that works with existing layers (eg, show()) can work with multiple layers. There are four ways to specify the layer(s) you want to modify:

  • string: map.U.show('trees-label'); map.U.show('trees-circle');
  • array of strings: map.U.show(['trees-label', 'trees-circle']);
  • regular expression: map.U.show(/^trees-/);
  • function that takes a layer, and returns truthy: map.U.show(layer => layer.source === 'trees');

Adding sources

Methods that add sources return an object ("SourceBoundUtils" in this documentation) that can be chained to allow layers to be added to it:

map.U.addGeoJSONSource('properties')
.addCircleLayer('properties-line', { lineWidth: 3 })
.addSymbolLayer('properties-fill', { fillColor: 'hsla(30,30%,60%,0.5)' })

Adding and removing layers

// Conveniently add a line feature, mixing paint, layout and other properties.
// Notice you can use camelCase for all property names.
map.U.addLineLayer('mylines', 'mysource', {
    lineWidth: 3,
    lineCap: 'round',
    minzoom: 11
});

// Also addFillLayer, addFillExtrusionLayer, addRasterLayer, addVideoLayer, addSymbolLayer, addHillshadeLayer, addHeatmapLayer
map.U.addCircleLayer('mycircles', 'mysource', { circleStrokeColor: 'red' });
// if the layer already exists, calling add*Layer simply updates any of the properties
map.U.addCircleLayer('mycircles', 'mysource', { circleStrokeColor: 'red', circleRadius: 4, filter: ['==', 'type', 'active'});


// and of course add the layer "before" another layer if needed:
map.U.addLineLayer('mylayer', 'mysource', { lineColor: 'red' }, 'toplayer');

// removeLayer() doesn't throw errors if the layers don't exist
map.U.removeLayer(['towns','town-labels']);

Adding and removing sources

// Simpler way to create GeoJSON source:
map.U.addGeoJSON('mysource', geojson);

// Or create a GeoJSON source with initially blank data. This is very convenient if you're loading
// the data separately and will call .setData() later.
map.U.addGeoJSON('mysource');

// Simpler ways to create a vector tile source:
map.U.addVector('mysource', 'mapbox://foo.blah');
map.U.addVector('mysource', 'https://example.com/tiles/{z}/{x}/{y}.pbf');

// Additional properties still work
map.U.addVector('mysource', 'https://example.com/tiles/{z}/{x}/{y}.pbf', { maxzoom: 13 });

// There's also addRaster(), addRasterDem(), addImage(), addVideo()
// Calling any of the add* functions simply updates the source definition if it exists already.

// Automatically removes any layers using these sources. Not an error if sources don't exist.
map.U.removeSource(['buildings', 'roads']);

// You can also use the returned object to add layers conveniently:
map.U.addGeoJSON('buildings', 'data/buildings.geojson')
    .addFillExtrusion('buildings-3d', {
        fillExtrusionHeight: 100,
        fillExtrusionColor: 'grey'
    }).addLineLayer('buildings-footprint', {
        lineColor: 'lightblue'
    });

// Replace the source on an existing layer. (Actually removes and re-adds it.)
map.U.setLayerSource('buildings', 'newsource');
map.U.setLayerSource(['buildings-3d', 'buildings-outline]', 'newsource', 'newsourcelayer');

// To change the source layer, pass a third argument, or null to clear it (if switching from vector tiles to geojson)
map.U.setLayerSource('buildings', 'mylocalbuildings', null);

Setting properties and updating data

// Every property has a setXxx() form:
map.U.setTextSize('mylayer', 12);

// And they all work on multiple layers at once:
map.U.setLineWidth(['mylayer', 'mylayer-highlight'], 4);
map.U.setLineOpacity(/^border-/, 0);
map.U.setFillColor(layer => layer.source === 'farms', 'green');

// There's also a more familiar setProperty() form.
map.U.setProperty('mylayer', 'line-width', 3);
// Existing properties aren't touched
map.U.setProperty('mylayer', {
    textSize: 12,
    textColor: 'red'
});

// There's a `get...` version of every function, too.
map.U.getFillColor('water')

// Simpler way to update source data:
map.U.setData('mysource', data);

// you can leave out the data parameter to clear out a GeoJSON source:
map.U.setData('mysource');

// Easier to remember way to turn layers on and off:
map.U.show('mylayer');
map.U.hide('mylayer');
map.U.toggle(['mylayer', 'myotherlayer'], isVisible);

// To avoid name clashes such as with 'raster', you can use a longer form ending
// with either ...Layer() or ...Source()

map.U.addRasterSource('myrastersource', { type: 'raster', url: 'mapbox://mapbox.satellite', tileSize: 256 });
map.U.addRasterLayer('myrasterlayer', 'myrastersource', { rasterSaturation: 0.5 });

Hovering and clicking

// Use the mouse 'finger' cursor when hovering over this layer.
map.U.hoverPointer('mylayer');

// If you pass several layers, it correctly handles moving from one layer to another
// Use the mouse 'finger' cursor when hovering over this layer.
map.U.hoverPointer(['regions-border', 'regions-fill']);

// Sets a "hover" feature-state to be true or false as the mouse moves over features in this layer.
// Requires that features have an `id`.
map.U.hoverFeatureState('mylayer');

// Want to apply the hover feature-state to a different source?
// For instance, you hover over a label, but want to highlight the surrounding boundary.
map.U.hoverFeatureState('town-labels', 'boundaries', 'town-boundaries');

// You can also add additional event handlers:
map.U.hoverFeatureState('mylayer', 'mysource', 'mysourcelayer',
    e => console.log(`Entered ${e.features[0].id}`),
    e => console.log(`Left ${e.oldFeatureid}`);

// Shows a popup when a feature is hovered over or clicked.
// The third argument is an options object, passed to the Popup constructor.
// callback is called as: (feature, popup) => htmlString
// Make sure you passed the mapboxgl library itself when initialising: U.init(map, mapboxgl).
map.U.hoverPopup('mylayer', f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { anchor: 'left' });
map.U.clickPopup('mylayer', f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { maxWidth: 500 });

// clickLayer() is like .on('click)', but can take an array and adds a 'features' member
// to the event, for what got clicked on.
map.U.clickLayer(['towns', 'town-labels'], e => panel.selectedId = e.features[0].id);

// clickOneLayer tests multiple layers in order, firing callback on the first one that
// is hit. The callback is passed { feature, features, layer, event }.
map.U.clickOneLayer(['town-labels', 'state-boundaries'], e => {
    if (e.layer === 'town-labels') {
        setView('town');
        panel.selectedId = e.features[0].id;
    } else if (e.layer === 'state-boundaries') {
        setView('state');
        panel.selectedId = e.features[0].id;
    }
});

// Optionally pass in an extra callback which is fired for clicks that miss all layers:
map.U.clickOneLayer(['town-labels', 'state-boundaries'], e => {...}, e => {
    console.log('Missed everything');
});

// All these functions return an "undo" function that removes the handlers added:
const remove = map.U.hoverPopup('mylayer', showPopupFunc);
//...
remove(); // no more hover popup

Other functions

// Like on('load') but fires immediately (and reliably) any time after map already loaded.
map.U.onLoad(callback);
// returns a promise if no callback:
await map.U.onLoad();

// Gets the layer definition. Mapbox's `getLayer()` has weird paint and layout properties.
const layer = map.U.getLayerStyle('mylayer');

// Resets all other properties to default first. Ignores non-paint, non-layout properties.
map.setLayerStyle('mylayer', {
    lineWidth: 3
});

// properties() converts an object to a layer object accepted by Mapbox-GL-JS
map.addLayer(map.U.properties({
    id: 'mylayer',
    source: 'mysource',
    type: 'line',
    lineWidth: 3,
    lineCap: 'round',
    minzoom: 11,
    filter: ['==', 'status', 'confirmed']
}));

// layerStyle() is flexible, pass as many or as few of id, source, and type (in that order) as you like:
map.U.layerStyle('mylayer', 'mysource', 'line', { ... })
map.U.layerStyle('mylayer', 'mysource', { ... })
map.U.layerStyle('mylayer', { ... })
map.U.layerStyle({ ... })


// Hide/show/toggle all the layers attached to this source
map.U.hideSource('buildings');
map.U.showSource('buildings');
map.U.toggleSource('buildings', true);

// Update several filters at once.
map.U.setFilter(['buildings-fill', 'buildings-outline', 'buildings-label'], [...]);

// Conveniently load an image into the map in one step
map.U.loadImage('marker', '/assets/marker-pin.png');
map.U.loadImage('marker', '/assets/marker-pin@2x.png', { pixelRatio: 2}).then(/* ... */;


// Update the map style's root "transition" property
map.U.setTransition({ delay: 1000, delay: 0});

// Get a list of fonts used in symbol layers with fontsUsed(). Useful for quickly getting some text displaying.
const fonts = map.U.fontsInUse();
map.U.addSymbolLayer('labels', 'mysource', { textFont: fonts[0], textField: '{label}' });

Contrived example

map.U.onload(() => {
    map.U.addGeoJSON('towns');
    map.U.addCircleLayer('small-towns', 'towns', { circleColor: 'green', filter: ['==', 'size', 'small']});
    map.U.addCircleLayer('large-towns', 'towns', {
        circleColor: 'red',
        filter: ['==', 'size', ['large']],
        circleStrokeWidth: ['case', ['to-boolean', ['feature-state', 'hover']], 5, 1]
    );
    map.U.setCircleRadius(['small-towns', 'large-towns'], 12);
    map.U.hoverPointer(['small-towns', 'large-towns']);
    map.U.hoverFeatureState('large-towns');
    // update the source layer when data is available
    d3.json('http://example.com/towns.json', data => map.U.setData('towns', data));
});

Credits

Map-GL-Utils was written by, and maintained, by Steve Bennett, a freelance map developer.

Documentation built with documentation.js.

Packaging uses rollup.js and Babel.

Typescript is used internally, including types from Mapbox GL JS.

Tests are run using Jest.

Changelog

Changelog

0.50.0

  • convert from Flow to TypeScript.
  • probably mess up the packaging once more.

0.45.0-0

  • fixing packaging issues ("regeneratorRuntime is not defined")

0.44.0

  • add match/interpolate/zoom convenience functions, somewhat experimental

0.43.0

  • revert to internally using map.addLayer rather than map.setStyle for performance

0.42.0

  • fixed UMD packaging some more by removing esmodules: true from rollup config.

0.41.0

  • fix UMD packaging (thanks @lasseborly!)
  • fix ESM packaging (class properties not transformed properly)
  • update to Mapbox GL Style Spec 13.22 ("sky" properties)

0.40.0

  • rename to Map-GL-JS and explicitly support Maplibre GL JS
  • add Flow types
  • add JSdocs and use documentation.js to make documentation
  • change the packaging again, so dist/index.esm.js is the default, ES module, and umd/index.js is the UMD module.

0.39.0

  • remove kebab-case dependency

0.38.0

  • scrapped the CommonJS build. NodeJS is able to handle ES modules these days.
  • rewrote the "arrayify" logic
  • correctly handle 'hover' transitions across overlapping layers
  • probably correctly gives an "off" handler so this kind of thing works: const off = map.U.hoverPointer(['layer1','layer2']); /* ... */ off()
  • more tests

0.37.0

  • onLoad() now returns a promise if no callback provided.

0.36.0

0.35.0

add

Adds a layer of any type.

add(id: string, source: SourceOrData, type: string, props: {}, before: string?): (SourceBoundUtils | null | undefined)
Deprecated: Use addLineLayer, addFillLayer, etc.
Parameters
id (string) ID of the new layer.
source (SourceOrData) ID of the source to use.
type (string) Type of the layer.
props ({}) Properties defining the layer, per the style spec. Keys can be in camelCase, and paint and layout keys freely mixed.
before (string?) ID of the layer to insert before.
Returns
(SourceBoundUtils | null | undefined): A SourceBoundUtils object for chaining.
Example
add('mylayer', 'mysource', 'line', { lineColor:'red' });

addCircleLayer

Adds a layer of type circle.

addCircleLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addFillExtrusionLayer

Adds a layer of type fill-extrusion.

addFillExtrusionLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addFillLayer

Adds a layer of type fill.

addFillLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addGeoJSON

Create a GeoJSON source or update properties if already present.

addGeoJSON(sourceId: string, geojson: GeoJSON?, props: object?): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
geojson (GeoJSON?) Optional GeoJSON data.
props (object?) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

addGeoJSONSource

Create a GeoJSON source or update properties if already present.

addGeoJSONSource(sourceId: string, geojson: GeoJSON?, props: object?): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
geojson (GeoJSON?) Optional GeoJSON data.
props (object?) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

addHeatmapLayer

Adds a layer of type heatmap.

addHeatmapLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addHillshadeLayer

Adds a layer of type hillshade.

addHillshadeLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addImageSource

Adds an image source

addImageSource(sourceId: string, props: object): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
props (object) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

addLayer

Adds a layer, given an id, source, type, and properties.

addLayer(id: string, source: string, type: string, props: {}, before: (string | null | undefined)): SourceBoundUtils
Parameters
id (string) ID of the new layer.
source (string) ID of the source to use.
type (string) Type of the layer.
props ({}) Properties defining the layer, per the style spec. Keys can be in camelCase, and paint and layout keys freely mixed.
before ((string | null | undefined)) ID of the layer to insert before.
Returns
SourceBoundUtils

addLineLayer

Adds a layer of type line.

addLineLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addRasterDemSource

Adds a raster-dem source

addRasterDemSource(sourceId: string, props: object): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
props (object) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

addRasterLayer

Adds a layer of type raster.

addRasterLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addRasterSource

Adds a raster source

addRasterSource(sourceId: string, props: object): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
props (object) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

addSource

Adds or updates a source in the style.

addSource(id: string, sourceDef: SourceSpecification): SourceBoundUtils
Parameters
id (string) ID of the new source.
sourceDef (SourceSpecification) Properties defining the source, per the style spec.
Returns
SourceBoundUtils: A SourceBoundUtils object for chaining.
Example
addSource('mysource', { type: 'geojson', data: { type: 'FeatureCollection', features: [] } });

addSymbolLayer

Adds a layer of type symbol.

addSymbolLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addVectorSource

Adds a vector source

addVectorSource(sourceId: string, props: object, extraProps: {}, data: string?): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
props (object) Properties defining the source, per the style spec.
extraProps ({} = {})
data (string?) Optional URL of source tiles (.../{z}/{x}/{y}...), mapbox:// URL or TileJSON endpoint.
Returns
SourceBoundUtils
Example
addVector('mysource', 'http://example.com/tiles/{z}/{x}/{y}.pbf', { maxzoom: 13 });

addVideoLayer

Adds a layer of type video.

addVideoLayer(id: string, source: string, props: {}, before: string?): void
Parameters
id (string)
source (string)
props ({})
before (string?)
Returns
void

addVideoSource

Adds a video source

addVideoSource(sourceId: string, props: object): SourceBoundUtils
Parameters
sourceId (string) ID of the new source.
props (object) Properties defining the source, per the style spec.
Returns
SourceBoundUtils

clickLayer

Fire a callback whenever a feature in these layers is clicked.

clickLayer
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to attach handler to.
cb (function) Callback that receives event with .features property
Returns
any: A function that removes the handler.
Example
clickLayer('mylayer', e => console.log(e.features[0].properties.Name));

clickOneLayer

Detects a click in the first of a series of layers given, and fires a callback.

clickOneLayer(layerRef: LayerRef, cb: LayerCallback, noMatchCb: (LayerCallback | null | undefined), layers: (string | Array<string> | RegExp | function)): OffHandler
Parameters
layerRef (LayerRef)
cb (LayerCallback) Callback, receives { event, layer, feature, features } .
noMatchCb ((LayerCallback | null | undefined)) Callback when a click happens that misses all these layers. Receives { event } .
layers ((string | Array<string> | RegExp | function)) Layers to attach handler to.
Returns
OffHandler: A function to remove the handler.
Example
clickOneLayer(['pois-label','region-label'], e => console.log(e.features[0].properties.Name), e => console.log('missed'));

clickPopup

Show a popup whenever a feature in these layers is clicked.

clickPopup(layers: (string | Array<string> | RegExp | function), htmlFunc: function (arg0: {}): void, popupOptions: Object<PopupOptions>): OffHandler
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to attach handler to.
htmlFunc (function (arg0: {}): void) Function that receives feature and popup, returns HTML.
popupOptions (Object<PopupOptions> = {}) Options passed to Popup() to customise popup.
Returns
OffHandler: A function that removes the handler.
Example
clickPopup('mylayer', f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { maxWidth: 500 });

fontsInUse

Gets array of font names in use, determined by traversing style. Does not detect fonts in all possible situations.

fontsInUse(): Array<string>
Returns
Array<string>

getLayerStyle

Gets the layer definition for a given layer id, as per the style spec.

getLayerStyle(layerId: string): LayerSpecification
Parameters
layerId (string)
Returns
LayerSpecification: Layer definition object.

hide

Makes the given layers hidden.

hide
Parameters
Layers ((string | Array<string> | RegExp | function)) to hide.
Example
map.U.hide(/^buildings-/);

hideSource

Makes all layers depending on a given source hidden.

hideSource
Parameters
sourceId (string) Source[s] whose layers will be toggled.
Example
map.U.hideSource('trees');

hoverFeatureState

Updates feature-state of features in the connected source[s] whenever hovering over a feature in these layers.

hoverFeatureState
Parameters
layer (any) Layer(s) to add handler to.
source ((string | Array)?) Source whose features will be updated. If not provided, use the source defined for the layer.
sourceLayer (string?) Source layer (if using vector source)
enterCb (function?) Callback when entering feature.
leaveCb (function?) Callback when leaving feature.
Returns
any: A function to remove the handler.
Example
hoverFeatureState('buildings-fill', 'composite', 'buildings', e => console.log(e.features[0].properties.Name), e => console.log('left'));

hoverLayer

Fires a callback when mouse hovers over a feature in these layers.

hoverLayer
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to attach handler to.
Returns
function: A function to remove the handler.
Example
hoverLayer('pois-symbol', e => console.log(e.features[0].properties.Name));

hoverPointer

Sets Map's cursor to 'pointer' whenever the mouse is over these layers.

hoverPointer(layerOrLayers: LayerRef): function (): void
Parameters
layerOrLayers (LayerRef)
Returns
function (): void: A function to remove the handler.
Example
hoverPointer('poi-circle');

hoverPopup

Show a popup whenever hovering over a feature in these layers.

hoverPopup(layers: (string | Array<string> | RegExp | function), htmlFunc: LayerCallback, popupOptions: Object<PopupOptions>): OffHandler
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to attach handler to.
htmlFunc (LayerCallback) Function that receives feature and popup, returns HTML.
popupOptions (Object<PopupOptions> = {}) Options passed to Popup() to customise popup.
Returns
OffHandler
Example
hoverPopup('mylayer', f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { anchor: 'left' });

loadImage

Adds an image for use in a symbol layer, from a URL.

loadImage(id: string, url: string, options: StyleImageMetadata?): any
Parameters
id (string) ID of the image.
url (string) URL of the image.
options (StyleImageMetadata?) Options for the image.
Returns
any
Example
loadImage('marker', '/assets/marker-pin@2x.png', { pixelRatio: 2})

lockOrientation

Forcibly prevents the map's pitch or bearing being changed by the user.

lockOrientation(): void
Returns
void
Example
lockOrientation(

onLoad

Callback that fires when map loads, or immediately if map is already loaded.

onLoad(cb: function (arg0: void): void?): Promise
Parameters
cb (function (arg0: void): void?)
Returns
Promise: Promise, if callback not provided.

properties

Converts a set of properties in pascalCase or kebab-case into a layer objectwith layout and paint properties.

properties(props: object): object
Parameters
props (object) Properties to convert.
Returns
object: Layer object with layout and paint properties.
Example
properties({ fillOpacity: 0.5, fillColor: 'red' })
// { paint: { 'fill-opacity': 0.5, 'fill-color': 'red' } }

removeLayer

Removes one or more layers.

removeLayer
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to remove.
Returns
any: void
Example
removeLayer(['tree-labels','building-labels'])

removeSource

Removes one or more sources, first removing all layers that depend on them. Not an error if source doesn't exist.

removeSource
Parameters
sources (SourceRef)

setData

Replaces the current data for a GeoJSON layer.

setData(sourceId: string, data: GeoJSON?)
Parameters
sourceId (string) Id of the source being updated.
data (GeoJSON? = {type:'FeatureCollection',features:[]}) GeoJSON object to set. If not provided, defaults to an empty FeatureCollection.
Example
setData('trees', { type: 'FeatureCollection', features: [ ... ] });

setFilter

Replace the filter for one or more layers.

setFilter
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to update.
filter (Array) New filter to set.
Example
map.U.setFilter(['buildings-fill', 'buildings-outline', 'buildings-label'], ['==','level','0']]);

setLayerSource

Changes the source of an existing layer, by removing and readding the source.

setLayerSource
Parameters
layerId ((string | Array<string> | RegExp | function)) Layer[s] whose source will be changed.
sourceId (string) New source ID to set.
sourceLayer (string?) New source layer to set.
Example
setLayerSource(['trees-circle', 'trees-label'], 'allpoints', 'trees')

setLayerStyle

Updates multiple properties for one or more layers.

setLayerStyle
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to update.
props (object) Properties to update.
Example
setLayerStyle('buildings-fill', { fillOpacity: 0.5, fillColor: 'red' });

setProperty

Sets a paint or layout property on one or more layers.

setProperty
Parameters
layers ((string | Array<string> | RegExp | function)) Layers to update.
prop ((string | object)) Property to update, or object of properties.
value (any?) Value to set property to.
Example
setProperty(['buildings-fill', 'parks-fill'], 'fillOpacity', 0.5)

setRootProperty

Set a property on the style's root, such as light or transition.

setRootProperty(propName: string, val: any)
Parameters
propName (string) Name of the property to set.
val (any) Value to set the property to.
Example
setRootProperty('transition', { duration: 500, delay: 100 })

setTransition

Sets root transition property.

setTransition(val: TransitionSpecification)
Parameters
val (TransitionSpecification) Transition object.
Example
setTransition({ duration: 500, delay: 100 })

show

Makes the given layers visible.

show
Parameters
Layers ((string | Array<string> | RegExp | function)) to show.
Example
map.U.show(['buildings-fill', 'buildings-outline', 'buildings-label']);

showSource

Makes all layers depending on a given source visible.

showSource
Parameters
sourceId (string) Source[s] whose layers will be toggled.
Example
map.U.showSource('trees');

toggle

Makes the given layers hidden or visible, depending on an argument.

toggle
Parameters
Layer ((string | Array<string> | RegExp | function)) to toggle.
state (boolean) True for visible, false for hidden.
Example
map.U.toggle(/^buildings-/, layers.showBuildings);

toggleSource

Makes the given layers connected to a given source hidden or visible, depending on an argument.

toggleSource
Parameters
sourceId (string) Source[s] whose layers will be toggled.
state (boolean) True for visible, false for hidden.

init

Initialises Map-GL-Utils on existing map object.

init(map: UtilsMap, mapgl: MapboxGlLib?): MapGlUtils
Parameters
map (UtilsMap) Map object to attach to.
mapgl (MapboxGlLib?) Mapbox-GL-JS or Maplibre-GL-JS library. Only needed for later use by hoverPopup() etc.
Returns
MapGlUtils: Initialised MapGlUtils object.
Example
MapGlUtils.init(map, maplibregl);

interpolate

Generates an ["interpolate", ["linear"], input, lowest, ...stops] expression.

interpolate(expression: (string | ExpressionSpecification), stops: (number | {: any} | ArrayLike<any>), moreStops: ...Array<(number | undefined)>)
Parameters
expression ((string | ExpressionSpecification))
stops ((number | {: any} | ArrayLike<any>))
moreStops (...Array<(number | undefined)>)
Example
interpolate('size', { 2: 15, 4: 30, })

interpolateZoom

Generates an ["interpolate", ["linear"], ["zoom"], lowest, ...stops] expression.

interpolateZoom(stops: (number | {: any} | ArrayLike<any>), moreStops: ...Array<(number | undefined)>)
Parameters
stops ((number | {: any} | ArrayLike<any>)) Object of zoom: value pairs.
moreStops (...Array<(number | undefined)>)

match

Generates a ["match", input, output, default] expression.

match(expression: string, cases: {: any, default: any?}, fallback: (number | undefined))
Parameters
expression (string)
cases ({: any, default: any?})
fallback ((number | undefined))
Example
MapGlUtils.match('type', { 'house': '🏠', 'tree': '🌲' }, '❓')

step

Generates a ["step", input, lowest, ...steps] expression.

step(expression: ExpressionSpecification, lowest: number, stops: (Array<[number, ExpressionSpecification]> | {number: ExpressionSpecification} | number), moreStops: ...Array<(number | ExpressionSpecification)>)
Parameters
expression (ExpressionSpecification) Expression to use as input.
lowest (number) Default value.
stops ((Array<[number, ExpressionSpecification]> | {number: ExpressionSpecification} | number)) Object of zoom: value pairs.
moreStops (...Array<(number | ExpressionSpecification)>)
Example
step('size, 2, { 8: 3, })

stepZoom

Generates a ["step", ["zoom"], lowest, ...steps] expression.

stepZoom(lowest: number, stops: (Array<[number, ExpressionSpecification]> | {number: ExpressionSpecification} | number), moreStops: ...Array<(number | ExpressionSpecification)>)
Parameters
lowest (number) Default value.
stops ((Array<[number, ExpressionSpecification]> | {number: ExpressionSpecification} | number)) Object of zoom: value pairs.
moreStops (...Array<(number | ExpressionSpecification)>)
Example
stepZoom(2, { 8: 3, })

getBackgroundColor

Gets the background-color paint property for a layer.

getBackgroundColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getBackgroundEmissiveStrength

Gets the background-emissive-strength paint property for a layer.

getBackgroundEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getBackgroundOpacity

Gets the background-opacity paint property for a layer.

getBackgroundOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getBackgroundPattern

Gets the background-pattern paint property for a layer.

getBackgroundPattern(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getBackgroundPitchAlignment

Gets the background-pitch-alignment paint property for a layer.

getBackgroundPitchAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleBlur

Gets the circle-blur paint property for a layer.

getCircleBlur(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleColor

Gets the circle-color paint property for a layer.

getCircleColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleEmissiveStrength

Gets the circle-emissive-strength paint property for a layer.

getCircleEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleOpacity

Gets the circle-opacity paint property for a layer.

getCircleOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCirclePitchAlignment

Gets the circle-pitch-alignment paint property for a layer.

getCirclePitchAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCirclePitchScale

Gets the circle-pitch-scale paint property for a layer.

getCirclePitchScale(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleRadius

Gets the circle-radius paint property for a layer.

getCircleRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleSortKey

Gets the circle-sort-key layout property for a layer.

getCircleSortKey(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleStrokeColor

Gets the circle-stroke-color paint property for a layer.

getCircleStrokeColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleStrokeOpacity

Gets the circle-stroke-opacity paint property for a layer.

getCircleStrokeOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleStrokeWidth

Gets the circle-stroke-width paint property for a layer.

getCircleStrokeWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleTranslate

Gets the circle-translate paint property for a layer.

getCircleTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getCircleTranslateAnchor

Gets the circle-translate-anchor paint property for a layer.

getCircleTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getClipLayerScope

Gets the clip-layer-scope layout property for a layer.

getClipLayerScope(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getClipLayerTypes

Gets the clip-layer-types layout property for a layer.

getClipLayerTypes(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillAntialias

Gets the fill-antialias paint property for a layer.

getFillAntialias(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillColor

Gets the fill-color paint property for a layer.

getFillColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillElevationReference

Gets the fill-elevation-reference layout property for a layer.

getFillElevationReference(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillEmissiveStrength

Gets the fill-emissive-strength paint property for a layer.

getFillEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionAmbientOcclusionGroundAttenuation

Gets the fill-extrusion-ambient-occlusion-ground-attenuation paint property for a layer.

getFillExtrusionAmbientOcclusionGroundAttenuation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionAmbientOcclusionGroundRadius

Gets the fill-extrusion-ambient-occlusion-ground-radius paint property for a layer.

getFillExtrusionAmbientOcclusionGroundRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionAmbientOcclusionIntensity

Gets the fill-extrusion-ambient-occlusion-intensity paint property for a layer.

getFillExtrusionAmbientOcclusionIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionAmbientOcclusionRadius

Gets the fill-extrusion-ambient-occlusion-radius paint property for a layer.

getFillExtrusionAmbientOcclusionRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionAmbientOcclusionWallRadius

Gets the fill-extrusion-ambient-occlusion-wall-radius paint property for a layer.

getFillExtrusionAmbientOcclusionWallRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionBase

Gets the fill-extrusion-base paint property for a layer.

getFillExtrusionBase(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionBaseAlignment

Gets the fill-extrusion-base-alignment paint property for a layer.

getFillExtrusionBaseAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionCastShadows

Gets the fill-extrusion-cast-shadows paint property for a layer.

getFillExtrusionCastShadows(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionColor

Gets the fill-extrusion-color paint property for a layer.

getFillExtrusionColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionCutoffFadeRange

Gets the fill-extrusion-cutoff-fade-range paint property for a layer.

getFillExtrusionCutoffFadeRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionEdgeRadius

Gets the fill-extrusion-edge-radius layout property for a layer.

getFillExtrusionEdgeRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionEmissiveStrength

Gets the fill-extrusion-emissive-strength paint property for a layer.

getFillExtrusionEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionFloodLightColor

Gets the fill-extrusion-flood-light-color paint property for a layer.

getFillExtrusionFloodLightColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionFloodLightGroundAttenuation

Gets the fill-extrusion-flood-light-ground-attenuation paint property for a layer.

getFillExtrusionFloodLightGroundAttenuation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionFloodLightGroundRadius

Gets the fill-extrusion-flood-light-ground-radius paint property for a layer.

getFillExtrusionFloodLightGroundRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionFloodLightIntensity

Gets the fill-extrusion-flood-light-intensity paint property for a layer.

getFillExtrusionFloodLightIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionFloodLightWallRadius

Gets the fill-extrusion-flood-light-wall-radius paint property for a layer.

getFillExtrusionFloodLightWallRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionHeight

Gets the fill-extrusion-height paint property for a layer.

getFillExtrusionHeight(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionHeightAlignment

Gets the fill-extrusion-height-alignment paint property for a layer.

getFillExtrusionHeightAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionLineWidth

Gets the fill-extrusion-line-width paint property for a layer.

getFillExtrusionLineWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionOpacity

Gets the fill-extrusion-opacity paint property for a layer.

getFillExtrusionOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionPattern

Gets the fill-extrusion-pattern paint property for a layer.

getFillExtrusionPattern(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionRoundedRoof

Gets the fill-extrusion-rounded-roof paint property for a layer.

getFillExtrusionRoundedRoof(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionTranslate

Gets the fill-extrusion-translate paint property for a layer.

getFillExtrusionTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionTranslateAnchor

Gets the fill-extrusion-translate-anchor paint property for a layer.

getFillExtrusionTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionVerticalGradient

Gets the fill-extrusion-vertical-gradient paint property for a layer.

getFillExtrusionVerticalGradient(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillExtrusionVerticalScale

Gets the fill-extrusion-vertical-scale paint property for a layer.

getFillExtrusionVerticalScale(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillOpacity

Gets the fill-opacity paint property for a layer.

getFillOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillOutlineColor

Gets the fill-outline-color paint property for a layer.

getFillOutlineColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillPattern

Gets the fill-pattern paint property for a layer.

getFillPattern(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillSortKey

Gets the fill-sort-key layout property for a layer.

getFillSortKey(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillTranslate

Gets the fill-translate paint property for a layer.

getFillTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillTranslateAnchor

Gets the fill-translate-anchor paint property for a layer.

getFillTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getFillZOffset

Gets the fill-z-offset paint property for a layer.

getFillZOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHeatmapColor

Gets the heatmap-color paint property for a layer.

getHeatmapColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHeatmapIntensity

Gets the heatmap-intensity paint property for a layer.

getHeatmapIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHeatmapOpacity

Gets the heatmap-opacity paint property for a layer.

getHeatmapOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHeatmapRadius

Gets the heatmap-radius paint property for a layer.

getHeatmapRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHeatmapWeight

Gets the heatmap-weight paint property for a layer.

getHeatmapWeight(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeAccentColor

Gets the hillshade-accent-color paint property for a layer.

getHillshadeAccentColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeEmissiveStrength

Gets the hillshade-emissive-strength paint property for a layer.

getHillshadeEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeExaggeration

Gets the hillshade-exaggeration paint property for a layer.

getHillshadeExaggeration(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeHighlightColor

Gets the hillshade-highlight-color paint property for a layer.

getHillshadeHighlightColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeIlluminationAnchor

Gets the hillshade-illumination-anchor paint property for a layer.

getHillshadeIlluminationAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeIlluminationDirection

Gets the hillshade-illumination-direction paint property for a layer.

getHillshadeIlluminationDirection(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getHillshadeShadowColor

Gets the hillshade-shadow-color paint property for a layer.

getHillshadeShadowColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconAllowOverlap

Gets the icon-allow-overlap layout property for a layer.

getIconAllowOverlap(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconAnchor

Gets the icon-anchor layout property for a layer.

getIconAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconColor

Gets the icon-color paint property for a layer.

getIconColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconColorBrightnessMax

Gets the icon-color-brightness-max paint property for a layer.

getIconColorBrightnessMax(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconColorBrightnessMin

Gets the icon-color-brightness-min paint property for a layer.

getIconColorBrightnessMin(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconColorContrast

Gets the icon-color-contrast paint property for a layer.

getIconColorContrast(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconColorSaturation

Gets the icon-color-saturation paint property for a layer.

getIconColorSaturation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconEmissiveStrength

Gets the icon-emissive-strength paint property for a layer.

getIconEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconHaloBlur

Gets the icon-halo-blur paint property for a layer.

getIconHaloBlur(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconHaloColor

Gets the icon-halo-color paint property for a layer.

getIconHaloColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconHaloWidth

Gets the icon-halo-width paint property for a layer.

getIconHaloWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconIgnorePlacement

Gets the icon-ignore-placement layout property for a layer.

getIconIgnorePlacement(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconImage

Gets the icon-image layout property for a layer.

getIconImage(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconImageCrossFade

Gets the icon-image-cross-fade paint property for a layer.

getIconImageCrossFade(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconKeepUpright

Gets the icon-keep-upright layout property for a layer.

getIconKeepUpright(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconOcclusionOpacity

Gets the icon-occlusion-opacity paint property for a layer.

getIconOcclusionOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconOffset

Gets the icon-offset layout property for a layer.

getIconOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconOpacity

Gets the icon-opacity paint property for a layer.

getIconOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconOptional

Gets the icon-optional layout property for a layer.

getIconOptional(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconPadding

Gets the icon-padding layout property for a layer.

getIconPadding(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconPitchAlignment

Gets the icon-pitch-alignment layout property for a layer.

getIconPitchAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconRotate

Gets the icon-rotate layout property for a layer.

getIconRotate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconRotationAlignment

Gets the icon-rotation-alignment layout property for a layer.

getIconRotationAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconSize

Gets the icon-size layout property for a layer.

getIconSize(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconSizeScaleRange

Gets the icon-size-scale-range layout property for a layer.

getIconSizeScaleRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconTextFit

Gets the icon-text-fit layout property for a layer.

getIconTextFit(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconTextFitPadding

Gets the icon-text-fit-padding layout property for a layer.

getIconTextFitPadding(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconTranslate

Gets the icon-translate paint property for a layer.

getIconTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getIconTranslateAnchor

Gets the icon-translate-anchor paint property for a layer.

getIconTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineBlur

Gets the line-blur paint property for a layer.

getLineBlur(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineBorderColor

Gets the line-border-color paint property for a layer.

getLineBorderColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineBorderWidth

Gets the line-border-width paint property for a layer.

getLineBorderWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineCap

Gets the line-cap layout property for a layer.

getLineCap(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineColor

Gets the line-color paint property for a layer.

getLineColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineCrossSlope

Gets the line-cross-slope layout property for a layer.

getLineCrossSlope(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineDasharray

Gets the line-dasharray paint property for a layer.

getLineDasharray(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineElevationReference

Gets the line-elevation-reference layout property for a layer.

getLineElevationReference(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineEmissiveStrength

Gets the line-emissive-strength paint property for a layer.

getLineEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineGapWidth

Gets the line-gap-width paint property for a layer.

getLineGapWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineGradient

Gets the line-gradient paint property for a layer.

getLineGradient(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineJoin

Gets the line-join layout property for a layer.

getLineJoin(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineMiterLimit

Gets the line-miter-limit layout property for a layer.

getLineMiterLimit(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineOcclusionOpacity

Gets the line-occlusion-opacity paint property for a layer.

getLineOcclusionOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineOffset

Gets the line-offset paint property for a layer.

getLineOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineOpacity

Gets the line-opacity paint property for a layer.

getLineOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLinePattern

Gets the line-pattern paint property for a layer.

getLinePattern(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineRoundLimit

Gets the line-round-limit layout property for a layer.

getLineRoundLimit(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineSortKey

Gets the line-sort-key layout property for a layer.

getLineSortKey(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineTranslate

Gets the line-translate paint property for a layer.

getLineTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineTranslateAnchor

Gets the line-translate-anchor paint property for a layer.

getLineTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineTrimColor

Gets the line-trim-color paint property for a layer.

getLineTrimColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineTrimFadeRange

Gets the line-trim-fade-range paint property for a layer.

getLineTrimFadeRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineTrimOffset

Gets the line-trim-offset paint property for a layer.

getLineTrimOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineWidth

Gets the line-width paint property for a layer.

getLineWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineWidthUnit

Gets the line-width-unit layout property for a layer.

getLineWidthUnit(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getLineZOffset

Gets the line-z-offset layout property for a layer.

getLineZOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelAmbientOcclusionIntensity

Gets the model-ambient-occlusion-intensity paint property for a layer.

getModelAmbientOcclusionIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelCastShadows

Gets the model-cast-shadows paint property for a layer.

getModelCastShadows(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelColor

Gets the model-color paint property for a layer.

getModelColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelColorMixIntensity

Gets the model-color-mix-intensity paint property for a layer.

getModelColorMixIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelCutoffFadeRange

Gets the model-cutoff-fade-range paint property for a layer.

getModelCutoffFadeRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelEmissiveStrength

Gets the model-emissive-strength paint property for a layer.

getModelEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelFrontCutoff

Gets the model-front-cutoff paint property for a layer.

getModelFrontCutoff(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelHeightBasedEmissiveStrengthMultiplier

Gets the model-height-based-emissive-strength-multiplier paint property for a layer.

getModelHeightBasedEmissiveStrengthMultiplier(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelId

Gets the model-id layout property for a layer.

getModelId(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelOpacity

Gets the model-opacity paint property for a layer.

getModelOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelReceiveShadows

Gets the model-receive-shadows paint property for a layer.

getModelReceiveShadows(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelRotation

Gets the model-rotation paint property for a layer.

getModelRotation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelRoughness

Gets the model-roughness paint property for a layer.

getModelRoughness(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelScale

Gets the model-scale paint property for a layer.

getModelScale(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelTranslation

Gets the model-translation paint property for a layer.

getModelTranslation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getModelType

Gets the model-type paint property for a layer.

getModelType(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterArrayBand

Gets the raster-array-band paint property for a layer.

getRasterArrayBand(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterBrightnessMax

Gets the raster-brightness-max paint property for a layer.

getRasterBrightnessMax(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterBrightnessMin

Gets the raster-brightness-min paint property for a layer.

getRasterBrightnessMin(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterColor

Gets the raster-color paint property for a layer.

getRasterColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterColorMix

Gets the raster-color-mix paint property for a layer.

getRasterColorMix(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterColorRange

Gets the raster-color-range paint property for a layer.

getRasterColorRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterContrast

Gets the raster-contrast paint property for a layer.

getRasterContrast(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterElevation

Gets the raster-elevation paint property for a layer.

getRasterElevation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterEmissiveStrength

Gets the raster-emissive-strength paint property for a layer.

getRasterEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterFadeDuration

Gets the raster-fade-duration paint property for a layer.

getRasterFadeDuration(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterHueRotate

Gets the raster-hue-rotate paint property for a layer.

getRasterHueRotate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterOpacity

Gets the raster-opacity paint property for a layer.

getRasterOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleArrayBand

Gets the raster-particle-array-band paint property for a layer.

getRasterParticleArrayBand(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleColor

Gets the raster-particle-color paint property for a layer.

getRasterParticleColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleCount

Gets the raster-particle-count paint property for a layer.

getRasterParticleCount(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleElevation

Gets the raster-particle-elevation paint property for a layer.

getRasterParticleElevation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleFadeOpacityFactor

Gets the raster-particle-fade-opacity-factor paint property for a layer.

getRasterParticleFadeOpacityFactor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleMaxSpeed

Gets the raster-particle-max-speed paint property for a layer.

getRasterParticleMaxSpeed(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleResetRateFactor

Gets the raster-particle-reset-rate-factor paint property for a layer.

getRasterParticleResetRateFactor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterParticleSpeedFactor

Gets the raster-particle-speed-factor paint property for a layer.

getRasterParticleSpeedFactor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterResampling

Gets the raster-resampling paint property for a layer.

getRasterResampling(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getRasterSaturation

Gets the raster-saturation paint property for a layer.

getRasterSaturation(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyAtmosphereColor

Gets the sky-atmosphere-color paint property for a layer.

getSkyAtmosphereColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyAtmosphereHaloColor

Gets the sky-atmosphere-halo-color paint property for a layer.

getSkyAtmosphereHaloColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyAtmosphereSun

Gets the sky-atmosphere-sun paint property for a layer.

getSkyAtmosphereSun(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyAtmosphereSunIntensity

Gets the sky-atmosphere-sun-intensity paint property for a layer.

getSkyAtmosphereSunIntensity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyGradient

Gets the sky-gradient paint property for a layer.

getSkyGradient(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyGradientCenter

Gets the sky-gradient-center paint property for a layer.

getSkyGradientCenter(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyGradientRadius

Gets the sky-gradient-radius paint property for a layer.

getSkyGradientRadius(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyOpacity

Gets the sky-opacity paint property for a layer.

getSkyOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSkyType

Gets the sky-type paint property for a layer.

getSkyType(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolAvoidEdges

Gets the symbol-avoid-edges layout property for a layer.

getSymbolAvoidEdges(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolElevationReference

Gets the symbol-elevation-reference layout property for a layer.

getSymbolElevationReference(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolPlacement

Gets the symbol-placement layout property for a layer.

getSymbolPlacement(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolSortKey

Gets the symbol-sort-key layout property for a layer.

getSymbolSortKey(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolSpacing

Gets the symbol-spacing layout property for a layer.

getSymbolSpacing(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolZElevate

Gets the symbol-z-elevate layout property for a layer.

getSymbolZElevate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolZOffset

Gets the symbol-z-offset paint property for a layer.

getSymbolZOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getSymbolZOrder

Gets the symbol-z-order layout property for a layer.

getSymbolZOrder(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextAllowOverlap

Gets the text-allow-overlap layout property for a layer.

getTextAllowOverlap(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextAnchor

Gets the text-anchor layout property for a layer.

getTextAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextColor

Gets the text-color paint property for a layer.

getTextColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextEmissiveStrength

Gets the text-emissive-strength paint property for a layer.

getTextEmissiveStrength(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextField

Gets the text-field layout property for a layer.

getTextField(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextFont

Gets the text-font layout property for a layer.

getTextFont(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextHaloBlur

Gets the text-halo-blur paint property for a layer.

getTextHaloBlur(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextHaloColor

Gets the text-halo-color paint property for a layer.

getTextHaloColor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextHaloWidth

Gets the text-halo-width paint property for a layer.

getTextHaloWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextIgnorePlacement

Gets the text-ignore-placement layout property for a layer.

getTextIgnorePlacement(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextJustify

Gets the text-justify layout property for a layer.

getTextJustify(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextKeepUpright

Gets the text-keep-upright layout property for a layer.

getTextKeepUpright(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextLetterSpacing

Gets the text-letter-spacing layout property for a layer.

getTextLetterSpacing(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextLineHeight

Gets the text-line-height layout property for a layer.

getTextLineHeight(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextMaxAngle

Gets the text-max-angle layout property for a layer.

getTextMaxAngle(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextMaxWidth

Gets the text-max-width layout property for a layer.

getTextMaxWidth(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextOcclusionOpacity

Gets the text-occlusion-opacity paint property for a layer.

getTextOcclusionOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextOffset

Gets the text-offset layout property for a layer.

getTextOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextOpacity

Gets the text-opacity paint property for a layer.

getTextOpacity(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextOptional

Gets the text-optional layout property for a layer.

getTextOptional(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextPadding

Gets the text-padding layout property for a layer.

getTextPadding(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextPitchAlignment

Gets the text-pitch-alignment layout property for a layer.

getTextPitchAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextRadialOffset

Gets the text-radial-offset layout property for a layer.

getTextRadialOffset(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextRotate

Gets the text-rotate layout property for a layer.

getTextRotate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextRotationAlignment

Gets the text-rotation-alignment layout property for a layer.

getTextRotationAlignment(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextSize

Gets the text-size layout property for a layer.

getTextSize(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextSizeScaleRange

Gets the text-size-scale-range layout property for a layer.

getTextSizeScaleRange(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextTransform

Gets the text-transform layout property for a layer.

getTextTransform(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextTranslate

Gets the text-translate paint property for a layer.

getTextTranslate(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextTranslateAnchor

Gets the text-translate-anchor paint property for a layer.

getTextTranslateAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextVariableAnchor

Gets the text-variable-anchor layout property for a layer.

getTextVariableAnchor(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getTextWritingMode

Gets the text-writing-mode layout property for a layer.

getTextWritingMode(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

getVisibility

Gets the visibility layout property for a layer.

getVisibility(layer: LayerRef): any
Parameters
layer (LayerRef)
Returns
any

setBackgroundColor

Sets the background-color paint property for one or more layers.

setBackgroundColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setBackgroundEmissiveStrength

Sets the background-emissive-strength paint property for one or more layers.

setBackgroundEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setBackgroundOpacity

Sets the background-opacity paint property for one or more layers.

setBackgroundOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setBackgroundPattern

Sets the background-pattern paint property for one or more layers.

setBackgroundPattern(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setBackgroundPitchAlignment

Sets the background-pitch-alignment paint property for one or more layers.

setBackgroundPitchAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleBlur

Sets the circle-blur paint property for one or more layers.

setCircleBlur(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleColor

Sets the circle-color paint property for one or more layers.

setCircleColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleEmissiveStrength

Sets the circle-emissive-strength paint property for one or more layers.

setCircleEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleOpacity

Sets the circle-opacity paint property for one or more layers.

setCircleOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCirclePitchAlignment

Sets the circle-pitch-alignment paint property for one or more layers.

setCirclePitchAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCirclePitchScale

Sets the circle-pitch-scale paint property for one or more layers.

setCirclePitchScale(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleRadius

Sets the circle-radius paint property for one or more layers.

setCircleRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleSortKey

Sets the circle-sort-key layout property for one or more layers.

setCircleSortKey(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleStrokeColor

Sets the circle-stroke-color paint property for one or more layers.

setCircleStrokeColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleStrokeOpacity

Sets the circle-stroke-opacity paint property for one or more layers.

setCircleStrokeOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleStrokeWidth

Sets the circle-stroke-width paint property for one or more layers.

setCircleStrokeWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleTranslate

Sets the circle-translate paint property for one or more layers.

setCircleTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setCircleTranslateAnchor

Sets the circle-translate-anchor paint property for one or more layers.

setCircleTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setClipLayerScope

Sets the clip-layer-scope layout property for one or more layers.

setClipLayerScope(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setClipLayerTypes

Sets the clip-layer-types layout property for one or more layers.

setClipLayerTypes(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillAntialias

Sets the fill-antialias paint property for one or more layers.

setFillAntialias(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillColor

Sets the fill-color paint property for one or more layers.

setFillColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillElevationReference

Sets the fill-elevation-reference layout property for one or more layers.

setFillElevationReference(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillEmissiveStrength

Sets the fill-emissive-strength paint property for one or more layers.

setFillEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionAmbientOcclusionGroundAttenuation

Sets the fill-extrusion-ambient-occlusion-ground-attenuation paint property for one or more layers.

setFillExtrusionAmbientOcclusionGroundAttenuation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionAmbientOcclusionGroundRadius

Sets the fill-extrusion-ambient-occlusion-ground-radius paint property for one or more layers.

setFillExtrusionAmbientOcclusionGroundRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionAmbientOcclusionIntensity

Sets the fill-extrusion-ambient-occlusion-intensity paint property for one or more layers.

setFillExtrusionAmbientOcclusionIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionAmbientOcclusionRadius

Sets the fill-extrusion-ambient-occlusion-radius paint property for one or more layers.

setFillExtrusionAmbientOcclusionRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionAmbientOcclusionWallRadius

Sets the fill-extrusion-ambient-occlusion-wall-radius paint property for one or more layers.

setFillExtrusionAmbientOcclusionWallRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionBase

Sets the fill-extrusion-base paint property for one or more layers.

setFillExtrusionBase(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionBaseAlignment

Sets the fill-extrusion-base-alignment paint property for one or more layers.

setFillExtrusionBaseAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionCastShadows

Sets the fill-extrusion-cast-shadows paint property for one or more layers.

setFillExtrusionCastShadows(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionColor

Sets the fill-extrusion-color paint property for one or more layers.

setFillExtrusionColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionCutoffFadeRange

Sets the fill-extrusion-cutoff-fade-range paint property for one or more layers.

setFillExtrusionCutoffFadeRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionEdgeRadius

Sets the fill-extrusion-edge-radius layout property for one or more layers.

setFillExtrusionEdgeRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionEmissiveStrength

Sets the fill-extrusion-emissive-strength paint property for one or more layers.

setFillExtrusionEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionFloodLightColor

Sets the fill-extrusion-flood-light-color paint property for one or more layers.

setFillExtrusionFloodLightColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionFloodLightGroundAttenuation

Sets the fill-extrusion-flood-light-ground-attenuation paint property for one or more layers.

setFillExtrusionFloodLightGroundAttenuation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionFloodLightGroundRadius

Sets the fill-extrusion-flood-light-ground-radius paint property for one or more layers.

setFillExtrusionFloodLightGroundRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionFloodLightIntensity

Sets the fill-extrusion-flood-light-intensity paint property for one or more layers.

setFillExtrusionFloodLightIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionFloodLightWallRadius

Sets the fill-extrusion-flood-light-wall-radius paint property for one or more layers.

setFillExtrusionFloodLightWallRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionHeight

Sets the fill-extrusion-height paint property for one or more layers.

setFillExtrusionHeight(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionHeightAlignment

Sets the fill-extrusion-height-alignment paint property for one or more layers.

setFillExtrusionHeightAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionLineWidth

Sets the fill-extrusion-line-width paint property for one or more layers.

setFillExtrusionLineWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionOpacity

Sets the fill-extrusion-opacity paint property for one or more layers.

setFillExtrusionOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionPattern

Sets the fill-extrusion-pattern paint property for one or more layers.

setFillExtrusionPattern(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionRoundedRoof

Sets the fill-extrusion-rounded-roof paint property for one or more layers.

setFillExtrusionRoundedRoof(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionTranslate

Sets the fill-extrusion-translate paint property for one or more layers.

setFillExtrusionTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionTranslateAnchor

Sets the fill-extrusion-translate-anchor paint property for one or more layers.

setFillExtrusionTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionVerticalGradient

Sets the fill-extrusion-vertical-gradient paint property for one or more layers.

setFillExtrusionVerticalGradient(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillExtrusionVerticalScale

Sets the fill-extrusion-vertical-scale paint property for one or more layers.

setFillExtrusionVerticalScale(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillOpacity

Sets the fill-opacity paint property for one or more layers.

setFillOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillOutlineColor

Sets the fill-outline-color paint property for one or more layers.

setFillOutlineColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillPattern

Sets the fill-pattern paint property for one or more layers.

setFillPattern(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillSortKey

Sets the fill-sort-key layout property for one or more layers.

setFillSortKey(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillTranslate

Sets the fill-translate paint property for one or more layers.

setFillTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillTranslateAnchor

Sets the fill-translate-anchor paint property for one or more layers.

setFillTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setFillZOffset

Sets the fill-z-offset paint property for one or more layers.

setFillZOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHeatmapColor

Sets the heatmap-color paint property for one or more layers.

setHeatmapColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHeatmapIntensity

Sets the heatmap-intensity paint property for one or more layers.

setHeatmapIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHeatmapOpacity

Sets the heatmap-opacity paint property for one or more layers.

setHeatmapOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHeatmapRadius

Sets the heatmap-radius paint property for one or more layers.

setHeatmapRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHeatmapWeight

Sets the heatmap-weight paint property for one or more layers.

setHeatmapWeight(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeAccentColor

Sets the hillshade-accent-color paint property for one or more layers.

setHillshadeAccentColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeEmissiveStrength

Sets the hillshade-emissive-strength paint property for one or more layers.

setHillshadeEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeExaggeration

Sets the hillshade-exaggeration paint property for one or more layers.

setHillshadeExaggeration(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeHighlightColor

Sets the hillshade-highlight-color paint property for one or more layers.

setHillshadeHighlightColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeIlluminationAnchor

Sets the hillshade-illumination-anchor paint property for one or more layers.

setHillshadeIlluminationAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeIlluminationDirection

Sets the hillshade-illumination-direction paint property for one or more layers.

setHillshadeIlluminationDirection(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setHillshadeShadowColor

Sets the hillshade-shadow-color paint property for one or more layers.

setHillshadeShadowColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconAllowOverlap

Sets the icon-allow-overlap layout property for one or more layers.

setIconAllowOverlap(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconAnchor

Sets the icon-anchor layout property for one or more layers.

setIconAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconColor

Sets the icon-color paint property for one or more layers.

setIconColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconColorBrightnessMax

Sets the icon-color-brightness-max paint property for one or more layers.

setIconColorBrightnessMax(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconColorBrightnessMin

Sets the icon-color-brightness-min paint property for one or more layers.

setIconColorBrightnessMin(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconColorContrast

Sets the icon-color-contrast paint property for one or more layers.

setIconColorContrast(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconColorSaturation

Sets the icon-color-saturation paint property for one or more layers.

setIconColorSaturation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconEmissiveStrength

Sets the icon-emissive-strength paint property for one or more layers.

setIconEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconHaloBlur

Sets the icon-halo-blur paint property for one or more layers.

setIconHaloBlur(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconHaloColor

Sets the icon-halo-color paint property for one or more layers.

setIconHaloColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconHaloWidth

Sets the icon-halo-width paint property for one or more layers.

setIconHaloWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconIgnorePlacement

Sets the icon-ignore-placement layout property for one or more layers.

setIconIgnorePlacement(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconImage

Sets the icon-image layout property for one or more layers.

setIconImage(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconImageCrossFade

Sets the icon-image-cross-fade paint property for one or more layers.

setIconImageCrossFade(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconKeepUpright

Sets the icon-keep-upright layout property for one or more layers.

setIconKeepUpright(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconOcclusionOpacity

Sets the icon-occlusion-opacity paint property for one or more layers.

setIconOcclusionOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconOffset

Sets the icon-offset layout property for one or more layers.

setIconOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconOpacity

Sets the icon-opacity paint property for one or more layers.

setIconOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconOptional

Sets the icon-optional layout property for one or more layers.

setIconOptional(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconPadding

Sets the icon-padding layout property for one or more layers.

setIconPadding(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconPitchAlignment

Sets the icon-pitch-alignment layout property for one or more layers.

setIconPitchAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconRotate

Sets the icon-rotate layout property for one or more layers.

setIconRotate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconRotationAlignment

Sets the icon-rotation-alignment layout property for one or more layers.

setIconRotationAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconSize

Sets the icon-size layout property for one or more layers.

setIconSize(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconSizeScaleRange

Sets the icon-size-scale-range layout property for one or more layers.

setIconSizeScaleRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconTextFit

Sets the icon-text-fit layout property for one or more layers.

setIconTextFit(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconTextFitPadding

Sets the icon-text-fit-padding layout property for one or more layers.

setIconTextFitPadding(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconTranslate

Sets the icon-translate paint property for one or more layers.

setIconTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setIconTranslateAnchor

Sets the icon-translate-anchor paint property for one or more layers.

setIconTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineBlur

Sets the line-blur paint property for one or more layers.

setLineBlur(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineBorderColor

Sets the line-border-color paint property for one or more layers.

setLineBorderColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineBorderWidth

Sets the line-border-width paint property for one or more layers.

setLineBorderWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineCap

Sets the line-cap layout property for one or more layers.

setLineCap(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineColor

Sets the line-color paint property for one or more layers.

setLineColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineCrossSlope

Sets the line-cross-slope layout property for one or more layers.

setLineCrossSlope(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineDasharray

Sets the line-dasharray paint property for one or more layers.

setLineDasharray(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineElevationReference

Sets the line-elevation-reference layout property for one or more layers.

setLineElevationReference(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineEmissiveStrength

Sets the line-emissive-strength paint property for one or more layers.

setLineEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineGapWidth

Sets the line-gap-width paint property for one or more layers.

setLineGapWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineGradient

Sets the line-gradient paint property for one or more layers.

setLineGradient(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineJoin

Sets the line-join layout property for one or more layers.

setLineJoin(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineMiterLimit

Sets the line-miter-limit layout property for one or more layers.

setLineMiterLimit(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineOcclusionOpacity

Sets the line-occlusion-opacity paint property for one or more layers.

setLineOcclusionOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineOffset

Sets the line-offset paint property for one or more layers.

setLineOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineOpacity

Sets the line-opacity paint property for one or more layers.

setLineOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLinePattern

Sets the line-pattern paint property for one or more layers.

setLinePattern(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineRoundLimit

Sets the line-round-limit layout property for one or more layers.

setLineRoundLimit(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineSortKey

Sets the line-sort-key layout property for one or more layers.

setLineSortKey(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineTranslate

Sets the line-translate paint property for one or more layers.

setLineTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineTranslateAnchor

Sets the line-translate-anchor paint property for one or more layers.

setLineTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineTrimColor

Sets the line-trim-color paint property for one or more layers.

setLineTrimColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineTrimFadeRange

Sets the line-trim-fade-range paint property for one or more layers.

setLineTrimFadeRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineTrimOffset

Sets the line-trim-offset paint property for one or more layers.

setLineTrimOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineWidth

Sets the line-width paint property for one or more layers.

setLineWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineWidthUnit

Sets the line-width-unit layout property for one or more layers.

setLineWidthUnit(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setLineZOffset

Sets the line-z-offset layout property for one or more layers.

setLineZOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelAmbientOcclusionIntensity

Sets the model-ambient-occlusion-intensity paint property for one or more layers.

setModelAmbientOcclusionIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelCastShadows

Sets the model-cast-shadows paint property for one or more layers.

setModelCastShadows(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelColor

Sets the model-color paint property for one or more layers.

setModelColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelColorMixIntensity

Sets the model-color-mix-intensity paint property for one or more layers.

setModelColorMixIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelCutoffFadeRange

Sets the model-cutoff-fade-range paint property for one or more layers.

setModelCutoffFadeRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelEmissiveStrength

Sets the model-emissive-strength paint property for one or more layers.

setModelEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelFrontCutoff

Sets the model-front-cutoff paint property for one or more layers.

setModelFrontCutoff(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelHeightBasedEmissiveStrengthMultiplier

Sets the model-height-based-emissive-strength-multiplier paint property for one or more layers.

setModelHeightBasedEmissiveStrengthMultiplier(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelId

Sets the model-id layout property for one or more layers.

setModelId(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelOpacity

Sets the model-opacity paint property for one or more layers.

setModelOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelReceiveShadows

Sets the model-receive-shadows paint property for one or more layers.

setModelReceiveShadows(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelRotation

Sets the model-rotation paint property for one or more layers.

setModelRotation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelRoughness

Sets the model-roughness paint property for one or more layers.

setModelRoughness(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelScale

Sets the model-scale paint property for one or more layers.

setModelScale(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelTranslation

Sets the model-translation paint property for one or more layers.

setModelTranslation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setModelType

Sets the model-type paint property for one or more layers.

setModelType(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterArrayBand

Sets the raster-array-band paint property for one or more layers.

setRasterArrayBand(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterBrightnessMax

Sets the raster-brightness-max paint property for one or more layers.

setRasterBrightnessMax(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterBrightnessMin

Sets the raster-brightness-min paint property for one or more layers.

setRasterBrightnessMin(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterColor

Sets the raster-color paint property for one or more layers.

setRasterColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterColorMix

Sets the raster-color-mix paint property for one or more layers.

setRasterColorMix(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterColorRange

Sets the raster-color-range paint property for one or more layers.

setRasterColorRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterContrast

Sets the raster-contrast paint property for one or more layers.

setRasterContrast(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterElevation

Sets the raster-elevation paint property for one or more layers.

setRasterElevation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterEmissiveStrength

Sets the raster-emissive-strength paint property for one or more layers.

setRasterEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterFadeDuration

Sets the raster-fade-duration paint property for one or more layers.

setRasterFadeDuration(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterHueRotate

Sets the raster-hue-rotate paint property for one or more layers.

setRasterHueRotate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterOpacity

Sets the raster-opacity paint property for one or more layers.

setRasterOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleArrayBand

Sets the raster-particle-array-band paint property for one or more layers.

setRasterParticleArrayBand(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleColor

Sets the raster-particle-color paint property for one or more layers.

setRasterParticleColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleCount

Sets the raster-particle-count paint property for one or more layers.

setRasterParticleCount(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleElevation

Sets the raster-particle-elevation paint property for one or more layers.

setRasterParticleElevation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleFadeOpacityFactor

Sets the raster-particle-fade-opacity-factor paint property for one or more layers.

setRasterParticleFadeOpacityFactor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleMaxSpeed

Sets the raster-particle-max-speed paint property for one or more layers.

setRasterParticleMaxSpeed(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleResetRateFactor

Sets the raster-particle-reset-rate-factor paint property for one or more layers.

setRasterParticleResetRateFactor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterParticleSpeedFactor

Sets the raster-particle-speed-factor paint property for one or more layers.

setRasterParticleSpeedFactor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterResampling

Sets the raster-resampling paint property for one or more layers.

setRasterResampling(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setRasterSaturation

Sets the raster-saturation paint property for one or more layers.

setRasterSaturation(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyAtmosphereColor

Sets the sky-atmosphere-color paint property for one or more layers.

setSkyAtmosphereColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyAtmosphereHaloColor

Sets the sky-atmosphere-halo-color paint property for one or more layers.

setSkyAtmosphereHaloColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyAtmosphereSun

Sets the sky-atmosphere-sun paint property for one or more layers.

setSkyAtmosphereSun(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyAtmosphereSunIntensity

Sets the sky-atmosphere-sun-intensity paint property for one or more layers.

setSkyAtmosphereSunIntensity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyGradient

Sets the sky-gradient paint property for one or more layers.

setSkyGradient(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyGradientCenter

Sets the sky-gradient-center paint property for one or more layers.

setSkyGradientCenter(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyGradientRadius

Sets the sky-gradient-radius paint property for one or more layers.

setSkyGradientRadius(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyOpacity

Sets the sky-opacity paint property for one or more layers.

setSkyOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSkyType

Sets the sky-type paint property for one or more layers.

setSkyType(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolAvoidEdges

Sets the symbol-avoid-edges layout property for one or more layers.

setSymbolAvoidEdges(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolElevationReference

Sets the symbol-elevation-reference layout property for one or more layers.

setSymbolElevationReference(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolPlacement

Sets the symbol-placement layout property for one or more layers.

setSymbolPlacement(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolSortKey

Sets the symbol-sort-key layout property for one or more layers.

setSymbolSortKey(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolSpacing

Sets the symbol-spacing layout property for one or more layers.

setSymbolSpacing(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolZElevate

Sets the symbol-z-elevate layout property for one or more layers.

setSymbolZElevate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolZOffset

Sets the symbol-z-offset paint property for one or more layers.

setSymbolZOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setSymbolZOrder

Sets the symbol-z-order layout property for one or more layers.

setSymbolZOrder(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextAllowOverlap

Sets the text-allow-overlap layout property for one or more layers.

setTextAllowOverlap(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextAnchor

Sets the text-anchor layout property for one or more layers.

setTextAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextColor

Sets the text-color paint property for one or more layers.

setTextColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextEmissiveStrength

Sets the text-emissive-strength paint property for one or more layers.

setTextEmissiveStrength(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextField

Sets the text-field layout property for one or more layers.

setTextField(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextFont

Sets the text-font layout property for one or more layers.

setTextFont(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextHaloBlur

Sets the text-halo-blur paint property for one or more layers.

setTextHaloBlur(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextHaloColor

Sets the text-halo-color paint property for one or more layers.

setTextHaloColor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextHaloWidth

Sets the text-halo-width paint property for one or more layers.

setTextHaloWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextIgnorePlacement

Sets the text-ignore-placement layout property for one or more layers.

setTextIgnorePlacement(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextJustify

Sets the text-justify layout property for one or more layers.

setTextJustify(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextKeepUpright

Sets the text-keep-upright layout property for one or more layers.

setTextKeepUpright(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextLetterSpacing

Sets the text-letter-spacing layout property for one or more layers.

setTextLetterSpacing(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextLineHeight

Sets the text-line-height layout property for one or more layers.

setTextLineHeight(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextMaxAngle

Sets the text-max-angle layout property for one or more layers.

setTextMaxAngle(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextMaxWidth

Sets the text-max-width layout property for one or more layers.

setTextMaxWidth(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextOcclusionOpacity

Sets the text-occlusion-opacity paint property for one or more layers.

setTextOcclusionOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextOffset

Sets the text-offset layout property for one or more layers.

setTextOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextOpacity

Sets the text-opacity paint property for one or more layers.

setTextOpacity(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextOptional

Sets the text-optional layout property for one or more layers.

setTextOptional(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextPadding

Sets the text-padding layout property for one or more layers.

setTextPadding(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextPitchAlignment

Sets the text-pitch-alignment layout property for one or more layers.

setTextPitchAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextRadialOffset

Sets the text-radial-offset layout property for one or more layers.

setTextRadialOffset(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextRotate

Sets the text-rotate layout property for one or more layers.

setTextRotate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextRotationAlignment

Sets the text-rotation-alignment layout property for one or more layers.

setTextRotationAlignment(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextSize

Sets the text-size layout property for one or more layers.

setTextSize(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextSizeScaleRange

Sets the text-size-scale-range layout property for one or more layers.

setTextSizeScaleRange(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextTransform

Sets the text-transform layout property for one or more layers.

setTextTransform(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextTranslate

Sets the text-translate paint property for one or more layers.

setTextTranslate(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextTranslateAnchor

Sets the text-translate-anchor paint property for one or more layers.

setTextTranslateAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextVariableAnchor

Sets the text-variable-anchor layout property for one or more layers.

setTextVariableAnchor(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setTextWritingMode

Sets the text-writing-mode layout property for one or more layers.

setTextWritingMode(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void

setVisibility

Sets the visibility layout property for one or more layers.

setVisibility(layer: LayerRef, value: any): void
Parameters
layer (LayerRef)
value (any)
Returns
void