@react-gis/openlayerslayer

vector-image-layer

Functions

VectorImageLayer()

function VectorImageLayer(props: VectorImageLayerProps): null;

Defined in: packages/openlayers/src/layer/vector-image-layer.tsx:11

Parameters

ParameterType
propsVectorImageLayerProps

Returns

null

Interfaces

VectorImageLayerProps

Defined in: packages/openlayers/src/layer/vector-image-layer.tsx:9

Extends

Properties

PropertyTypeDescriptionInherited from
background?BackgroundColorBackground color for the layer. If not specified, no background will be rendered.LayerOptions.background
className?stringA CSS class name to set to the layer element.LayerOptions.className
declutter?string | number | booleanDeclutter images and text on this layer. Any truthy value will enable decluttering. The priority is defined by the zIndex of the style and the render order of features. Higher z-index means higher priority. Within the same z-index, a feature rendered before another has higher priority. Items will not be decluttered against or together with items on other layers with the same declutter value. If that is needed, use import ("../layer/Vector.js").default instead.LayerOptions.declutter
extent?ExtentThe bounding extent for layer rendering. The layer will not be rendered outside of this extent.LayerOptions.extent
imageRatio?numberRatio by which the rendered extent should be larger than the viewport extent. A larger ratio avoids cut images during panning, but will cause a decrease in performance.LayerOptions.imageRatio
map?MapSets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use [map.addLayer()]import ("../Map.js").default#addLayer.LayerOptions.map
maxResolution?numberThe maximum resolution (exclusive) below which this layer will be visible.LayerOptions.maxResolution
maxZoom?numberThe maximum view zoom level (inclusive) at which this layer will be visible.LayerOptions.maxZoom
minResolution?numberThe minimum resolution (inclusive) at which this layer will be visible.LayerOptions.minResolution
minZoom?numberThe minimum view zoom level (exclusive) above which this layer will be visible.LayerOptions.minZoom
namestring-LayerOptions.name
opacity?numberOpacity (0, 1).LayerOptions.opacity
properties?{ [x: string]: any; }Arbitrary observable properties. Can be accessed with #get() and #set().LayerOptions.properties
renderBuffer?numberThe buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. Recommended value: the size of the largest symbol, line width or label.LayerOptions.renderBuffer
renderOrder?OrderFunctionRender order. Function to be used when sorting features before rendering. By default features are drawn in the order that they are created. Use null to avoid the sort, but get an undefined draw order.LayerOptions.renderOrder
source?VectorSource<any>Source.LayerOptions.source
style?null | StyleLike | FlatStyleLikeLayer style. When set to null, only features that have their own style will be rendered. See module :ol/style/Style~Style for the default style which will be used if this is not set.LayerOptions.style
visible?booleanVisibility.LayerOptions.visible
zIndex?numberThe z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.LayerOptions.zIndex