Geoportal Resources Access API Reference

Namespace: GetConfigResponse

Gp.Services.GetConfigResponse

Response object for Gp.Services.getConfig () invocation when successful. Received as the argument of onSuccess callback function.

Properties:
Name Type Description
generalOptions Object

General properties for default map configuration resources.

Properties
Name Type Description
apiKeys Object

Object that associates apiKey (s) with an array of resources IDs availables with that key.
title String

Underlying web service Title.
defaultGMLGFIStyle String

XSL URL used by default to translate an XML GetFeatureInfo response into an HTML array.
theme String

default theme (FIXME : for what ?)
wgs84Resolutions Array.<Float>

geographical resolutions Array for each zoom level of the Geoportal platform from 0 to 21. Expressed in degrees/pixel.
layers Object

Associative array mapping resources availables IDs (keys) with their properties (values given as Gp.Services.Config.Layer).
territories Object

Associative array mapping french territories IDs (keys) with their properties (values given as Gp.Services.Config.Territory).
tileMatrixSets Object

Associative Array mapping TileMatrixSets IDs (keys) availables with their properties (values given as Gp.Services.Config.TileMatrixSet).
services Object

Associative Array mapping Geoportal web services IDs (keys) availables with their properties (values given as Gp.Services.Config.Service).

Methods

getLayerConf(layerId){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 100

Returns a geoportal layer configuration, given its identifier

Name Type Description
layerId String

Geoportal layer identifier (e.g. "GEOGRAPHICALGRIDSYSTEMS.MAPS$GEOPORTAIL:OGC:WMTS")
Returns:
- Layer configuration : instance of Gp.Services.Config.Layer

getLayersConf(apiKey){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 82

Returns an associative array of Geoportal layers configurations, corresponding to an API contract key.
If no key is specified, all layers from configuration are returned.

Name Type Description
apiKey String

Access key to Geoportal platform
Returns:
- Object which properties are layers identifiers, and corresponding
values are instances of <Gp.Services.Config.Layer>.

getLayersId(apiKey){Array}

Services/AutoConf/Response/model/AutoConfResponse.js, line 70

Returns an array of Geoportal layers identifiers, corresponding to an API contract key.

Name Type Description
apiKey String

Access key to Geoportal platform
Returns:
- Array of geoportal layers identifiers

getServiceConf(serviceID){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 169

Returns a service configuration, given its identifier.

Name Type Description
serviceID String

service identifier (e.g. "OGC:WMTS")
Returns:
- service configuration, instance of Gp.Services.Config.Service

getServices(){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 159

Returns an associative array of services configurations.

Returns:
- Object which properties are services identifiers,
and corresponding values are instances of Gp.Services.Config.Service.

getTerritories(){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 136

Returns an associative array of territories configurations.

Returns:
- Object which properties are territory identifiers,
and corresponding values are instances of Gp.Services.Config.Territory.

getTerritoryConf(territoryID){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 146

Returns a territory configuration, given its identifier.

Name Type Description
territoryID String

territory identifier (e.g. "FXX")
Returns:
- Territory configuration, instance of Gp.Services.Config.Territory

getTileMatrixSets(){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 113

Returns an associative array of Tile Matrix Sets configurations.

Returns:
- Object which properties are TMS identifiers,
and corresponding values are instances of Gp.Services.Config.TileMatrixSet.

getTMSConf(tmsID){Object}

Services/AutoConf/Response/model/AutoConfResponse.js, line 123

Returns a Tile Matrix Sets configuration, given its identifier.

Name Type Description
tmsID String

Tile Matrix Set identifier (e.g. : "PM")
Returns:
- Tile Matrix Set configuration, instance of Gp.Services.Config.TileMatrixSet

isConfLoaded(apiKey){Boolean}

Services/AutoConf/Response/model/AutoConfResponse.js, line 54

Check if config is loaded for a given key

Name Type Description
apiKey String

Access key to Geoportal platform
Returns:
- true if config is already loaded, false otherwise