Class LayerHelper

Hierarchy

  • LayerHelper

Properties

$http_ $q_ tilesPreloadingLimit_

Methods

copyProperties createBasicGroup createBasicVectorTilesLayer createBasicWMSLayer createBasicWMSLayerFromDataSource createWMTSLayerFromCapabilitites createWMTSLayerFromCapabilititesObj fixResolution_ getFlatLayers getFlatLayers_ getGroupFromMap getLayerByNodeName getQuerySourceIds getWMSLegendURL getWMTSLegendURL isLayerVisible refreshWMSLayer setZIndexToFirstLevelChildren updateWMSLayerState

Properties

$http_

$http_: IHttpService

$q_

$q_: IQService

tilesPreloadingLimit_

tilesPreloadingLimit_: number

The Tiles Preloading Limit value

Methods

copyProperties

  • Copy each properties from a layer onto an other layer, with the option to exclude specific ones.

    Parameters

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

      The layer from which to copy the properties.

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

      The layer onto which the properties are copied.

    • Optional opt_excludes: string[]

      A list of properties that should not be copied.

    Returns void

createBasicGroup

  • Create and return an ol.layer.Group. You can pass a collection of layers to directly add them in the returned group.

    Returns

    Layer group.

    Parameters

    • Optional opt_layers: Collection<BaseLayer>

      The layer to add to the returned Group.

    Returns LayerGroup

createBasicVectorTilesLayer

  • Returns

    Vector tile layer.

    Parameters

    • url: string

      URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead. of defining each one separately in the urls option.

    • style: string | Object

      a Mapbox Style object.

    • layername: string

      the name of the url as identified in the style.

    • projection: string

      The projection code.

    • tileGrid: TileGrid

      The tile grid to define the source with.

    • Optional opt_minResolution: number

      WMTS minimum resolution.

    • Optional opt_maxResolution: number

      WMTS maximum resolution.

    • Optional opt_opacity: number

      The opacity.

    Returns any

createBasicWMSLayer

  • Create and return a basic WMS layer with only a source URL and a comma separated layers names (see import('ol/source/ImageWMS').default).

    Returns

    WMS Layer.

    Parameters

    • sourceURL: string

      The source URL.

    • sourceLayersName: string

      A comma separated names string.

    • sourceFormat: string

      Image format, for example 'image/png'.

    • Optional opt_serverType: string

      Type of the server ("mapserver", "geoserver", "qgisserver", …).

    • Optional opt_time: string

      time parameter for layer queryable by time/period

    • Optional opt_params: Object

      WMS parameters.

    • Optional opt_crossOrigin: string

      crossOrigin.

    • Optional opt_customSourceOptions: unknown

      Some layer's source initial options.

    • Optional opt_customLayerOptions: unknown

      Some layer initial options.

    Returns ImageLayer<ImageSource>

createBasicWMSLayerFromDataSource

  • Create and return a basic WMS layer using an OGC data source.

    Returns

    WMS Layer.

    Parameters

    • dataSource: GmfDatasourceOGC

      OGC data source.

    • Optional opt_crossOrigin: string

      crossOrigin.

    Returns ImageLayer<ImageSource>

createWMTSLayerFromCapabilitites

  • Create and return a promise that provides a WMTS layer with source on success, no layer else. The WMTS layer source will be configured by the capabilities that are loaded from the given capabilitiesUrl. The style object described in the capabilities for this layer will be added as key 'capabilitiesStyles' as param of the new layer.

    Returns

    A Promise with a layer (with source) on success, no layer else.

    Parameters

    • capabilitiesURL: string

      The getCapabilities url.

    • layerName: string

      The name of the layer.

    • Optional opt_matrixSet: string

      Optional WMTS matrix set.

    • Optional opt_dimensions: Object

      WMTS dimensions.

    • Optional opt_customOptions: Object

      Some initial options.

    • Optional opt_minResolution: number

      WMTS minimum resolution.

    • Optional opt_maxResolution: number

      WMTS maximum resolution.

    • Optional opt_opacity: number

      The opacity.

    Returns IPromise<any>

createWMTSLayerFromCapabilititesObj

  • Create and return a WMTS layer using a formatted capabilities response and a capability layer.

    Returns

    WMTS layer

    Parameters

    • capabilities: Object

      The complete capabilities object of the service

    • layerCap: Object

      The layer capability object

    • Optional opt_dimensions: Object

      WMTS dimensions.

    Returns any

fixResolution_

  • fixResolution_(opt_maxResolution: number): number

  • Small hack to get perfect sync with the on resolution status and the zoom to resolution.

    Returns

    fixed maximum resolution.

    Parameters

    • opt_maxResolution: number

      resolution.

    Returns number

getFlatLayers

  • Get an array of all layers in a group. The group can contain multiple levels of others groups.

    Returns

    Layers.

    Parameters

    • layer: BaseLayer

      The base layer, mostly a group of layers.

    Returns Layer<Source, LayerRenderer<any>>[]

getFlatLayers_

  • getFlatLayers_(layer: BaseLayer, array: Layer<Source, LayerRenderer<any>>[], computedOpacity: number): Layer<Source, LayerRenderer<any>>[]

  • Get an array of all layers in a group. The group can contain multiple levels of others groups. When we flatten a group, we get the child layers. If opacity is defined on the group, this value is lost. Computed opacity is a custom 'back-up' value that contains the calculated value of all ancestors and the given layer.

    Returns

    Layers.

    Parameters

    • layer: BaseLayer

      The base layer, mostly a group of layers.

    • array: Layer<Source, LayerRenderer<any>>[]

      An array to add layers.

    • computedOpacity: number

      Opacity inherited from ancestor layer groups.

    Returns Layer<Source, LayerRenderer<any>>[]

getGroupFromMap

  • Retrieve (or create if it doesn't exist) and return a group of layer from the base array of layers of a map. The given name is used as unique identifier. If the group is created, it will be automatically added to the map.

    Returns

    The group corresponding to the given name.

    Parameters

    • map: Map

      A map.

    • groupName: string

      The name of the group.

    Returns LayerGroup

getLayerByNodeName

  • Get a layer that has the LAYER_NODE_NAME_KEY property equal to a given layer name from an array of layers. If one of the layers in the array is a group, then the layers contained in that group are searched as well.

    Returns

    Layer.

    Parameters

    • nodeName: string

      The node name of the layer we're looking for.

    • layers: BaseLayer[]

      Layers.

    Returns BaseLayer

getQuerySourceIds

  • Returns

    List of query source ids, a.k.a. the data source ids this layer is composed of.

    Parameters

    • layer: ImageLayer<ImageSource>

      The WMS layer.

    Returns number[]

getWMSLegendURL

  • Get the WMS legend URL for the given node.

    Returns

    The legend URL or undefined.

    Parameters

    • url: string

      The base url of the wms service.

    • layerName: string

      The name of a wms layer.

    • Optional opt_scale: number

      A scale.

    • Optional opt_legendRule: string

      rule parameters to add to the returned URL.

    • Optional opt_legendWidth: number

      the legend width.

    • Optional opt_legendHeight: number

      the legend height.

    • Optional opt_servertype: string

      the OpenLayers server type.

    • Optional opt_dpi: number

      the DPI.

    • Optional opt_bbox: number[]

      the bbox.

    • Optional opt_srs: string

      The projection code.

    • Optional opt_additionalQueryString: Object

      Additional query string parameters.

    Returns string

getWMTSLegendURL

  • Get the WMTS legend URL for the given layer.

    Returns

    The legend URL or undefined.

    Parameters

    • layer: any

      Tile layer as returned by the ngeo layerHelper service.

    Returns string

isLayerVisible

  • Returns if this layer is visible at the current resolution.

    Returns

    Is the layer currently visible?

    Parameters

    • layer: BaseLayer

      Layer.

    • map: Map

      Map.

    Returns boolean

refreshWMSLayer

  • Force a WMS layer to refresh using a random value.

    Parameters

    • layer: any

      Layer to refresh.

    Returns void

setZIndexToFirstLevelChildren

  • Set ZIndex property to first level children elements

    Parameters

    • element: BaseLayer | LayerGroup

      The group of layer with first level children layers.

    • ZIndex: number

      The ZIndex for children element.

    Returns void

updateWMSLayerState

  • Update the LAYERS parameter of the source of the given WMS layer.

    Parameters

    • layer: ImageLayer<ImageSource>

      The WMS layer.

    • names: string

      The names that will be used to set the LAYERS parameter.

    • Optional opt_time: string

      The start and optionally the end datetime (for time range selection) selected by user in a ISO-8601 string datetime or time interval format

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc