Global

Methods

fromExtents(extents) → {Extent}

Parameters:
Name Type Description
extents Array.<Extent> The extents to combine
Source:
Returns:
Extent combined from the given extents
Type
Extent

fromFeatures(features) → {module:ol/extent~Extent}

Parameters:
Name Type Description
features Array.<Feature> | FeatureCollection
Source:
Returns:
Creates a bounding box extent from the given features
Type
module:ol/extent~Extent

fromPixel(options) → {module:ol/extent~Extent}

Parameters:
Name Type Description
options FromPixelOptions The options
Source:
Returns:
Extent from a given pixel in the center and with a given size for a specific map.
Type
module:ol/extent~Extent

getFeaturesAtPixel(options) → {Array.<Feature>}

Parameters:
Name Type Description
options object
Properties
Name Type Attributes Default Description
map Map The map
layer VectorLayer The layer
pixel Pixel The pixel
clone boolean <optional>
 true If true, the feature will be cloned
hitTolerance number <optional>
 0 The hit tolerance
Source:
Returns:
The features in this layer at the given pixel.
Type
Array.<Feature>

getFeaturesFromClusterFeature(feature) → {Array.<Feature>|undefined}

Parameters:
Name Type Description
feature Feature
Source:
Returns:
The features that is represented by a cluster source feature
Type
Array.<Feature> | undefined

getPseudoCenter(geometry) → {Point}

approximate the center of a geometry. This function is optimized for rendering quickly a lot of complex geometries (e.g. styled with an icon or a regular shape positionned at the feature center).
Parameters:
Name Type Description
geometry module:ol/geom~Geometry any geometry
Source:
Returns:
point contained in the geometry
Type
Point

isDisplayable(layer, resolution) → {boolean}

Parameters:
Name Type Description
layer BaseLayer The layer
resolution number The resolution
Source:
Returns:
If true, the layer can be shown in the given resolution
Type
boolean

isVisible(layer, resolution) → {boolean}

Parameters:
Name Type Description
layer BaseLayer The layer
resolution number The resolution
Source:
Returns:
If true, the layer is visible and can be shown in the given resolution
Type
boolean

isVisibleForMap(layer, map) → {boolean}

Determines whether the layer is visbible and displayable.
Parameters:
Name Type Description
layer BaseLayer The layer.
map Map The map.
Source:
Returns:
If true, the layer is visible in the map
Type
boolean

isVisibleInView(layer, view) → {boolean}

Determines whether the layer is visbible and displayable.
Parameters:
Name Type Description
layer BaseLayer The layer.
view View The map.
Source:
Returns:
If true, the layer is visible in the view
Type
boolean

toggleInteraction(map, interaction, isActive)

Toogles the given control for the given map.
Parameters:
Name Type Description
map Map The map
interaction Interaction The control
isActive boolean If TRUE, the control will be added to the map
Source:

Type Definitions

BaseLayer

Type:
  • module:ol/layer/Base~BaseLayer
Source:

BaseLayer

Type:
  • module:ol/layer/Base~BaseLayer
Source:

BaseLayer

Type:
  • module:ol/layer/Base~BaseLayer
Source:

ClusterClickAndZoomOptions

Type:
  • object
Properties:
Name Type Attributes Default Description
clusters Array.<VectorLayer> The cluster layers
duration number <optional>
 500 The zoom duration
condition Condition <optional>
 doubleClick The condition
Source:

ClusterSource

Type:
  • module:ol/source/cluster~ClusterSource
Source:

Condition

Type:
  • module:ol/events/condition~Condition
Source:

Extent

Type:
  • module:ol/extent~Extent
Source:

Extent

Type:
  • module:ol/extent~Extent
Source:

Extent

Type:
  • module:ol/extent~Extent
Source:

Feature

Type:
  • module:ol/feature~Feature
Source:

Feature

Type:
  • module:ol/feature~Feature
Source:

Feature

Type:
  • module:ol/feature~Feature
Source:

FeatureCollection

Type:
  • module:ol/Collection~Collection.<Feature>
Source:

FromPixelOptions

Type:
  • object
Properties:
Name Type Description
pixel module:ol/pixel~Pixel The pixel representing the center
size module:ol/size~Size | number The size of the extent in pixels
map module:ol/Map~Map The map
Source:

Interaction

Type:
  • module:ol/interaction~Interaction
Source:

Map

Type:
  • module:ol/map~Map
Source:

Map

Type:
  • module:ol/map~Map
Source:

Map

Type:
  • module:ol/map~Map
Source:

Map

Type:
  • module:ol/map~Map
Source:

MapBrowserEvent

Type:
  • module:ol/mapbrowserevent~MapBrowserEvent
Source:

Pixel

Type:
  • module:ol/pixel~Pixel
Source:

VectorLayer

Type:
  • module:ol/layer/Vector~VectorLayer
Source:

VectorLayer

Type:
  • module:ol/layer/vector~VectorLayer
Source:

View

Type:
  • module:ol/view~View
Source:

View

Type:
  • module:ol/view~View
Source: