Module: ol-map

OpenLayers map component.

Source:

Example

<OlMap />

Methods

(function) beforeRouteEnter()

Method beforeRouteEnter
Source:

(function) beforeRouteLeave()

Method beforeRouteLeave
Source:

(function) beforeRouteUpdate()

Method beforeRouteUpdate
Source:

(computed) mapContainerStyle()

Method mapContainerStyle
Source:

(computed) toolbarComponent()

Method toolbarComponent
Source:

(function) data()

Method data
Source:

(method) clipLayer(event, compare, right)

Clips the rendering of a layer based on the specified comparison ratio and direction.

Parameters:
Name Type Description
event Object

The rendering event object containing the WebGL context.

compare number

The ratio (0 to 1) to determine the clipping position.

right boolean

If true, clips the right side of the layer; otherwise, clips the left side.

Source:

(method) exportMap(download)

Exports the map as an image.

Parameters:
Name Type Description
download boolean

Indicates whether the image should be downloaded.

Source:

(method) init(routeName)

Initializes the component.

Parameters:
Name Type Description
routeName string

The name of the route.

Source:

(method) popupClicked(feature)

Handles the click event on a popup.

Parameters:
Name Type Description
feature Object

The feature object associated with the clicked popup.

Source:

(method) render()

Renders the map.

Source:

(method) showLayers()

Method showLayers
Source:

(function) mounted()

Method mounted
Source:

(watcher) altSelectedCatalog()

Method altSelectedCatalog
Source:

(watcher) mapTilerOpacity()

Method mapTilerOpacity
Source:

(watcher) nutsLevel()

Method nutsLevel
Source:

(watcher) opacity()

Method opacity
Source:

(watcher) selectedBaseLayer()

Method selectedBaseLayer
Source:

(watcher) selectedCatalog()

Method selectedCatalog
Source:

(watcher) selectedDataSource()

Method selectedDataSource
Source:

(watcher) selectedIndicator()

Method selectedIndicator
Source:

(watcher) selectedSite()

Method selectedSite
Source:

(watcher) showEditableSource()

Method showEditableSource
Source:

(watcher) showPoints()

Method showPoints
Source:

(watcher) srid()

Method srid
Source:

(watcher) trackPosition()

Method trackPosition
Source:

(watcher) valueAtPixel()

Method valueAtPixel
Source:

(function) data()

Method data
Source:

(method) animateToExtent(source)

Animates the map view to the extent of a given source.

Parameters:
Name Type Description
source Source

The source to animate to.

Source:

(method) coordinates() → {Array.<number>}

Returns the coordinates of the map based on the client coordinates.

Source:
Returns:

The coordinates of the map.

Type
Array.<number>

(method) createLegend(color_map)

Creates a legend based on the provided color map.

Parameters:
Name Type Description
color_map string

The color map in JSON format.

Source:

(method) prepareFrequencyChart(points, numerical, decimalsForStats) → {Object}

Prepares a frequency chart based on the given points.

Parameters:
Name Type Description
points Array

The array of points.

numerical boolean

Indicates whether the points are numerical or not.

decimalsForStats number

The number of decimals to round the statistics to.

Source:
Returns:
  • The prepared frequency chart object.
Type
Object

(method) reprojectFeatures(features, oldProjection, newProjection)

Reprojects the given features from the old projection to the new projection.

Parameters:
Name Type Description
features Array.<ol.Feature>

The features to be reprojected.

oldProjection ol.proj.ProjectionLike

The old projection of the features.

newProjection ol.proj.ProjectionLike

The new projection to reproject the features to.

Source:

(method) rescale(value) → {number}

Rescales the given value based on the selected title's scale factor. If the scale factor is a number, the value is multiplied by the scale factor. If the scale factor is a formula, it is evaluated and applied to the value. If the formula fails to evaluate, the original value is returned.

Parameters:
Name Type Description
value number

The value to be rescaled.

Source:
Returns:

The rescaled value.

Type
number

(method) setSrid(val)

Sets the SRID (Spatial Reference System Identifier) for the map.

Parameters:
Name Type Description
val number

The SRID value to set.

Source:

(method) showFeatureStats(options) → {Promise.<void>}

Retrieves feature statistics based on the selected feature.

Parameters:
Name Type Description
options Object

The options for retrieving feature statistics.

Source:
Returns:
  • A promise that resolves when the feature statistics are retrieved.
Type
Promise.<void>

(method) showFrequencies(options) → {Promise.<void>}

Displays the frequencies of the selected indicator.

Parameters:
Name Type Description
options Object

The options for displaying the frequencies.

Source:
Returns:
  • A promise that resolves when the frequencies are displayed.
Type
Promise.<void>

(method) showHistory(options)

Show history of selected feature

Parameters:
Name Type Description
options *
Source:

(method) showProps(options)

Show properties of selected feature in a popup

Parameters:
Name Type Description
options *
Source:

(method) showSpectrum()

Method showSpectrum
Source:

(method) updateColorMap()

Method updateColorMap
Source:

(async, function) showSpectrum() → {Promise.<void>}

Shows the spectrum for the selected feature.

Source:
Returns:
Type
Promise.<void>

A mixin object containing common map methods

Source:

Methods

(function) beforeRouteEnter()

Method beforeRouteEnter
Source:

(function) beforeRouteLeave()

Method beforeRouteLeave
Source:

(function) beforeRouteUpdate()

Method beforeRouteUpdate
Source:

(computed) mapContainerStyle()

Method mapContainerStyle
Source:

(computed) toolbarComponent()

Method toolbarComponent
Source:

(function) data()

Method data
Source:

(method) clipLayer(event, compare, right)

Clips the rendering of a layer based on the specified comparison ratio and direction.

Parameters:
Name Type Description
event Object

The rendering event object containing the WebGL context.

compare number

The ratio (0 to 1) to determine the clipping position.

right boolean

If true, clips the right side of the layer; otherwise, clips the left side.

Source:

(method) exportMap(download)

Exports the map as an image.

Parameters:
Name Type Description
download boolean

Indicates whether the image should be downloaded.

Source:

(method) init(routeName)

Initializes the component.

Parameters:
Name Type Description
routeName string

The name of the route.

Source:

(method) popupClicked(feature)

Handles the click event on a popup.

Parameters:
Name Type Description
feature Object

The feature object associated with the clicked popup.

Source:

(method) render()

Renders the map.

Source:

(method) showLayers()

Method showLayers
Source:

(function) mounted()

Method mounted
Source:

(watcher) altSelectedCatalog()

Method altSelectedCatalog
Source:

(watcher) mapTilerOpacity()

Method mapTilerOpacity
Source:

(watcher) nutsLevel()

Method nutsLevel
Source:

(watcher) opacity()

Method opacity
Source:

(watcher) selectedBaseLayer()

Method selectedBaseLayer
Source:

(watcher) selectedCatalog()

Method selectedCatalog
Source:

(watcher) selectedDataSource()

Method selectedDataSource
Source:

(watcher) selectedIndicator()

Method selectedIndicator
Source:

(watcher) selectedSite()

Method selectedSite
Source:

(watcher) showEditableSource()

Method showEditableSource
Source:

(watcher) showPoints()

Method showPoints
Source:

(watcher) srid()

Method srid
Source:

(watcher) trackPosition()

Method trackPosition
Source:

(watcher) valueAtPixel()

Method valueAtPixel
Source:

(function) data()

Method data
Source:

(method) animateToExtent(source)

Animates the map view to the extent of a given source.

Parameters:
Name Type Description
source Source

The source to animate to.

Source:

(method) coordinates() → {Array.<number>}

Returns the coordinates of the map based on the client coordinates.

Source:
Returns:

The coordinates of the map.

Type
Array.<number>

(method) createLegend(color_map)

Creates a legend based on the provided color map.

Parameters:
Name Type Description
color_map string

The color map in JSON format.

Source:

(method) prepareFrequencyChart(points, numerical, decimalsForStats) → {Object}

Prepares a frequency chart based on the given points.

Parameters:
Name Type Description
points Array

The array of points.

numerical boolean

Indicates whether the points are numerical or not.

decimalsForStats number

The number of decimals to round the statistics to.

Source:
Returns:
  • The prepared frequency chart object.
Type
Object

(method) reprojectFeatures(features, oldProjection, newProjection)

Reprojects the given features from the old projection to the new projection.

Parameters:
Name Type Description
features Array.<ol.Feature>

The features to be reprojected.

oldProjection ol.proj.ProjectionLike

The old projection of the features.

newProjection ol.proj.ProjectionLike

The new projection to reproject the features to.

Source:

(method) rescale(value) → {number}

Rescales the given value based on the selected title's scale factor. If the scale factor is a number, the value is multiplied by the scale factor. If the scale factor is a formula, it is evaluated and applied to the value. If the formula fails to evaluate, the original value is returned.

Parameters:
Name Type Description
value number

The value to be rescaled.

Source:
Returns:

The rescaled value.

Type
number

(method) setSrid(val)

Sets the SRID (Spatial Reference System Identifier) for the map.

Parameters:
Name Type Description
val number

The SRID value to set.

Source:

(method) showFeatureStats(options) → {Promise.<void>}

Retrieves feature statistics based on the selected feature.

Parameters:
Name Type Description
options Object

The options for retrieving feature statistics.

Source:
Returns:
  • A promise that resolves when the feature statistics are retrieved.
Type
Promise.<void>

(method) showFrequencies(options) → {Promise.<void>}

Displays the frequencies of the selected indicator.

Parameters:
Name Type Description
options Object

The options for displaying the frequencies.

Source:
Returns:
  • A promise that resolves when the frequencies are displayed.
Type
Promise.<void>

(method) showHistory(options)

Show history of selected feature

Parameters:
Name Type Description
options *
Source:

(method) showProps(options)

Show properties of selected feature in a popup

Parameters:
Name Type Description
options *
Source:

(method) showSpectrum()

Method showSpectrum
Source:

(method) updateColorMap()

Method updateColorMap
Source:

(async, function) showSpectrum() → {Promise.<void>}

Shows the spectrum for the selected feature.

Source:
Returns:
Type
Promise.<void>