Skip to content

Latest commit

 

History

History
357 lines (220 loc) · 5.88 KB

RasterLayer.md

File metadata and controls

357 lines (220 loc) · 5.88 KB

<MapboxGL.RasterLayer />

props

Prop Type Default Required Description
id string none true A string that uniquely identifies the source in the style to which it is added.
sourceID string MapboxGL.StyleSource.DefaultSourceID false The 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.
Inferred from parent source only if the layer is a direct child to it.
sourceLayerID string none false Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
aboveLayerID string none false Inserts a layer above aboveLayerID.
belowLayerID string none false Inserts a layer below belowLayerID
layerIndex number none false Inserts a layer at a specified index
filter array none false Filter only the features in the source layer that satisfy a condition that you define
minZoomLevel number none false The minimum zoom level at which the layer gets parsed and appears.
maxZoomLevel number none false The maximum zoom level at which the layer gets parsed and appears.
style union none false Customizable style attributes

styles


visibility

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.


rasterOpacity

Name: rasterOpacity

Description

The opacity at which the image will be drawn.

Type

number

Default Value

1

Minimum

0

Maximum

1

Expression

Parameters: zoom


Name

rasterOpacityTransition

Description

The transition affecting any changes to this layer’s rasterOpacity property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterHueRotate

Name: rasterHueRotate

Description

Rotates hues around the color wheel.

Type

number

Default Value

0

Units

degrees

Expression

Parameters: zoom


Name

rasterHueRotateTransition

Description

The transition affecting any changes to this layer’s rasterHueRotate property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterBrightnessMin

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

Expression

Parameters: zoom


Name

rasterBrightnessMinTransition

Description

The transition affecting any changes to this layer’s rasterBrightnessMin property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterBrightnessMax

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

Expression

Parameters: zoom


Name

rasterBrightnessMaxTransition

Description

The transition affecting any changes to this layer’s rasterBrightnessMax property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterSaturation

Name: rasterSaturation

Description

Increase or reduce the saturation of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Expression

Parameters: zoom


Name

rasterSaturationTransition

Description

The transition affecting any changes to this layer’s rasterSaturation property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterContrast

Name: rasterContrast

Description

Increase or reduce the contrast of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Expression

Parameters: zoom


Name

rasterContrastTransition

Description

The transition affecting any changes to this layer’s rasterContrast property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


rasterResampling

Name: rasterResampling

Description

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

Type

enum

Default Value

linear

Supported Values

linear - (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled
nearest - Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled

Expression

Parameters: zoom


rasterFadeDuration

Name: rasterFadeDuration

Description

Fade duration when a new tile is added.

Type

number

Default Value

300

Units

milliseconds

Minimum

0

Expression

Parameters: zoom