RasterLayer.md

March 19, 2018 ยท View on GitHub

<MapboxGL.RasterLayer />

props

PropTypeDefaultRequiredDescription
idstringnonefalseA string that uniquely identifies the source in the style to which it is added.
sourceIDstringMapboxGL.StyleSource.DefaultSourceIDfalseThe source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
sourceLayerIDstringnonefalseIdentifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
aboveLayerIDstringnonefalseInserts a layer above aboveLayerID.
belowLayerIDstringnonefalseInserts a layer below belowLayerID
layerIndexnumbernonefalseInserts a layer at a specified index
filterarraynonefalseFilter only the features in the source layer that satisfy a condition that you define
minZoomLevelnumbernonefalseThe minimum zoom level at which the layer gets parsed and appears.
maxZoomLevelnumbernonefalseThe maximum zoom level at which the layer gets parsed and appears.
styleunionnonefalseCustomizable style attributes

styles


Name

visibility

Description

Whether this layer is displayed.

Type

enum

Default Value

visible

Supported Values

visible - The layer is shown.
none - The layer is not shown.


Name

rasterOpacity

Description

The opacity at which the image will be drawn.

Type

number

Default Value

1

Minimum

0

Maximum

1

Supported Style Functions

camera


Name

rasterHueRotate

Description

Rotates hues around the color wheel.

Type

number

Default Value

0

Units

degrees

Supported Style Functions

camera


Name

rasterBrightnessMin

Description

Increase or reduce the brightness of the image. The value is the minimum brightness.

Type

number

Default Value

0

Minimum

0

Maximum

1

Supported Style Functions

camera


Name

rasterBrightnessMax

Description

Increase or reduce the brightness of the image. The value is the maximum brightness.

Type

number

Default Value

1

Minimum

0

Maximum

1

Supported Style Functions

camera


Name

rasterSaturation

Description

Increase or reduce the saturation of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Supported Style Functions

camera


Name

rasterContrast

Description

Increase or reduce the contrast of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Supported Style Functions

camera


Name

rasterFadeDuration

Description

Fade duration when a new tile is added.

Type

number

Default Value

300

Units

milliseconds

Minimum

0

Supported Style Functions

camera