Interface MaskLayerOptions

interface MaskLayerOptions {
    backgroundColor?: ColorRepresentation;
    colorMap?: ColorMap;
    computeMinMax?: boolean;
    extent?: Extent;
    interpretation?: Interpretation;
    magFilter?: MagnificationTextureFilter;
    maskMode?: MaskMode;
    minFilter?: MinificationTextureFilter;
    name?: string;
    noDataOptions?: NoDataOptions;
    preloadImages?: boolean;
    resolutionFactor?: number;
    showEmptyTextures?: boolean;
    showTileBorders?: boolean;
    source: ImageSource<ImageSourceEvents>;
}

Hierarchy (view full)

Properties

backgroundColor? colorMap? computeMinMax? extent? interpretation? magFilter? maskMode? minFilter? name? noDataOptions? preloadImages? resolutionFactor? showEmptyTextures? showTileBorders? source

Properties

OptionalbackgroundColor

backgroundColor?: ColorRepresentation

The optional background color of the layer.

OptionalcolorMap

colorMap?: ColorMap

The optional color map to use.

OptionalcomputeMinMax

computeMinMax?: boolean

Enables min/max computation of source images. Mainly used for elevation data.

Optionalextent

extent?: Extent

The optional extent to use for this layer. If none is provided, then the extent from the source is used instead. The layer will not be visible outside this extent.

Optionalinterpretation

interpretation?: Interpretation

How to interpret the pixel data of the source.

OptionalmagFilter

magFilter?: MagnificationTextureFilter

The optional texture filter for magnification.

Default Value

Generally bilinear filtering, but some sources might provide different defaults.

OptionalmaskMode

maskMode?: MaskMode

How to interpret the mask.

OptionalminFilter

minFilter?: MinificationTextureFilter

The optional texture filter for minification.

Default Value

Generally bilinear filtering, but some sources might provide different defaults.

Optionalname

name?: string

An optional name for this layer.

OptionalnoDataOptions

noDataOptions?: NoDataOptions

How to treat no-data values.

OptionalpreloadImages

preloadImages?: boolean

Enables or disable preloading of low resolution fallback images. Those fallback images are used when no data is available yet on a particular region of the layer.

OptionalresolutionFactor

resolutionFactor?: number

The resolution factor applied to textures generated by this layer, compared to the pixel size of the targets. Default is 1. A value greater than one will create textures with a higher resolution than what is asked by the targets. For example, if a map tile has a texture size of 256*256, and a layer has a resolution factor of 2, the generated textures will have a size of 512*512 pixels.

OptionalshowEmptyTextures

showEmptyTextures?: boolean

Displays empty textures as colored rectangles.

OptionalshowTileBorders

showTileBorders?: boolean

Displays the border of source images.

source

source: ImageSource<ImageSourceEvents>

The source of the layer.

Settings

Member Visibility

On This Page

Properties