Namespace: layer

bu. layer

This namespace contains definitions of objects that extend the functionality of the OpenLayers ol.layer namespace.

Source:
bu/layer/layer.jsdoc

Classes

Cesium3DTileset
LiDARProjects
Panoramas
PanoramasPoints

Type Definitions


Cesium3DTilesetOptions

Options for a bu.layer.Cesium3DTileset.

Type:
  • Object
Properties:
Name Type Description
minResolution number | undefined

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number | undefined

The maximum resolution (exclusive) below which this layer will be visible.

opacity number | undefined

Opacity. 0-1. Default is 1.

source bu.source.Cesium3DTileset | undefined

Source.

visible boolean | undefined

Visibility. Default is true (visible).

zIndex number | undefined

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.

extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

Source:
bu/typedefs.js

LiDARProjectsOptions

Options for a bu.layer.LiDARProjects.

Type:
  • Object
Properties:
Name Type Description
renderOrder ol.RenderOrderFunction | null | undefined

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.

minResolution number | undefined

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number | undefined

The maximum resolution (exclusive) below which this layer will be visible.

opacity number | undefined

Opacity. 0-1. Default is 1.

renderBuffer number | undefined

The buffer 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. Default is 100 pixels.

source ol.source.Vector | undefined

Source.

map ol.Map | undefined

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 ol.Map#addLayer.

style ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined

Layer style. See ol.style for default style which will be used if this is not defined.

updateWhileAnimating boolean | undefined

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. Default is false.

updateWhileInteracting boolean | undefined

When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating. Default is false.

visible boolean | undefined

Visibility. Default is true (visible).

zIndex number | undefined

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.

extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

featureTypesForResolutions bu.FeatureTypeResolution | undefined

An object defining a minimum resolution for the visibility of a given feature type name. The feature will be visible only if map resolution is above the resolution property.

Source:
bu/typedefs.js

PanoramasOptions

Options for a bu.layer.Panoramas.

Type:
  • Object
Properties:
Name Type Description
renderOrder ol.RenderOrderFunction | null | undefined

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.

minResolution number | undefined

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number | undefined

The maximum resolution (exclusive) below which this layer will be visible.

opacity number | undefined

Opacity. 0-1. Default is 1.

renderBuffer number | undefined

The buffer 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. Default is 100 pixels.

source ol.source.Vector | undefined

Source.

map ol.Map | undefined

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 ol.Map#addLayer.

style ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined

Layer style. See ol.style for default style which will be used if this is not defined.

updateWhileAnimating boolean | undefined

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. Default is false.

updateWhileInteracting boolean | undefined

When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating. Default is false.

visible boolean | undefined

Visibility. Default is true (visible).

zIndex number | undefined

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.

extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

featureTypesForResolutions bu.FeatureTypeResolution | undefined

An object defining a minimum resolution for the visibility of a given feature type name. The feature will be visible only if map resolution is above the resolution property.

resolutionFunction function | undefined

A function that receives a resolution and returns the real resolution to use with the featureTypesForResolutions property.

Source:
bu/typedefs.js