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
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| 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
|
Methods
-
getAggregatedLayers(){Object}
Services/AutoConf/Response/model/Layer.js, line 300 -
Returns information about aggregated layers composing the being described layer, in case the resource is an aggregate of other resources.
Returns:
- Layers IDs composing the being described aggregated layer.
-
getBBOX(){Gp.BBox}
Services/AutoConf/Response/model/Layer.js, line 133 -
Returns the global BBOX
Returns:
- the layer global bounding box, expressed in CRS system.
-
getConstraints(){Array.<Gp.Services.Config.Constraint>}
Services/AutoConf/Response/model/Layer.js, line 273 -
Returns information about geographical or temporal constraints for the resource
Returns:
- Informations about geographical or temporal constraints for the resource
-
getDefaultFormat(){String}
Services/AutoConf/Response/model/Layer.js, line 256 -
Returns layer default format
Returns:
- Format mime-type. (eg. "image/jpeg")
-
getDefaultProjection(){String}
Services/AutoConf/Response/model/Layer.js, line 112 -
Returns the layer default projection
Returns:
- coordinates system ID used by default for the resource (WMS or WFS layer) or of the TileMatrixSet used by the WMTS layer.
-
getDefaultStyle(){String}
Services/AutoConf/Response/model/Layer.js, line 230 -
Returns layer default style
Returns:
- style identifier (eg: "normal", "bdparcellaire", ...)
-
getDescription(){String}
Services/AutoConf/Response/model/Layer.js, line 85 -
Returns the layer description
Returns:
- Resource description.
-
getDimensions(){Object}
Services/AutoConf/Response/model/Layer.js, line 291 -
Returns information about dimensions associated with this resource
Returns:
- Dimensions informations associated with the resource.
-
getLayerId(){String}
Services/AutoConf/Response/model/Layer.js, line 94 -
Returns the layer identifier
Returns:
- Unique resource Identifier (eg : "GEOGRAPHICALGRIDSYSTEMS.MAPS$GEOPORTAIL:OGC:WMTS")
-
getLegends(){Array.<Gp.Services.Config.Legend>}
Services/AutoConf/Response/model/Layer.js, line 203 -
Returns information about legends associated to the resource.
Returns:
- Informations about legends associated to the resource.
-
getMaxScaleDenominator(){Number}
Services/AutoConf/Response/model/Layer.js, line 157 -
Returns the layer maximum scale denominator
Returns:
- maximum scale denominator for this layer
-
getMetadata(){Array.<Gp.Services.Config.Metadata>}
Services/AutoConf/Response/model/Layer.js, line 212 -
Returns information about metadata associated to the resource.
Returns:
- Informations about metadata associated to the resource.
-
getMinScaleDenominator(){Number}
Services/AutoConf/Response/model/Layer.js, line 145 -
Returns the layer minimum scale denominator
Returns:
- minimum scale denominator for this layer
-
getName(){String}
Services/AutoConf/Response/model/Layer.js, line 67 -
Returns the layer name
Returns:
- name of the resource to use with the webservice that serves it (eg : "GEOGRAPHICALGRIDSYSTEMS.MAPS").
-
getOriginators(){Array.<Gp.Services.Config.Originator>}
Services/AutoConf/Response/model/Layer.js, line 282 -
Returns information about originators of this resource
Returns:
- Informations about originators of this resource
-
getProjections(){Array.<String>}
Services/AutoConf/Response/model/Layer.js, line 121 -
Returns the layer projections
Returns:
- coordinates systems IDs availables for the resource, including the default one.
-
getQuicklookUrl(){String}
Services/AutoConf/Response/model/Layer.js, line 103 -
Returns the layer quicklookUrl
Returns:
- Image URL for the resource.
-
getServerUrl(apiKey){String}
Services/AutoConf/Response/model/Layer.js, line 191 -
Returns Geoportal server url for a given key
Name Type Description apiKey String Access key to Geoportal platform
Returns:
- general URL of the web service (with the geoportal access key)
-
getServiceParams(){Object}
Services/AutoConf/Response/model/Layer.js, line 181 -
Returns information about the webservice that serves the resource
Returns:
- Information about the webservice that serves the resource (OpenLS, WFS, WMTS)
-
getStyles(){Array.<Gp.Services.Config.Style>}
Services/AutoConf/Response/model/Layer.js, line 221 -
Returns information about styles availables for the resources (WMS, WFS and WMTS only).
Returns:
- Informations about styles availables for the resources (WMS, WFS and WMTS only).
-
getThematics(){Array.<Gp.Services.Config.Thematic>}
Services/AutoConf/Response/model/Layer.js, line 247 -
Returns information about thematics associated to the resource.
Returns:
- Informations about thematics associated to the resource.
-
getTitle(){String}
Services/AutoConf/Response/model/Layer.js, line 76 -
Returns the layer title
Returns:
- Human readable name for the resource.
-
getTMSID(){String}
Services/AutoConf/Response/model/Layer.js, line 169 -
Returns layer Tile Matrix Set identifier if exists
Returns:
- Tile Matrix Set identifier (for instance : "PM")