Geoportal Resources Access API Reference

Namespace: Layer

Gp.Services.Config.Layer

.Config.

Object used to describe geoportal resource (WMTS, WMS, WFS layers, geocoding resources or elevation service) parameters. Properties may be used or not depending on the resource type.

Properties:
Name Type Description
name String

name of the resource to use with the webservice that serves it (eg : "GEOGRAPHICALGRIDSYSTEMS.MAPS").

title String

Human readable name for the resource.

description String

Resource description.

layerId String

Unique resource Identifier (eg : "GEOGRAPHICALGRIDSYSTEMS.MAPS$GEOPORTAIL:OGC:WMTS")

quicklookUrl String

Image URL for the resource.

serviceParams Object

Informations about the webservice that serves the resource (OpenLS, WFS, WMTS)

Properties
Name Type Description
id String

Web Service identifier ("OGC:WMTS", "OGC:OPENLS;ReverseGeocode", etc...)

serverUrl Object

Associative array mapping geoportal access key (keys) with their properties (URLs of the web service, with the geoportal access key).

version String

webservice version.

defaultProjection String

coordinates system ID used by default for the resource (WMS or WFS layer) or of the TileMatrixSet used by the WMTS layer.

additionalProjections Array.<String>

additional coordinates systems IDs availables for the resource, others than the default one (see defaultProjection) (WMS and WFS layers only).

formats Array.<Gp.Services.Config.Format>

Formats availables for the resource.

legends Array.<Gp.Services.Config.Legend>

Informations about legends associated to the resource.

metadata Array.<Gp.Services.Config.Metadata>

Informations about metadata associated to the resource.

styles Array.<Gp.Services.Config.Style>

Informations about styles availables for the resources (WMS, WFS and WMTS only).

thematics Array.<Gp.Services.Config.Thematic>

Informations about thematics associated to the resource.

globalConstraint Gp.Services.Config.Constraint

geographical constraint for the resource.

constraints Array.<Gp.Services.Config.Constraint>

additionnal geographical constraints for the resource.

originators Array.<Gp.Services.Config.Originator>

Informations about originator of the resource.

wmtsOptions Object

Informations associated to WMTS resources.

Properties
Name Type Description
tileMatrixSetLink String

TileMatrixSet identifier used by the resource (see Gp.Services.Config.TileMatrixSet)

tileMatrixSetLimits Gp.Services.Config.TileMatrixLimit

limits of the resource for that TileMAtrixSet.

queryable Boolean

true if a getFeatureInfo request may be done for the resource (WMS or WMTS only).

hidden Boolean

true if the resource is not visible.

isAggregate Boolean

true if the resource is an aggregate of other resources (@see aggregatedLayers).

aggregatedLayers Array.<String>

Layers IDs composing the being described aggregated layer.

apiKeys Array.<String>

Array of access keys that grant access to that resource.

dimensions Object

Dimensions informations associated with the resource.

Properties
Name Type Description
type String
visibilityRange String
visibilityMode String
noDataValue String
geometricType String