diff --git a/latest/classes/AnimateUtil_AnimateUtil.default.html b/latest/classes/AnimateUtil_AnimateUtil.default.html index 462cfeadf..fa87992bd 100644 --- a/latest/classes/AnimateUtil_AnimateUtil.default.html +++ b/latest/classes/AnimateUtil_AnimateUtil.default.html @@ -1,7 +1,7 @@ default | @terrestris/ol-util

Class default

This class provides some static methods which might be helpful when working with digitize functions to animate features.

AnimateUtil

-

Constructors

constructor +

Constructors

constructor

Methods

moveFeature

Constructors

constructor

Methods

StaticmoveFeature

  • moveFeature(map, layer, featureToMove, duration, pixel, style?): Promise<Feature<Geometry>>

  • Moves / translates an OlFeature to the given pixel delta in the end with given duration in ms, using the given style.

    @@ -13,4 +13,4 @@
  • pixel: number

    Delta of pixels to move the feature.

  • Optionalstyle: Style

    The style to use when moving the feature.

Returns Promise<Feature<Geometry>>

Promise of the moved feature.

-

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/latest/classes/CapabilitiesUtil_CapabilitiesUtil.default.html b/latest/classes/CapabilitiesUtil_CapabilitiesUtil.default.html index 97afe3ba9..49c2fc35e 100644 --- a/latest/classes/CapabilitiesUtil_CapabilitiesUtil.default.html +++ b/latest/classes/CapabilitiesUtil_CapabilitiesUtil.default.html @@ -1,6 +1,6 @@ default | @terrestris/ol-util

Class default

Helper class to parse capabilities of WMS layers

CapabilitiesUtil

-

Constructors

constructor +

Constructors

constructor

Methods

getCapabilitiesUrl getLayersFromWmsCapabilities getWmsCapabilities @@ -8,7 +8,7 @@

Constructors

constructor

Methods

StaticgetCapabilitiesUrl

  • getCapabilitiesUrl(layer): string

  • Returns the Capabilities URL for the given layer.

    Parameters

    • layer: WmsLayer

      The layer to the get the Capabilities URL for.

    Returns string

    The Capabilities URL.

    -

StaticgetLayersFromWmsCapabilities

  • getLayersFromWmsCapabilities(capabilities, nameField?, proxyFn?): ImageLayer<ImageWMS>[]

  • Returns the layers from a parsed WMS GetCapabilities object.

    +

StaticgetLayersFromWmsCapabilities

  • getLayersFromWmsCapabilities(capabilities, nameField?, proxyFn?): ImageLayer<ImageWMS>[]

  • Returns the layers from a parsed WMS GetCapabilities object.

    Parameters

    • capabilities: any

      A capabilities object.

    • nameField: string = 'Name'

      Configure the field which should be set as the 'name' property in the openlayers layer.

      @@ -16,14 +16,14 @@ GetMap, GetFeatureInfo and GetLegendGraphic requests to avoid CORS issues.

        • (proxyUrl): string

        • Parameters

          • proxyUrl: string

          Returns string

    Returns ImageLayer<ImageWMS>[]

    Array of OlLayerImage

    -

StaticgetWmsCapabilities

StaticgetWmsCapabilities

  • getWmsCapabilities(capabilitiesUrl, fetchOpts?): Promise<any>

  • Fetches and parses the WMS Capabilities document for the given URL.

    Parameters

    • capabilitiesUrl: string

      Url to WMS capabilities document.

    • fetchOpts: RequestInit = {}

      Optional fetch options to make use of while requesting the Capabilities.

    Returns Promise<any>

    An object representing the WMS capabilities.

    -

StaticgetWmsCapabilitiesByLayer

StaticgetWmsCapabilitiesByLayer

  • getWmsCapabilitiesByLayer(layer, fetchOpts?): Promise<any>

  • Fetches and parses the WMS Capabilities document for the given layer.

    Parameters

    • layer: WmsLayer

      The layer to the get the Capabilites for.

    • fetchOpts: RequestInit = {}

      Optional fetch options to make use of while requesting the Capabilities.

    Returns Promise<any>

    An object representing the WMS capabilities.

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/latest/classes/FeatureUtil_FeatureUtil.default.html b/latest/classes/FeatureUtil_FeatureUtil.default.html index e9f7ca476..53aae3192 100644 --- a/latest/classes/FeatureUtil_FeatureUtil.default.html +++ b/latest/classes/FeatureUtil_FeatureUtil.default.html @@ -1,6 +1,6 @@ default | @terrestris/ol-util

Class default

Helper class for working with OpenLayers features.

FeatureUtil

-

Constructors

constructor +

Constructors

constructor

Methods

getFeatureTypeName getFeatureTypeNameFromGetFeatureInfoUrl mapFeaturesToGeometries @@ -11,16 +11,16 @@ name from.

Returns undefined | string

The (unqualified) name of the featureType or undefined if the name could not be picked.

-

StaticgetFeatureTypeNameFromGetFeatureInfoUrl

  • getFeatureTypeNameFromGetFeatureInfoUrl(url, qualified?): undefined | string

  • Extracts the featureType name from given GetFeatureInfo URL. +

StaticgetFeatureTypeNameFromGetFeatureInfoUrl

  • getFeatureTypeNameFromGetFeatureInfoUrl(url, qualified?): undefined | string

  • Extracts the featureType name from given GetFeatureInfo URL. This method is mostly useful for raster layers which features could have no ID set.

    Parameters

    • url: string

      GetFeatureInfo URL possibly containing featureType name.

    • qualified: boolean = true

      Whether the qualified featureType name should be returned or not. Default is true.

    Returns undefined | string

    Obtained featureType name as string.

    -

StaticmapFeaturesToGeometries

StaticmapFeaturesToGeometries

  • mapFeaturesToGeometries(features): Geometry[]

  • Maps an array of features to an array of geometries.

    Parameters

    • features: Feature<Geometry>[]

    Returns Geometry[]

    The geometries of the features

    -

StaticresolveAttributeTemplate

  • resolveAttributeTemplate(feature, template, noValueFoundText?, valueAdjust?, leaveAsUrl?): string

  • Resolves the given template string with the given feature attributes, e.g. +

StaticresolveAttributeTemplate

  • resolveAttributeTemplate(feature, template, noValueFoundText?, valueAdjust?, leaveAsUrl?): string

  • Resolves the given template string with the given feature attributes, e.g. the template "Size of area is {{AREA_SIZE}} km²" would be to resolved to "Size of area is 1909 km²" (assuming the feature's attribute AREA_SIZE really exists).

    @@ -37,4 +37,4 @@
      • (key, val): any

      • Parameters

        • key: string
        • val: any

        Returns any

  • leaveAsUrl: boolean = false

    If set to true, template won't be wrapped into -tag and will be returned as URL. Default is false.

Returns string

The resolved template string.

-

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/latest/classes/FileUtil_FileUtil.FileUtil.html b/latest/classes/FileUtil_FileUtil.FileUtil.html index 8e2fca547..2652b36d3 100644 --- a/latest/classes/FileUtil_FileUtil.FileUtil.html +++ b/latest/classes/FileUtil_FileUtil.FileUtil.html @@ -1,15 +1,15 @@ FileUtil | @terrestris/ol-util

Class FileUtil

Helper class for adding layers from various file formats.

-

Constructors

constructor +

Constructors

constructor

Methods

addGeojsonLayer addGeojsonLayerFromFile addShpLayerFromFile

Constructors

constructor

Methods

StaticaddGeojsonLayer

  • addGeojsonLayer(json, map): void

  • Adds a new vector layer from a geojson string.

    Parameters

    • json: string | FeatureCollection<Geometry, GeoJsonProperties> | FeatureCollection<Geometry, GeoJsonProperties>[]

      the geojson string or object

    • map: Map

      the map to add the layer to

      -

    Returns void

StaticaddGeojsonLayerFromFile

  • addGeojsonLayerFromFile(file, map): void

  • Adds a new vector layer from a geojson file.

    +

Returns void

StaticaddGeojsonLayerFromFile

  • addGeojsonLayerFromFile(file, map): void

  • Adds a new vector layer from a geojson file.

    Parameters

    • file: File

      the file to read the geojson from

    • map: Map

      the map to add the layer to

      -

    Returns void

StaticaddShpLayerFromFile

  • addShpLayerFromFile(file, map): void

  • Adds a new vector layer from a shape file (zip).

    +

Returns void

StaticaddShpLayerFromFile

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/latest/classes/GeometryUtil_GeometryUtil.default.html b/latest/classes/GeometryUtil_GeometryUtil.default.html index 506c52102..a46de0f5f 100644 --- a/latest/classes/GeometryUtil_GeometryUtil.default.html +++ b/latest/classes/GeometryUtil_GeometryUtil.default.html @@ -1,7 +1,7 @@ default | @terrestris/ol-util

Class default

Helper class for the geospatial analysis. Makes use of Turf.js.

GeometryUtil

-

Constructors

constructor +

Constructors

constructor

Methods

addBuffer addGeometryBuffer difference @@ -22,48 +22,48 @@
  • projection: ProjectionLike = 'EPSG:3857'

    The projection of the input geometry as EPSG code. Default is to EPSG:3857.

    • Returns Geometry | Feature<Geometry>

    The geometry or feature with the added buffer.

    -

    StaticaddGeometryBuffer

    StaticaddGeometryBuffer

    • addGeometryBuffer(geometry, radius?, projection?): Geometry

    • Adds a buffer to a given geometry.

      Parameters

      • geometry: Geometry

        The geometry.

      • radius: number = 0

        The buffer to add in meters.

      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input geometry as EPSG code. Default is to EPSG:3857.

      Returns Geometry

      The geometry with the added buffer.

      -

    Staticdifference

    • difference(polygon1, polygon2, projection?): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

    • Finds the difference between two polygons by clipping the second polygon from the first.

      +

    Staticdifference

    • difference(polygon1, polygon2, projection?): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

    • Finds the difference between two polygons by clipping the second polygon from the first.

      If both polygons are of type ol.Feature it will return an ol.Feature. Else it will return an ol.geom.Geometry.

      Parameters

      • polygon1: Polygon | Feature<Polygon>
      • polygon2: Polygon | Feature<Polygon>
      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

      A Feature or geometry with the area of polygon1 excluding the area of polygon2.

      -

    StaticgeometryDifference

    • geometryDifference(polygon1, polygon2, projection?): Polygon | MultiPolygon

    • Finds the difference between two polygons by clipping the second polygon from the first.

      +

    StaticgeometryDifference

    • geometryDifference(polygon1, polygon2, projection?): Polygon | MultiPolygon

    • Finds the difference between two polygons by clipping the second polygon from the first.

      Parameters

      • polygon1: Polygon

        An ol.geom.Geometry

      • polygon2: Polygon

        An ol.geom.Geometry

      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns Polygon | MultiPolygon

      A with the area of polygon1 excluding the area of polygon2.

      -

    StaticgeometryIntersection

    • geometryIntersection(polygon1, polygon2, projection?): undefined | Polygon | MultiPolygon

    • Takes two polygons and finds their intersection.

      +

    StaticgeometryIntersection

    • geometryIntersection(polygon1, polygon2, projection?): undefined | Polygon | MultiPolygon

    • Takes two polygons and finds their intersection.

      Parameters

      • polygon1: Polygon | MultiPolygon

        An ol.geom.Geometry

      • polygon2: Polygon | MultiPolygon

        An ol.geom.Geometry

      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns undefined | Polygon | MultiPolygon

      A Geometry with the shared area of the two polygons or null if the polygons don't intersect.

      -

    Staticintersection

    • intersection(polygon1, polygon2, projection?):
          | undefined
          | Polygon
          | MultiPolygon
          | Feature<Polygon | MultiPolygon>

    • Takes two polygons and finds their intersection.

      +

    Staticintersection

    • intersection(polygon1, polygon2, projection?):
          | undefined
          | Polygon
          | MultiPolygon
          | Feature<Polygon | MultiPolygon>

    • Takes two polygons and finds their intersection.

      If both polygons are of type ol.Feature it will return an ol.Feature. Else it will return an ol.geom.Geometry.

      Parameters

      • polygon1: Polygon | Feature<Polygon | MultiPolygon>
      • polygon2: Polygon | Feature<Polygon | MultiPolygon>
      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns
          | undefined
          | Polygon
          | MultiPolygon
          | Feature<Polygon | MultiPolygon>

      A Feature or Geometry with the shared area of the two polygons or null if the polygons don't intersect.

      -

    StaticmergeGeometries

    StaticmergeGeometries

    • mergeGeometries<Geom>(geometries): MultiPolygon | MultiLineString | MultiPoint

    • Merges multiple geometries into one MultiGeometry.

      Type Parameters

      • Geom extends Geometry

      Parameters

      • geometries: Geom[]

        An array of ol.geom.geometries;

      Returns MultiPolygon | MultiLineString | MultiPoint

      A Multigeometry.

      -

    StaticseparateGeometries

    StaticseparateGeometries

    • separateGeometries(geometry): Geometry[]

    • Splits an array of geometries (and multi geometries) or a single MultiGeom into an array of single geometries.

      Parameters

      • geometry: Geometry | Geometry[]

        An (array of) ol.geom.geometries;

      Returns Geometry[]

      An array of geometries.

      -

    StaticsplitByLine

    • splitByLine(polygon, line, projection?): Polygon[] | Feature<Polygon>[]

    • Splits an OlFeature with/or ol.geom.Polygon by an OlFeature with/or ol.geom.LineString +

    StaticsplitByLine

    • splitByLine(polygon, line, projection?): Polygon[] | Feature<Polygon>[]

    • Splits an OlFeature with/or ol.geom.Polygon by an OlFeature with/or ol.geom.LineString into an array of instances of OlFeature with/or ol.geom.Polygon. If the target polygon (first param) is of type ol.Feature it will return an array with ol.Feature. If the target polygon (first param) is of type @@ -75,7 +75,7 @@ Default is to EPSG:3857.

    Returns Polygon[] | Feature<Polygon>[]

    An array of instances of OlFeature with/or ol.geom.Polygon

    -

    StaticsplitGeometryByLine

    StaticsplitGeometryByLine

    • splitGeometryByLine(polygon, line, projection?): Polygon[]

    • Splits an ol.geom.Polygon by an ol.geom.LineString into an array of instances of ol.geom.Polygon.

      Parameters

      • polygon: Polygon

        The polygon geometry to split.

      • line: LineString

        The line geometry to split the polygon @@ -83,16 +83,16 @@

      • projection: ProjectionLike = 'EPSG:3857'

        The EPSG code of the input features. Default is to EPSG:3857.

      Returns Polygon[]

      An array of instances of ol.geom.Polygon

      -

    Staticunion

    • union(inputPolygonalObjects, projection?): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

    • Takes two or more polygons and returns a combined (Multi-)polygon.

      +

    Staticunion

    • union(inputPolygonalObjects, projection?): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

    • Takes two or more polygons and returns a combined (Multi-)polygon.

      Parameters

      • inputPolygonalObjects: Polygon[] | Feature<Polygon | MultiPolygon>[]

        An array of ol.Feature or ol.geom.Geometry instances of type (Multi)-Polygon.

      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

      A Feature or Geometry with the combined area of the (Multi-)polygons.

      -

    StaticunionGeometries

    • unionGeometries(polygons, projection?): Polygon | MultiPolygon

    • Takes two or more polygons and returns a combined (Multi-)polygon.

      +

    StaticunionGeometries

    • unionGeometries(polygons, projection?): Polygon | MultiPolygon

    • Takes two or more polygons and returns a combined (Multi-)polygon.

      Parameters

      • polygons: Polygon[] | MultiPolygon[]

        An array of ol.geom.Geometry instances of type (Multi-)polygon.

      • projection: ProjectionLike = 'EPSG:3857'

        The projection of the input polygons as EPSG code. Default is to EPSG:3857.

      Returns Polygon | MultiPolygon

      A FGeometry with the combined area of the (Multi-)polygons.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/LayerUtil_LayerUtil.default.html b/latest/classes/LayerUtil_LayerUtil.default.html index 36985d2ed..361a5be76 100644 --- a/latest/classes/LayerUtil_LayerUtil.default.html +++ b/latest/classes/LayerUtil_LayerUtil.default.html @@ -1,6 +1,6 @@ default | @terrestris/ol-util

    Class default

    Helper class for layer interaction.

    LayerUtil

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    getExtentForLayer getLayerAttributionsText getLayerUrl @@ -10,15 +10,15 @@

    Parameters

    • layer: WmsLayer
    • fetchOpts: RequestInit = {}

      Optional fetch options to make use of while requesting the Capabilities.

    Returns Promise<Extent>

    The extent of the layer.

    -

    StaticgetLayerAttributionsText

    • getLayerAttributionsText(layer, separator?, removeDuplicates?): string

    • Returns all attributions as text joined by a separator.

      +

    StaticgetLayerAttributionsText

    • getLayerAttributionsText(layer, separator?, removeDuplicates?): string

    • Returns all attributions as text joined by a separator.

      Parameters

      • layer: Layer<Source, LayerRenderer<any>>

        The layer to get the attributions from.

      • separator: string = ', '

        The separator separating multiple attributions.

      • removeDuplicates: boolean = false

        Whether to remove duplicated attribution strings or not.

      Returns string

      The attributions.

      -

    StaticgetLayerUrl

    StaticgetLayerUrl

    StaticmapOlLayerToInkmap

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticmapOlLayerToInkmap

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/MapUtil_MapUtil.MapUtil.html b/latest/classes/MapUtil_MapUtil.MapUtil.html index 0df0f217e..b21848c49 100644 --- a/latest/classes/MapUtil_MapUtil.MapUtil.html +++ b/latest/classes/MapUtil_MapUtil.MapUtil.html @@ -1,5 +1,5 @@ MapUtil | @terrestris/ol-util

    Class MapUtil

    Helper class for the OpenLayers map.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    generatePrintConfig getAllLayers getInteractionsByName @@ -23,7 +23,7 @@ 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.

    -

    StaticgetAllLayers

    • getAllLayers(collection, filter?): BaseLayer[]

    • Returns all layers of a collection. Even the hidden ones.

      +

    StaticgetAllLayers

    • getAllLayers(collection, filter?): 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.

        @@ -31,44 +31,44 @@ If it returns true it will be included in the returned layers.

          • (olLayer): boolean

          • Parameters

            • olLayer: BaseLayer

            Returns boolean

      Returns BaseLayer[]

      An array of all Layers.

      -

    StaticgetInteractionsByName

    • getInteractionsByName(map, name): Interaction[]

    • Returns all interactions by the given name of a map.

      +

    StaticgetInteractionsByName

    • getInteractionsByName(map, name): 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.

      -

    StaticgetLayerByFeature

    • getLayerByFeature(map, feature, namespaces): undefined | BaseLayer

    • Returns the layer from the provided map by the given feature.

      +

    StaticgetLayerByFeature

    • getLayerByFeature(map, feature, namespaces): 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.

      -

    StaticgetLayerByName

    • getLayerByName(map, name): BaseLayer

    • Returns the layer from the provided map by the given name.

      +

    StaticgetLayerByName

    • getLayerByName(map, name): 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.

      -

    StaticgetLayerByNameParam

    StaticgetLayerByNameParam

    • getLayerByNameParam(map, name): 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.

      -

    StaticgetLayerByOlUid

    • getLayerByOlUid(map, olUid): undefined | BaseLayer

    • Get a layer by its key (ol_uid).

      +

    StaticgetLayerByOlUid

    • getLayerByOlUid(map, olUid): 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.

      -

    StaticgetLayerPositionInfo

    StaticgetLayerPositionInfo

    • getLayerPositionInfo(layer, groupLayerOrMap): 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.

      -

    StaticgetLayersByGroup

    • getLayersByGroup(map, layerGroup): BaseLayer[]

    • Returns all layers of the specified layer group recursively.

      +

    StaticgetLayersByGroup

    • getLayersByGroup(map, 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

      -

    StaticgetLayersByProperty

    • getLayersByProperty(map, key, value): BaseLayer[]

    • Returns the list of layers matching the given pair of properties.

      +

    StaticgetLayersByProperty

    • getLayersByProperty(map, key, value): 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.

      -

    StaticgetLegendGraphicUrl

    • getLegendGraphicUrl(layer, extraParams?): string

    • Get the getlegendGraphic url of a layer. Designed for geoserver. +

    StaticgetLegendGraphicUrl

    • getLegendGraphicUrl(layer, extraParams?): string

    • Get the getlegendGraphic url of a layer. Designed for geoserver. Currently supported Sources:

      • ol.source.TileWms (with url configured)
        • @@ -77,7 +77,7 @@

      Parameters

      • layer: WmsLayer | WmtsLayer

        The layer that you want to have a legendUrl for.

      • extraParams: {
            [key: string]: string | number;
        } = {}
        • [key: string]: string | number

      Returns string

      The getLegendGraphicUrl.

      -

    StaticgetResolutionForScale

    • getResolutionForScale(scale, units): undefined | number

    • Calculates the appropriate map resolution for a given scale in the given +

    StaticgetResolutionForScale

    • getResolutionForScale(scale, 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

      @@ -85,21 +85,21 @@ resolution for.

    • units: Units

      The units to use for calculation (m or degrees).

    Returns undefined | number

    The calculated resolution.

    -

    Method

    StaticgetScaleForResolution

    • getScaleForResolution(resolution, units): undefined | number

    • Returns the appropriate scale for the given resolution and units.

      +

      Method

    StaticgetScaleForResolution

    • getScaleForResolution(resolution, 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

    StaticgetZoomForScale

    • getZoomForScale(scale, resolutions, units?): number

    • Returns the appropriate zoom level for the given scale and units.

      +

      Method

    StaticgetZoomForScale

    • getZoomForScale(scale, resolutions, 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

    StaticisInScaleRange

    • isInScaleRange(layer, resolution): boolean

    • Checks if the given layer is visible for the given resolution.

      +

      Method

    StaticisInScaleRange

    • isInScaleRange(layer, resolution): 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

    StaticlayerInResolutionRange

    • layerInResolutionRange(layer?, map?): boolean

    • Checks whether the resolution of the passed map's view lies inside of the +

    Returns boolean

    StaticlayerInResolutionRange

    • layerInResolutionRange(layer?, 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.

        @@ -110,14 +110,14 @@ 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).

        -

    StaticroundScale

    StaticroundScale

    • roundScale(scale): number

    • Rounds a scale number depending on its size.

      Parameters

      • scale: number

        The exact scale

      Returns number

      The roundedScale

      -

    StaticsetVisibilityForLayers

    • setVisibilityForLayers(olMap, layerNames, visible): void

    • Set visibility for layer having names (if in map)

      +

    StaticsetVisibilityForLayers

    • setVisibilityForLayers(olMap, layerNames, visible): 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

    StaticzoomToFeatures

    • zoomToFeatures(map, features): void

    • Fits the map's view to the extent of the passed features.

      +

    Returns void

    StaticzoomToFeatures

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/MeasureUtil_MeasureUtil.default.html b/latest/classes/MeasureUtil_MeasureUtil.default.html index 4579f2d0a..744a4391c 100644 --- a/latest/classes/MeasureUtil_MeasureUtil.default.html +++ b/latest/classes/MeasureUtil_MeasureUtil.default.html @@ -1,7 +1,7 @@ default | @terrestris/ol-util

    Class default

    This class provides some static methods which might be helpful when working with measurements.

    MeasureUtil

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    angle angle360 formatAngle @@ -21,7 +21,7 @@
  • end: number[]

    The end coordinates of the line with the x-coordinate being at index 0 and y-coordinate being at index 1.

    • Returns number

    the angle in degrees, ranging from -180° to 180°.

    -

    Staticangle360

    Staticangle360

    • angle360(start, end): number

    • Determine the angle between two coordinates. The angle will be between 0° and 360°, with 0° being in the east. The angle will increase counter-clockwise.

      Inspired by https://stackoverflow.com/a/31136507

      @@ -30,7 +30,7 @@
    • end: number[]

      The end coordinates of the line with the x-coordinate being at index 0 and y-coordinate being at index 1.

    Returns number

    the angle in degrees, ranging from 0° and 360°.

    -

    StaticformatAngle

    • formatAngle(line, decimalPlacesInToolTips?): string

    • Returns the angle of the passed linestring in degrees, with 'N' being the +

    StaticformatAngle

    • formatAngle(line, decimalPlacesInToolTips?): string

    • Returns the angle of the passed linestring in degrees, with 'N' being the 0°-line and the angle increases in clockwise direction.

      Parameters

      • line: LineString

        The linestring to get the angle from. As this line is coming from our internal draw @@ -38,32 +38,32 @@

      • decimalPlacesInToolTips: number = 2

        How many decimal places will be allowed for the measure tooltips.

      Returns string

      The formatted angle of the line.

      -

    StaticformatArea

    StaticformatArea

    • formatArea(geom, map, decimalPlacesInToolTips, geodesic?): string

    • Format area output for the tooltip.

      Parameters

      • geom: Polygon | Circle

        The drawn geometry (circle or polygon).

      • map: Map

        An OlMap.

      • decimalPlacesInToolTips: number

        How many decimal places will be allowed for the measure tooltips.

      • geodesic: boolean = true

        Is the measurement geodesic.

      Returns string

      The formatted area of the polygon.

      -

    StaticformatLength

    StaticformatLength

    • formatLength(line, map, decimalPlacesInToolTips, geodesic?): string

    • Format length output for the tooltip.

      Parameters

      • line: LineString

        The drawn line.

      • map: Map

        An OlMap.

      • decimalPlacesInToolTips: number

        How many decimal places will be allowed for the measure tooltips

      • geodesic: boolean = true

        Is the measurement geodesic (default is true).

      Returns string

      The formatted length of the line (units: km, m or mm).

      -

    StaticgetArea

    StaticgetArea

    • getArea(polygon, map, geodesic?, radius?): number

    • Get the area of an OlGeomPolygon.

      Parameters

      • polygon: Polygon

        The drawn polygon.

      • map: Map

        An OlMap.

      • geodesic: boolean = true

        Is the measurement geodesic (default is true).

      • radius: number = 6371008.8

        Sphere radius. By default, the radius of the earth is used (Clarke 1866 Authalic Sphere, 6371008.8).

      Returns number

      The area of the polygon in square meter.

      -

    StaticgetAreaOfCircle

    StaticgetAreaOfCircle

    • getAreaOfCircle(circleGeom, map): number

    • Get the estimated area of an OlGeomCircle.

      Parameters

      • circleGeom: Circle

        The drawn circle.

      • map: Map

        An OlMap.

      Returns number

      The area of the circle in square meter.

      -

    StaticgetLength

    StaticgetLength

    • getLength(line, map, geodesic?, radius?, decimalPrecision?): number

    • Get the length of a OlGeomLineString.

      Parameters

      • line: LineString

        The drawn line.

      • map: Map

        An OlMap.

      • geodesic: boolean = true

        Is the measurement geodesic (default is true).

        @@ -72,14 +72,14 @@
      • decimalPrecision: number = 6

        Set the decimal precision on length value for non-geodesic map (default value 6)

      Returns number

      The length of line in meters.

      -

    StaticmakeClockwise

    • makeClockwise(angle360): number

    • Given an angle between 0° and 360° this angle returns the exact opposite +

    StaticmakeClockwise

    • makeClockwise(angle360): number

    • Given an angle between 0° and 360° this angle returns the exact opposite of the angle, e.g. for 90° you'll get back 270°. This effectively turns the direction of the angle from counter-clockwise to clockwise.

      Parameters

      • angle360: number

        The input angle obtained counter-clockwise.

      Returns number

      The clockwise angle.

      -

    StaticmakeZeroDegreesAtNorth

    • makeZeroDegreesAtNorth(angle360): number

    • This methods adds an offset of 90° to an counter-clockwise increasing +

    StaticmakeZeroDegreesAtNorth

    • makeZeroDegreesAtNorth(angle360): number

    • This methods adds an offset of 90° to an counter-clockwise increasing angle of a line so that the origin (0°) lies at the top (in the north).

      Parameters

      • angle360: number

        The input angle obtained counter-clockwise, with 0° degrees being in the east.

      Returns number

      The adjusted angle, with 0° being in the north.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/PermalinkUtil_PermalinkUtil.PermalinkUtil.html b/latest/classes/PermalinkUtil_PermalinkUtil.PermalinkUtil.html index f3dd77f18..d9d19447a 100644 --- a/latest/classes/PermalinkUtil_PermalinkUtil.PermalinkUtil.html +++ b/latest/classes/PermalinkUtil_PermalinkUtil.PermalinkUtil.html @@ -1,5 +1,5 @@ PermalinkUtil | @terrestris/ol-util

    Class PermalinkUtil

    Helper class for some operations related to permalink function.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    applyLink getLink setParentsVisible @@ -15,7 +15,7 @@ handled by the link. Default is to consider all current map layers of type ol/layer/Tile.

      • (layer): layer is TileLayer<any> | ImageLayer<any>

      • Parameters

        • layer: BaseLayer

        Returns layer is TileLayer<any> | ImageLayer<any>

    Returns null | string

    The customLayerAttributes, if defined. Otherwise null.

    -

    StaticgetLink

    • getLink(map, separator?, identifier?, filter?, customAttributes?): string

    • Creates a permalink based on the given map state. It will contain +

    StaticgetLink

    • getLink(map, separator?, identifier?, filter?, customAttributes?): string

    • Creates a permalink based on the given map state. It will contain the current view state of the map (center and zoom) as well as the current (filtered) list of layers.

      Parameters

      • map: Map

        The OpenLayers map

        @@ -30,9 +30,9 @@ visible layers of type ol/layer/Tile.

          • (l): boolean

          • Parameters

            • l: BaseLayer

            Returns boolean

      • customAttributes: string[] = []

        Custom layer attributes which will be saved in the permalink for each layer.

      Returns string

      The permalink.

      -

    StaticsetParentsVisible

    StaticsetParentsVisible

    • setParentsVisible(map, coll, id): void

    • Search through the given Ol-Collection for the given id and set all parenting groups visible.

      Parameters

      • map: Map

        The openlayers map

      • coll: Collection<BaseLayer>

        The Openlayers Collection

      • id: string

        Ther layer ol uid to search for

        -

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/ProjectionUtil_ProjectionUtil.ProjectionUtil.html b/latest/classes/ProjectionUtil_ProjectionUtil.ProjectionUtil.html index 96d15481c..a7973e990 100644 --- a/latest/classes/ProjectionUtil_ProjectionUtil.ProjectionUtil.html +++ b/latest/classes/ProjectionUtil_ProjectionUtil.ProjectionUtil.html @@ -1,7 +1,7 @@ ProjectionUtil | @terrestris/ol-util

    Class ProjectionUtil

    Helper class for projection handling. Makes use of Proj4js.

    ProjectionUtil

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    initProj4DefinitionMappings initProj4Definitions toDmm @@ -17,7 +17,7 @@ above).

  • useDefaultMappings: boolean = true

    Whether the default CRS should be mapped as well or not. Default is true.

    -

    • Returns void

    StaticinitProj4Definitions

    • initProj4Definitions(customCrsDefs?, registerDefaults?): void

    • Registers custom CRS definitions to the application.

      +

    Returns void

    StaticinitProj4Definitions

    • initProj4Definitions(customCrsDefs?, registerDefaults?): void

    • Registers custom CRS definitions to the application.

      Parameters

      • OptionalcustomCrsDefs: CrsDefinition | CrsDefinition[]

        The custom proj4 definitions which should be registered additionally to default available CRS (s. defaultProj4CrsDefinitions above) as well. @@ -25,18 +25,18 @@ http://epsg.io (e.g. http://epsg.io/3426.proj4).

      • registerDefaults: boolean = true

        Whether the default CRS should be registered or not. Default is true.

        -

      Returns void

    StatictoDmm

    • toDmm(value): string

    • Converts geographic coordinates given in DDD format like DD.DDDD° to +

    Returns void

    StatictoDmm

    StatictoDms

    StatictoDms

    Staticzerofill

    Staticzerofill

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/classes/WfsFilterUtil_WfsFilterUtil.default.html b/latest/classes/WfsFilterUtil_WfsFilterUtil.default.html index 79098a09f..0e8f8bdc1 100644 --- a/latest/classes/WfsFilterUtil_WfsFilterUtil.default.html +++ b/latest/classes/WfsFilterUtil_WfsFilterUtil.default.html @@ -1,9 +1,9 @@ default | @terrestris/ol-util

    Class default

    Helper class for building filters to be used with WFS GetFeature requests.

    WfsFilterUtil

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    getCombinedRequests

    Constructors

    constructor

    Methods

    StaticgetCombinedRequests

    • getCombinedRequests(searchConfig, searchTerm): undefined | Element

    • Creates GetFeature request body for all provided featureTypes and applies related filter encoding on it.

      Parameters

      • searchConfig: SearchConfig

        The search config

      • searchTerm: string

        Search string to be used with filter.

        -

      Returns undefined | Element

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Returns undefined | Element

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/latest/functions/typeUtils_typeUtils.isWfsLayer.html b/latest/functions/typeUtils_typeUtils.isWfsLayer.html index 06ded0e66..764b86c66 100644 --- a/latest/functions/typeUtils_typeUtils.isWfsLayer.html +++ b/latest/functions/typeUtils_typeUtils.isWfsLayer.html @@ -1 +1 @@ -isWfsLayer | @terrestris/ol-util

    Function isWfsLayer

    Settings

    Member Visibility
    +isWfsLayer | @terrestris/ol-util

    Function isWfsLayer

    Settings

    Member Visibility
    diff --git a/latest/functions/typeUtils_typeUtils.isWmsLayer.html b/latest/functions/typeUtils_typeUtils.isWmsLayer.html index 56dc52386..c756afebc 100644 --- a/latest/functions/typeUtils_typeUtils.isWmsLayer.html +++ b/latest/functions/typeUtils_typeUtils.isWmsLayer.html @@ -1 +1 @@ -isWmsLayer | @terrestris/ol-util

    Function isWmsLayer

    Settings

    Member Visibility
    +isWmsLayer | @terrestris/ol-util

    Function isWmsLayer

    Settings

    Member Visibility
    diff --git a/latest/functions/typeUtils_typeUtils.isWmtsLayer.html b/latest/functions/typeUtils_typeUtils.isWmtsLayer.html index 40cffbeeb..2215ee754 100644 --- a/latest/functions/typeUtils_typeUtils.isWmtsLayer.html +++ b/latest/functions/typeUtils_typeUtils.isWmtsLayer.html @@ -1 +1 @@ -isWmtsLayer | @terrestris/ol-util

    Function isWmtsLayer

    Settings

    Member Visibility
    +isWmtsLayer | @terrestris/ol-util

    Function isWmtsLayer

    Settings

    Member Visibility
    diff --git a/latest/modules/AnimateUtil_AnimateUtil.html b/latest/modules/AnimateUtil_AnimateUtil.html index 14fede7ee..a45e98541 100644 --- a/latest/modules/AnimateUtil_AnimateUtil.html +++ b/latest/modules/AnimateUtil_AnimateUtil.html @@ -1,2 +1,2 @@ -AnimateUtil/AnimateUtil | @terrestris/ol-util

    Module AnimateUtil/AnimateUtil

    Index

    Classes

    default +AnimateUtil/AnimateUtil | @terrestris/ol-util

    Module AnimateUtil/AnimateUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/CapabilitiesUtil_CapabilitiesUtil.html b/latest/modules/CapabilitiesUtil_CapabilitiesUtil.html index 6104ef339..60399d3e8 100644 --- a/latest/modules/CapabilitiesUtil_CapabilitiesUtil.html +++ b/latest/modules/CapabilitiesUtil_CapabilitiesUtil.html @@ -1,2 +1,2 @@ -CapabilitiesUtil/CapabilitiesUtil | @terrestris/ol-util

    Module CapabilitiesUtil/CapabilitiesUtil

    Index

    Classes

    default +CapabilitiesUtil/CapabilitiesUtil | @terrestris/ol-util

    Module CapabilitiesUtil/CapabilitiesUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/FeatureUtil_FeatureUtil.html b/latest/modules/FeatureUtil_FeatureUtil.html index c60975c0e..9bfaf2c01 100644 --- a/latest/modules/FeatureUtil_FeatureUtil.html +++ b/latest/modules/FeatureUtil_FeatureUtil.html @@ -1,2 +1,2 @@ -FeatureUtil/FeatureUtil | @terrestris/ol-util

    Module FeatureUtil/FeatureUtil

    Index

    Classes

    default +FeatureUtil/FeatureUtil | @terrestris/ol-util

    Module FeatureUtil/FeatureUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/FileUtil_FileUtil.html b/latest/modules/FileUtil_FileUtil.html index 059415975..fb17024b2 100644 --- a/latest/modules/FileUtil_FileUtil.html +++ b/latest/modules/FileUtil_FileUtil.html @@ -1,3 +1,3 @@ -FileUtil/FileUtil | @terrestris/ol-util

    Module FileUtil/FileUtil

    References

    default +FileUtil/FileUtil | @terrestris/ol-util

    Module FileUtil/FileUtil

    References

    default

    Classes

    FileUtil

    References

    default

    Renames and re-exports FileUtil

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/latest/modules/GeometryUtil_GeometryUtil.html b/latest/modules/GeometryUtil_GeometryUtil.html index 90e4429c8..20567078c 100644 --- a/latest/modules/GeometryUtil_GeometryUtil.html +++ b/latest/modules/GeometryUtil_GeometryUtil.html @@ -1,2 +1,2 @@ -GeometryUtil/GeometryUtil | @terrestris/ol-util

    Module GeometryUtil/GeometryUtil

    Index

    Classes

    default +GeometryUtil/GeometryUtil | @terrestris/ol-util

    Module GeometryUtil/GeometryUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/LayerUtil_InkmapTypes.html b/latest/modules/LayerUtil_InkmapTypes.html index b5ca0d32d..ca09555fc 100644 --- a/latest/modules/LayerUtil_InkmapTypes.html +++ b/latest/modules/LayerUtil_InkmapTypes.html @@ -1,4 +1,4 @@ -LayerUtil/InkmapTypes | @terrestris/ol-util

    Module LayerUtil/InkmapTypes

    Index

    Type Aliases

    InkmapGeoJsonLayer +LayerUtil/InkmapTypes | @terrestris/ol-util

    Module LayerUtil/InkmapTypes

    Index

    Type Aliases

    InkmapGeoJsonLayer InkmapLayer InkmapOsmLayer InkmapPrintSpec diff --git a/latest/modules/LayerUtil_LayerUtil.html b/latest/modules/LayerUtil_LayerUtil.html index 7c8445515..3f6307281 100644 --- a/latest/modules/LayerUtil_LayerUtil.html +++ b/latest/modules/LayerUtil_LayerUtil.html @@ -1,2 +1,2 @@ -LayerUtil/LayerUtil | @terrestris/ol-util

    Module LayerUtil/LayerUtil

    Index

    Classes

    default +LayerUtil/LayerUtil | @terrestris/ol-util

    Module LayerUtil/LayerUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/MapUtil_MapUtil.html b/latest/modules/MapUtil_MapUtil.html index 31587ac93..10f8ab810 100644 --- a/latest/modules/MapUtil_MapUtil.html +++ b/latest/modules/MapUtil_MapUtil.html @@ -1,4 +1,4 @@ -MapUtil/MapUtil | @terrestris/ol-util

    Module MapUtil/MapUtil

    References

    default +MapUtil/MapUtil | @terrestris/ol-util

    Module MapUtil/MapUtil

    References

    default

    Classes

    MapUtil

    Type Aliases

    LayerPositionInfo

    References

    default

    Renames and re-exports MapUtil

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/latest/modules/MeasureUtil_MeasureUtil.html b/latest/modules/MeasureUtil_MeasureUtil.html index 2dd2c13f9..5a08bb095 100644 --- a/latest/modules/MeasureUtil_MeasureUtil.html +++ b/latest/modules/MeasureUtil_MeasureUtil.html @@ -1,2 +1,2 @@ -MeasureUtil/MeasureUtil | @terrestris/ol-util

    Module MeasureUtil/MeasureUtil

    Index

    Classes

    default +MeasureUtil/MeasureUtil | @terrestris/ol-util

    Module MeasureUtil/MeasureUtil

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/latest/modules/PermalinkUtil_PermalinkUtil.html b/latest/modules/PermalinkUtil_PermalinkUtil.html index ffb844283..17cf758b1 100644 --- a/latest/modules/PermalinkUtil_PermalinkUtil.html +++ b/latest/modules/PermalinkUtil_PermalinkUtil.html @@ -1,3 +1,3 @@ -PermalinkUtil/PermalinkUtil | @terrestris/ol-util

    Module PermalinkUtil/PermalinkUtil

    References

    default +PermalinkUtil/PermalinkUtil | @terrestris/ol-util

    Module PermalinkUtil/PermalinkUtil

    References

    default

    Classes

    PermalinkUtil

    References

    default

    Renames and re-exports PermalinkUtil

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/latest/modules/ProjectionUtil_ProjectionUtil.html b/latest/modules/ProjectionUtil_ProjectionUtil.html index 1b1df3d88..94e339387 100644 --- a/latest/modules/ProjectionUtil_ProjectionUtil.html +++ b/latest/modules/ProjectionUtil_ProjectionUtil.html @@ -1,4 +1,4 @@ -ProjectionUtil/ProjectionUtil | @terrestris/ol-util

    Module ProjectionUtil/ProjectionUtil

    References

    default +ProjectionUtil/ProjectionUtil | @terrestris/ol-util

    Module ProjectionUtil/ProjectionUtil

    References

    default

    Classes

    ProjectionUtil

    Type Aliases

    CrsDefinition CrsMapping diff --git a/latest/modules/WfsFilterUtil_WfsFilterUtil.html b/latest/modules/WfsFilterUtil_WfsFilterUtil.html index b01f35917..0427dbb16 100644 --- a/latest/modules/WfsFilterUtil_WfsFilterUtil.html +++ b/latest/modules/WfsFilterUtil_WfsFilterUtil.html @@ -1,4 +1,4 @@ -WfsFilterUtil/WfsFilterUtil | @terrestris/ol-util

    Module WfsFilterUtil/WfsFilterUtil

    Index

    Classes

    default +WfsFilterUtil/WfsFilterUtil | @terrestris/ol-util

    Module WfsFilterUtil/WfsFilterUtil

    Index

    Classes

    default

    Type Aliases

    AttributeDetails AttributeSearchSettings SearchConfig diff --git a/latest/modules/typeUtils_typeUtils.html b/latest/modules/typeUtils_typeUtils.html index 9959b90b6..a3012410b 100644 --- a/latest/modules/typeUtils_typeUtils.html +++ b/latest/modules/typeUtils_typeUtils.html @@ -1,4 +1,4 @@ -typeUtils/typeUtils | @terrestris/ol-util

    Module typeUtils/typeUtils

    Index

    Type Aliases

    WfsLayer +typeUtils/typeUtils | @terrestris/ol-util

    Module typeUtils/typeUtils

    Index

    Type Aliases

    WfsLayer WmsLayer WmtsLayer

    Functions

    isWfsLayer diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapGeoJsonLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapGeoJsonLayer.html index 328b0d172..f575bc4a1 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapGeoJsonLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapGeoJsonLayer.html @@ -1 +1 @@ -InkmapGeoJsonLayer | @terrestris/ol-util

    Type Alias InkmapGeoJsonLayer

    InkmapGeoJsonLayer: {
        attribution?: string;
        geojson: any;
        layerName?: string;
        legendUrl?: string;
        style: any;
        type: "GeoJSON";
    }

    Settings

    Member Visibility
    +InkmapGeoJsonLayer | @terrestris/ol-util

    Type Alias InkmapGeoJsonLayer

    InkmapGeoJsonLayer: {
        attribution?: string;
        geojson: any;
        layerName?: string;
        legendUrl?: string;
        style: any;
        type: "GeoJSON";
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapLayer.html index 70a29c0f3..e234a702f 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapLayer.html @@ -1 +1 @@ -InkmapLayer | @terrestris/ol-util

    Type Alias InkmapLayer

    InkmapLayer:
        | InkmapWmsLayer
        | InkmapWmtsLayer
        | InkmapGeoJsonLayer
        | InkmapWfsLayer
        | InkmapOsmLayer

    Settings

    Member Visibility
    +InkmapLayer | @terrestris/ol-util

    Type Alias InkmapLayer

    InkmapLayer:
        | InkmapWmsLayer
        | InkmapWmtsLayer
        | InkmapGeoJsonLayer
        | InkmapWfsLayer
        | InkmapOsmLayer

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapOsmLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapOsmLayer.html index 0f28cf7db..a97dbeff3 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapOsmLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapOsmLayer.html @@ -1 +1 @@ -InkmapOsmLayer | @terrestris/ol-util

    Type Alias InkmapOsmLayer

    InkmapOsmLayer: {
        attribution?: string;
        format?: string;
        geojson?: any;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        matrixSet?: string;
        opacity?: number;
        projection?: string;
        requestEncoding?: string;
        style?: any;
        tiled?: boolean;
        tileGrid?: any;
        type: "XYZ";
        url: string;
    }

    Settings

    Member Visibility
    +InkmapOsmLayer | @terrestris/ol-util

    Type Alias InkmapOsmLayer

    InkmapOsmLayer: {
        attribution?: string;
        format?: string;
        geojson?: any;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        matrixSet?: string;
        opacity?: number;
        projection?: string;
        requestEncoding?: string;
        style?: any;
        tiled?: boolean;
        tileGrid?: any;
        type: "XYZ";
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapPrintSpec.html b/latest/types/LayerUtil_InkmapTypes.InkmapPrintSpec.html index ee21f91ea..aac5bebb6 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapPrintSpec.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapPrintSpec.html @@ -1 +1 @@ -InkmapPrintSpec | @terrestris/ol-util

    Type Alias InkmapPrintSpec

    InkmapPrintSpec: {
        attributions:
            | boolean
            | "top-left"
            | "bottom-left"
            | "bottom-right"
            | "top-right";
        center: [number, number];
        dpi: number;
        layers: InkmapLayer[];
        northArrow: boolean | string;
        projection: string;
        projectionDefinitions?: InkmapProjectionDefinition[];
        scale: number;
        scaleBar: boolean | ScaleBarSpec;
        size: [number, number] | [number, number, string];
    }

    Settings

    Member Visibility
    +InkmapPrintSpec | @terrestris/ol-util

    Type Alias InkmapPrintSpec

    InkmapPrintSpec: {
        attributions:
            | boolean
            | "top-left"
            | "bottom-left"
            | "bottom-right"
            | "top-right";
        center: [number, number];
        dpi: number;
        layers: InkmapLayer[];
        northArrow: boolean | string;
        projection: string;
        projectionDefinitions?: InkmapProjectionDefinition[];
        scale: number;
        scaleBar: boolean | ScaleBarSpec;
        size: [number, number] | [number, number, string];
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapProjectionDefinition.html b/latest/types/LayerUtil_InkmapTypes.InkmapProjectionDefinition.html index 7603b118f..ded7d7f1d 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapProjectionDefinition.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapProjectionDefinition.html @@ -1 +1 @@ -InkmapProjectionDefinition | @terrestris/ol-util

    Type Alias InkmapProjectionDefinition

    InkmapProjectionDefinition: {
        bbox: [number, number, number, number];
        name: string;
        proj4: string;
    }

    Settings

    Member Visibility
    +InkmapProjectionDefinition | @terrestris/ol-util

    Type Alias InkmapProjectionDefinition

    InkmapProjectionDefinition: {
        bbox: [number, number, number, number];
        name: string;
        proj4: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapWfsLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapWfsLayer.html index 3822279dc..c3bf84a1e 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapWfsLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapWfsLayer.html @@ -1 +1 @@ -InkmapWfsLayer | @terrestris/ol-util

    Type Alias InkmapWfsLayer

    InkmapWfsLayer: {
        attribution?: string;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        projection?: string;
        type: "WFS";
        url: string;
    }

    Settings

    Member Visibility
    +InkmapWfsLayer | @terrestris/ol-util

    Type Alias InkmapWfsLayer

    InkmapWfsLayer: {
        attribution?: string;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        projection?: string;
        type: "WFS";
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapWmsLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapWmsLayer.html index a5ce08795..9a4cef5d2 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapWmsLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapWmsLayer.html @@ -1 +1 @@ -InkmapWmsLayer | @terrestris/ol-util

    Type Alias InkmapWmsLayer

    InkmapWmsLayer: {
        attribution?: string;
        customParams?: any;
        layer: string;
        layerName?: string;
        legendUrl?: string;
        opacity?: number;
        tiled?: boolean;
        type: "WMS";
        url: string;
    }

    Settings

    Member Visibility
    +InkmapWmsLayer | @terrestris/ol-util

    Type Alias InkmapWmsLayer

    InkmapWmsLayer: {
        attribution?: string;
        customParams?: any;
        layer: string;
        layerName?: string;
        legendUrl?: string;
        opacity?: number;
        tiled?: boolean;
        type: "WMS";
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.InkmapWmtsLayer.html b/latest/types/LayerUtil_InkmapTypes.InkmapWmtsLayer.html index 90059fa8d..ce8829747 100644 --- a/latest/types/LayerUtil_InkmapTypes.InkmapWmtsLayer.html +++ b/latest/types/LayerUtil_InkmapTypes.InkmapWmtsLayer.html @@ -1 +1 @@ -InkmapWmtsLayer | @terrestris/ol-util

    Type Alias InkmapWmtsLayer

    InkmapWmtsLayer: {
        attribution?: string;
        format?: string;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        matrixSet?: string;
        opacity?: number;
        projection?: string;
        requestEncoding?: string;
        tileGrid?: any;
        type: "WMTS";
        url: string;
    }

    Settings

    Member Visibility
    +InkmapWmtsLayer | @terrestris/ol-util

    Type Alias InkmapWmtsLayer

    InkmapWmtsLayer: {
        attribution?: string;
        format?: string;
        layer?: string;
        layerName?: string;
        legendUrl?: string;
        matrixSet?: string;
        opacity?: number;
        projection?: string;
        requestEncoding?: string;
        tileGrid?: any;
        type: "WMTS";
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/LayerUtil_InkmapTypes.ScaleBarSpec.html b/latest/types/LayerUtil_InkmapTypes.ScaleBarSpec.html index fe020d019..f74cfafab 100644 --- a/latest/types/LayerUtil_InkmapTypes.ScaleBarSpec.html +++ b/latest/types/LayerUtil_InkmapTypes.ScaleBarSpec.html @@ -1 +1 @@ -ScaleBarSpec | @terrestris/ol-util

    Type Alias ScaleBarSpec

    ScaleBarSpec: {
        position: "bottom-left" | "bottom-right";
        units: string;
    }

    Settings

    Member Visibility
    +ScaleBarSpec | @terrestris/ol-util

    Type Alias ScaleBarSpec

    ScaleBarSpec: {
        position: "bottom-left" | "bottom-right";
        units: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/MapUtil_MapUtil.LayerPositionInfo.html b/latest/types/MapUtil_MapUtil.LayerPositionInfo.html index a90faeb98..ec2b13b87 100644 --- a/latest/types/MapUtil_MapUtil.LayerPositionInfo.html +++ b/latest/types/MapUtil_MapUtil.LayerPositionInfo.html @@ -1 +1 @@ -LayerPositionInfo | @terrestris/ol-util

    Type Alias LayerPositionInfo

    LayerPositionInfo: {
        groupLayer?: OlLayerGroup;
        position?: number;
    }

    Settings

    Member Visibility
    +LayerPositionInfo | @terrestris/ol-util

    Type Alias LayerPositionInfo

    LayerPositionInfo: {
        groupLayer?: OlLayerGroup;
        position?: number;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/ProjectionUtil_ProjectionUtil.CrsDefinition.html b/latest/types/ProjectionUtil_ProjectionUtil.CrsDefinition.html index cd41fefe7..6a047c5e6 100644 --- a/latest/types/ProjectionUtil_ProjectionUtil.CrsDefinition.html +++ b/latest/types/ProjectionUtil_ProjectionUtil.CrsDefinition.html @@ -1 +1 @@ -CrsDefinition | @terrestris/ol-util

    Type Alias CrsDefinition

    CrsDefinition: {
        crsCode: string;
        definition: string | ProjectionDefinition;
    }

    Settings

    Member Visibility
    +CrsDefinition | @terrestris/ol-util

    Type Alias CrsDefinition

    CrsDefinition: {
        crsCode: string;
        definition: string | ProjectionDefinition;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/ProjectionUtil_ProjectionUtil.CrsMapping.html b/latest/types/ProjectionUtil_ProjectionUtil.CrsMapping.html index cad7da596..bb535c5fa 100644 --- a/latest/types/ProjectionUtil_ProjectionUtil.CrsMapping.html +++ b/latest/types/ProjectionUtil_ProjectionUtil.CrsMapping.html @@ -1 +1 @@ -CrsMapping | @terrestris/ol-util

    Type Alias CrsMapping

    CrsMapping: {
        alias: string;
        mappedCode: string;
    }

    Settings

    Member Visibility
    +CrsMapping | @terrestris/ol-util

    Type Alias CrsMapping

    CrsMapping: {
        alias: string;
        mappedCode: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeDetails.html b/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeDetails.html index 83d044a30..37a4a4cf6 100644 --- a/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeDetails.html +++ b/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeDetails.html @@ -3,4 +3,4 @@ 
    attributeDetails: {
     featType1: {
       attr1: {
         matchCase: true,
         type: 'number',
         exactSearch: false
       },
       attr2: {
         matchCase: false,
         type: 'string',
         exactSearch: true
       }
     },
     featType2: {...}
    }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeSearchSettings.html b/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeSearchSettings.html index ff24b8899..348e2d7e8 100644 --- a/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeSearchSettings.html +++ b/latest/types/WfsFilterUtil_WfsFilterUtil.AttributeSearchSettings.html @@ -1 +1 @@ -AttributeSearchSettings | @terrestris/ol-util

    Type Alias AttributeSearchSettings

    AttributeSearchSettings: {
        exactSearch?: boolean;
        matchCase?: boolean;
        type: "number" | "int" | "string";
    }

    Settings

    Member Visibility
    +AttributeSearchSettings | @terrestris/ol-util

    Type Alias AttributeSearchSettings

    AttributeSearchSettings: {
        exactSearch?: boolean;
        matchCase?: boolean;
        type: "number" | "int" | "string";
    }

    Settings

    Member Visibility
    diff --git a/latest/types/WfsFilterUtil_WfsFilterUtil.SearchConfig.html b/latest/types/WfsFilterUtil_WfsFilterUtil.SearchConfig.html index 59388c1ab..1177fe03e 100644 --- a/latest/types/WfsFilterUtil_WfsFilterUtil.SearchConfig.html +++ b/latest/types/WfsFilterUtil_WfsFilterUtil.SearchConfig.html @@ -1 +1 @@ -SearchConfig | @terrestris/ol-util

    Type Alias SearchConfig

    SearchConfig: {
        attributeDetails: AttributeDetails;
        featureNS: string;
        featurePrefix: string;
        featureTypes?: string[];
        filter?: OlFilter;
        geometryName?: string;
        maxFeatures?: number;
        olFilterOnly?: boolean;
        outputFormat?: string;
        propertyNames?: string[];
        srsName?: string;
        wfsFormatOptions?: string;
    }

    Settings

    Member Visibility
    +SearchConfig | @terrestris/ol-util

    Type Alias SearchConfig

    SearchConfig: {
        attributeDetails: AttributeDetails;
        featureNS: string;
        featurePrefix: string;
        featureTypes?: string[];
        filter?: OlFilter;
        geometryName?: string;
        maxFeatures?: number;
        olFilterOnly?: boolean;
        outputFormat?: string;
        propertyNames?: string[];
        srsName?: string;
        wfsFormatOptions?: string;
    }

    Settings

    Member Visibility
    diff --git a/latest/types/typeUtils_typeUtils.WfsLayer.html b/latest/types/typeUtils_typeUtils.WfsLayer.html index ccd49fa8e..343943ebd 100644 --- a/latest/types/typeUtils_typeUtils.WfsLayer.html +++ b/latest/types/typeUtils_typeUtils.WfsLayer.html @@ -1 +1 @@ -WfsLayer | @terrestris/ol-util

    Type Alias WfsLayer

    WfsLayer: OlVectorLayer<OlFeatureLike>

    Settings

    Member Visibility
    +WfsLayer | @terrestris/ol-util

    Type Alias WfsLayer

    WfsLayer: OlVectorLayer<OlFeatureLike>

    Settings

    Member Visibility
    diff --git a/latest/types/typeUtils_typeUtils.WmsLayer.html b/latest/types/typeUtils_typeUtils.WmsLayer.html index ef525f0a6..77f75b6b4 100644 --- a/latest/types/typeUtils_typeUtils.WmsLayer.html +++ b/latest/types/typeUtils_typeUtils.WmsLayer.html @@ -1 +1 @@ -WmsLayer | @terrestris/ol-util

    Type Alias WmsLayer

    WmsLayer: OlImageLayer<OlImageWMS> | OlTileLayer<OlTileWMS> | OlLayer<OlImageWMS | OlTileWMS>

    Settings

    Member Visibility
    +WmsLayer | @terrestris/ol-util

    Type Alias WmsLayer

    WmsLayer: OlImageLayer<OlImageWMS> | OlTileLayer<OlTileWMS> | OlLayer<OlImageWMS | OlTileWMS>

    Settings

    Member Visibility
    diff --git a/latest/types/typeUtils_typeUtils.WmtsLayer.html b/latest/types/typeUtils_typeUtils.WmtsLayer.html index 3b13f3894..6cd95d575 100644 --- a/latest/types/typeUtils_typeUtils.WmtsLayer.html +++ b/latest/types/typeUtils_typeUtils.WmtsLayer.html @@ -1 +1 @@ -WmtsLayer | @terrestris/ol-util

    Type Alias WmtsLayer

    WmtsLayer: OlLayerTile<OlSourceWMTS>

    Settings

    Member Visibility
    +WmtsLayer | @terrestris/ol-util

    Type Alias WmtsLayer

    WmtsLayer: OlLayerTile<OlSourceWMTS>

    Settings

    Member Visibility
    diff --git a/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsDefinitions.html b/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsDefinitions.html index db408e3ea..092729fa6 100644 --- a/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsDefinitions.html +++ b/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsDefinitions.html @@ -1,2 +1,2 @@ defaultProj4CrsDefinitions | @terrestris/ol-util

    Variable defaultProj4CrsDefinitionsConst

    defaultProj4CrsDefinitions: CrsDefinition[] = ...

    Default proj4 CRS definitions.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsMappings.html b/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsMappings.html index 354cdea3e..f5369fde7 100644 --- a/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsMappings.html +++ b/latest/variables/ProjectionUtil_ProjectionUtil.defaultProj4CrsMappings.html @@ -1,2 +1,2 @@ defaultProj4CrsMappings | @terrestris/ol-util

    Variable defaultProj4CrsMappingsConst

    defaultProj4CrsMappings: CrsMapping[] = ...

    Default mappings for CRS identifiers (e.g. "urn:ogc:def:crs:EPSG::25832").

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility