Skip to content

Latest commit

 

History

History
349 lines (213 loc) · 4.69 KB

RasterLayer.md

File metadata and controls

349 lines (213 loc) · 4.69 KB

<MapLibreGL.RasterLayer />

props

Prop Type Default Required Description
style RasterLayerStyleProps none false Customizable style attributes
sourceID FIX ME UNKNOWN TYPE MapLibreGL.StyleSource.DefaultSourceID false FIX ME NO DESCRIPTION

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

Expression

Parameters: zoom


Name

rasterOpacityTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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 propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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 propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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 propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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 propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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 propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


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


Name

rasterFadeDuration

Description

Fade duration when a new tile is added.

Type

number

Default Value

300

Units

milliseconds

Minimum

0

Expression

Parameters: zoom