tile-layer

Functions

TileLayer()

function TileLayer(props: TileLayerProps): null;

Defined in: packages/openlayers/src/layer/tile-layer.tsx:12

Parameters

Parameter	Type
`props`	`TileLayerProps`

Returns

null

Interfaces

TileLayerProps

Defined in: packages/openlayers/src/layer/tile-layer.tsx:10

Extends

LayerOptions<BaseTileLayerOptions<TileSource>>

Properties

Property	Type	Description	Inherited from
`background?`	`BackgroundColor`	Background color for the layer. If not specified, no background will be rendered.	`LayerOptions.background`
`cacheSize?`	`number`	The internal tile cache size. This needs to be large enough to render two zoom levels worth of tiles.	`LayerOptions.cacheSize`
`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`
`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 import ("../Map.js").default#addLayer map.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`
`preload?`	`number`	Preload. Load low-resolution tiles up to `preload` levels. `0` means no preloading.	`LayerOptions.preload`
`properties?`	{ [`x`: `string`]: `any`; }	Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.	`LayerOptions.properties`
`source?`	`TileSource`<`Tile`>	Source for this layer.	`LayerOptions.source`
`useInterimTilesOnError?`	`boolean`	Deprecated. Use interim tiles on error.	`LayerOptions.useInterimTilesOnError`
`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