Class MapUtil

Helper class for the OpenLayers map.

Constructors

constructor

new MapUtil(): MapUtil
Returns MapUtil

Methods

`Static`generatePrintConfig

generatePrintConfig(
    olMap: Map,
): Promise<
    {
        center: Coordinate;
        layers: any[];
        projection: string;
        scale: undefined
        | number;
    },
>
Converts a given OpenLayers map to an inkmap spec. Only returns options which can be derived from a map (center, scale, projection, layers).
Parameters
- olMap: Map
  The ol map.
Returns Promise<
    {
        center: Coordinate;
        layers: any[];
        projection: string;
        scale: undefined
        | number;
    },
>
Promise of the inmkap print spec.
- Defined in MapUtil/MapUtil.ts:421

`Static`getAllLayers

getAllLayers(
collection: Map | LayerGroup,
filter?: (olLayer: BaseLayer) => boolean,
): BaseLayer[]
Returns all layers of a collection. Even the hidden ones.
Parameters
- collection: Map | LayerGroup
  The collection to get the layers from. This can be an ol.layer.Group or an ol.Map.
- Optionalfilter: (olLayer: BaseLayer) => boolean = ...
  A filter function that receives the layer. If it returns true it will be included in the returned layers.
Returns BaseLayer[]
An array of all Layers.
- Defined in MapUtil/MapUtil.ts:116

`Static`getInteractionsByName

getInteractionsByName(map: Map, name: string): Interaction[]
Returns all interactions by the given name of a map.
Parameters
- map: Map
  The map to use for lookup.
- name: string
  The name of the interaction to look for.
Returns Interaction[]
The list of result interactions.
- Defined in MapUtil/MapUtil.ts:45

`Static`getLayerByFeature

getLayerByFeature(
    map: Map,
    feature: Feature<Geometry>,
    namespaces: string[],
): undefined | BaseLayer
Returns the layer from the provided map by the given feature.
Parameters
- map: Map
  The map to use for lookup.
- feature: Feature<Geometry>
  The feature to get the layer by.
- namespaces: string[]
  list of supported GeoServer namespaces.
Returns undefined | BaseLayer
The result layer or undefined if the layer could not be found.
- Defined in MapUtil/MapUtil.ts:184

`Static`getLayerByName

getLayerByName(map: Map, name: string): BaseLayer
Returns the layer from the provided map by the given name.
Parameters
- map: Map
  The map to use for lookup.
- name: string
  The name to get the layer by.
Returns BaseLayer
The result layer or undefined if the layer could not be found.
- Defined in MapUtil/MapUtil.ts:152

`Static`getLayerByNameParam

getLayerByNameParam(map: Map, name: string): undefined | WmsLayer
Returns the layer from the provided map by the given name (parameter LAYERS).
Parameters
- map: Map
  The map to use for lookup.
- name: string
  The name to get the layer by.
Returns undefined | WmsLayer
The result layer or undefined if the layer could not be found.
- Defined in MapUtil/MapUtil.ts:165

`Static`getLayerByOlUid

getLayerByOlUid(map: Map, olUid: string): undefined | BaseLayer
Get a layer by its key (ol_uid).
Parameters
- map: Map
  The map to use for lookup.
- olUid: string
Returns undefined | BaseLayer
The layer.
- Defined in MapUtil/MapUtil.ts:140

`Static`getLayerPositionInfo

getLayerPositionInfo(
layer: BaseLayer,
groupLayerOrMap: Map | LayerGroup,
): LayerPositionInfo
Get information about the LayerPosition in the tree.
Parameters
- layer: BaseLayer
  The layer to get the information.
- groupLayerOrMap: Map | LayerGroup
  The groupLayer or map containing the layer.
Returns LayerPositionInfo
The groupLayer containing the layer and the position of the layer in the collection.
- Defined in MapUtil/MapUtil.ts:240

`Static`getLayersByGroup

getLayersByGroup(map: Map, layerGroup: LayerGroup): BaseLayer[]
Returns all layers of the specified layer group recursively.
Parameters
- map: Map
  The map to use for lookup.
- layerGroup: LayerGroup
  The group to flatten.
Returns BaseLayer[]
The (flattened) layers from the group
- Defined in MapUtil/MapUtil.ts:205

`Static`getLayersByProperty

getLayersByProperty(map: Map, key: string, value: any): BaseLayer[]
Returns the list of layers matching the given pair of properties.
Parameters
- map: Map
  The map to use for lookup.
- key: string
  The property key.
- value: any
  The property value.
Returns BaseLayer[]
The array of matching layers.
- Defined in MapUtil/MapUtil.ts:225

`Static`getLegendGraphicUrl

getLegendGraphicUrl(
layer: WmsLayer | WmtsLayer,
extraParams?: Record<string, string | number>,
): string
Get the getlegendGraphic url of a layer. Designed for geoserver. Currently supported Sources:
- ol.source.TileWms (with url configured)
- ol.source.ImageWms (with url configured)
- ol.source.WMTS (with url configured)
Parameters
- layer: WmsLayer | WmtsLayer
  The layer that you want to have a legendUrl for.
- extraParams: Record<string, string | number> = {}
Returns string
The getLegendGraphicUrl.
- Defined in MapUtil/MapUtil.ts:271

`Static`getResolutionForScale

getResolutionForScale(scale: string | number, units: Units): undefined | number
Calculates the appropriate map resolution for a given scale in the given units.

See: https://gis.stackexchange.com/questions/158435/ how-to-get-current-scale-in-openlayers-3
Parameters
- scale: string | number
  The input scale to calculate the appropriate resolution for.
- units: Units
  The units to use for calculation (m or degrees).
Returns undefined | number
The calculated resolution.

Method
- Defined in MapUtil/MapUtil.ts:64

`Static`getScaleForResolution

getScaleForResolution(
resolution: string | number,
units: Units,
): undefined | number
Returns the appropriate scale for the given resolution and units.
Parameters
- resolution: string | number
  The resolutions to calculate the scale for.
- units: Units
  The units the resolution is based on, typically either 'm' or 'degrees'.
Returns undefined | number
The appropriate scale.

Method
- Defined in MapUtil/MapUtil.ts:89

`Static`getZoomForScale

getZoomForScale(scale: number, resolutions: number[], units?: Units): number
Returns the appropriate zoom level for the given scale and units.
Parameters
- scale: number
  Map scale to get the zoom for.
- resolutions: number[]
  Resolutions array.
- units: Units = 'm'
  The units the resolutions are based on, typically either 'm' or 'degrees'. Default is 'm'.
Returns number
Determined zoom level for the given scale.

Method
- Defined in MapUtil/MapUtil.ts:364

`Static`isInScaleRange

isInScaleRange(layer: BaseLayer, resolution: number): boolean
Checks if the given layer is visible for the given resolution.
Parameters
- layer: BaseLayer
  The layer.
- resolution: number
  The resolution of the map
Returns boolean
- Defined in MapUtil/MapUtil.ts:408

`Static`layerInResolutionRange

layerInResolutionRange(layer?: BaseLayer, map?: Map): boolean
Checks whether the resolution of the passed map's view lies inside of the min- and max-resolution of the passed layer, e.g. whether the layer should be displayed at the current map view resolution.
Parameters
- Optionallayer: BaseLayer
  The layer to check.
- Optionalmap: Map
  The map to get the view resolution for comparison from.
Returns boolean
Whether the resolution of the passed map's view lies inside of the min- and max-resolution of the passed layer, e.g. whether the layer should be displayed at the current map view resolution. Will be false when no layer or no map is passed or if the view of the map is falsy or does not have a resolution (yet).
- Defined in MapUtil/MapUtil.ts:318

`Static`roundScale

roundScale(scale: number): number
Rounds a scale number depending on its size.
Parameters
- scale: number
  The exact scale
Returns number
The roundedScale
- Defined in MapUtil/MapUtil.ts:339

`Static`setVisibilityForLayers

setVisibilityForLayers(olMap: Map, layerNames: string[], visible: boolean): void
Set visibility for layer having names (if in map)
Parameters
- olMap: Map
  The OpenLayers map.
- layerNames: string[]
  An array of layer names (feature type names can also be used)
- visible: boolean
  if layer should be visible or not
Returns void
- Defined in MapUtil/MapUtil.ts:462

`Static`zoomToFeatures

zoomToFeatures(map: Map, features: Feature<Geometry>[]): void
Fits the map's view to the extent of the passed features.
Parameters
- map: Map
  The map to get the view from.
- features: Feature<Geometry>[]
  The features to zoom to.
Returns void
- Defined in MapUtil/MapUtil.ts:393

Class MapUtil

Index

Constructors

Methods

Constructors

constructor

Returns MapUtil

Methods

StaticgeneratePrintConfig

Parameters

Returns Promise< { center: Coordinate; layers: any[]; projection: string; scale: undefined | number; },>

StaticgetAllLayers

Parameters

Returns BaseLayer[]

StaticgetInteractionsByName

Parameters

Returns Interaction[]

StaticgetLayerByFeature

Parameters

Returns undefined | BaseLayer

StaticgetLayerByName

Parameters

Returns BaseLayer

StaticgetLayerByNameParam

Parameters

Returns undefined | WmsLayer

StaticgetLayerByOlUid

Parameters

Returns undefined | BaseLayer

StaticgetLayerPositionInfo

Parameters

Returns LayerPositionInfo

StaticgetLayersByGroup

Parameters

Returns BaseLayer[]

StaticgetLayersByProperty

Parameters

Returns BaseLayer[]

StaticgetLegendGraphicUrl

Parameters

Returns string

StaticgetResolutionForScale

Parameters

Returns undefined | number

Method

StaticgetScaleForResolution

Parameters

Returns undefined | number

Method

StaticgetZoomForScale

Parameters

Returns number

Method

StaticisInScaleRange

Parameters

Returns boolean

StaticlayerInResolutionRange

Parameters

Returns boolean

StaticroundScale

Parameters

Returns number

StaticsetVisibilityForLayers

Parameters

Returns void

StaticzoomToFeatures

Parameters

Returns void

Settings

On This Page

`Static`generatePrintConfig

Returns Promise<
{
center: Coordinate;
layers: any[];
projection: string;
scale: undefined
| number;
},
>

`Static`getAllLayers

`Static`getInteractionsByName

`Static`getLayerByFeature

`Static`getLayerByName

`Static`getLayerByNameParam

`Static`getLayerByOlUid

`Static`getLayerPositionInfo

`Static`getLayersByGroup

`Static`getLayersByProperty

`Static`getLegendGraphicUrl

`Static`getResolutionForScale

`Static`getScaleForResolution

`Static`getZoomForScale

`Static`isInScaleRange

`Static`layerInResolutionRange

`Static`roundScale

`Static`setVisibilityForLayers

`Static`zoomToFeatures