heatmap-layer

Functions

HeatmapLayer()

function HeatmapLayer(props: HeatmapLayerProps): null;

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

Parameters

Parameter	Type
`props`	`HeatmapLayerProps`

Returns

null

Interfaces

HeatmapLayerProps

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

Extends

LayerOptions<HeatmapLayerOptions>

Properties

Property	Type	Description	Inherited from
`blur?`	`NumberExpression`	Blur size in pixels. This is added to the `radius` parameter above to create the final size of the blur effect.	`LayerOptions.blur`
`className?`	`string`	A CSS class name to set to the layer element.	`LayerOptions.className`
`extent?`	`Extent`	The bounding extent for layer rendering. The layer will not be rendered outside of this extent.	`LayerOptions.extent`
`filter?`	`BooleanExpression`	Optional filter expression.	`LayerOptions.filter`
`gradient?`	`string`[]	The color gradient of the heatmap, specified as an array of CSS color strings.	`LayerOptions.gradient`
`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`
`radius?`	`NumberExpression`	Radius size in pixels. Note that for LineStrings, the width of the line will be double the radius.	`LayerOptions.radius`
`source?`	`VectorSource`<`Feature`<`Geometry`>>	Point source.	`LayerOptions.source`
`variables?`	{ [`x`: `string`]: `string` \| `number` \| `boolean` \| `number`[]; }	Variables used in expressions (optional)	`LayerOptions.variables`
`visible?`	`boolean`	Visibility.	`LayerOptions.visible`
`weight?`	`WeightExpression`	The feature attribute to use for the weight. This also supports expressions returning a number or a function that returns a weight from a feature. Weight values should range from 0 to 1 (and values outside will be clamped to that range).	`LayerOptions.weight`
`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