vector-layer

Functions

VectorLayer()

function VectorLayer(props: VectorLayerProps): null;

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

Parameters

Parameter	Type
`props`	`VectorLayerProps`

Returns

null

Interfaces

VectorLayerProps

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

Extends

LayerOptions<VectorLayerOptions>

Properties

Property	Type	Description	Inherited from
`background?`	`BackgroundColor`	Background color for the layer. If not specified, no background will be rendered.	`LayerOptions.background`
`className?`	`string`	A CSS class name to set to the layer element.	`LayerOptions.className`
`declutter?`	`string` \| `number` \| `boolean`	Declutter images and text. Any truthy value will enable decluttering. Within a layer, a feature rendered before another has higher priority. All layers with the same `declutter` value will be decluttered together. The priority is determined by the drawing order of the layers with the same `declutter` value. Higher in the layer stack means higher priority. To declutter distinct layers or groups of layers separately, use different truthy values for `declutter`.	`LayerOptions.declutter`
`extent?`	`Extent`	The bounding extent for layer rendering. The layer will not be rendered outside of this extent.	`LayerOptions.extent`
`map?`	`Map`	Sets 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?`	`number`	The maximum resolution (exclusive) below which this layer will be visible.	`LayerOptions.maxResolution`
`maxZoom?`	`number`	The maximum view zoom level (inclusive) at which this layer will be visible.	`LayerOptions.maxZoom`
`minResolution?`	`number`	The minimum resolution (inclusive) at which this layer will be visible.	`LayerOptions.minResolution`
`minZoom?`	`number`	The minimum view zoom level (exclusive) above which this layer will be visible.	`LayerOptions.minZoom`
`name`	`string`	-	`LayerOptions.name`
`opacity?`	`number`	Opacity (0, 1).	`LayerOptions.opacity`
`properties?`	{ [`x`: `string`]: `any`; }	Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.	`LayerOptions.properties`
`renderBuffer?`	`number`	The 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?`	`OrderFunction`	Render 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` \| `FlatStyleLike`	Layer 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`
`updateWhileAnimating?`	`boolean`	When set to `true`, feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to `false`, batches will be recreated when no animation is active.	`LayerOptions.updateWhileAnimating`
`updateWhileInteracting?`	`boolean`	When set to `true`, feature batches will be recreated during interactions. See also `updateWhileAnimating`.	`LayerOptions.updateWhileInteracting`
`visible?`	`boolean`	Visibility.	`LayerOptions.visible`
`zIndex?`	`number`	The 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`

On this page