Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add visible documentation about metadata and functionnalities #4894

Merged
merged 1 commit into from May 13, 2019

Conversation

sbrunner
Copy link
Member

No description provided.

@sbrunner sbrunner added this to the 2.4.1 milestone May 13, 2019
@sbrunner sbrunner requested a review from fredj May 13, 2019 11:21
@sbrunner sbrunner force-pushed the metadata-docs branch 2 times, most recently from d1f3455 to c80c281 Compare May 13, 2019 11:31
@sbrunner sbrunner merged commit b50062c into 2.4 May 13, 2019
@sbrunner sbrunner deleted the metadata-docs branch May 13, 2019 12:17
@@ -44,19 +44,22 @@ import olSourceTileWMS from 'ol/source/TileWMS.js';


/**
* @hidden
* The GeoMapFish DataSources Manager is responsible of listenening to the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of listenening -> for listening

* c2cgeoportal's themes to create instances of `ngeo.datasource.DataSource`
* objects with the layer definitions found and push them in the
* `DataSources` collection. The Manager must be initialized
* with the app's map using the setDatasourcseMap() method.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setDatasourceMap()

@@ -53,7 +55,7 @@ function forEachDisclaimer(layer, func) {
* @ngdoc controller
* @ngname GmfDisclaimerController
*/
function Controller(
function DisclamerController(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be DisclaimerController

* values (for filters purpose). For WMS layers.
* * snappingConfig: The snapping configuration for the leaf. If set, the leaf's layer is considered to be
* "snappable", even if the config itself is empty.
* Example of value: {'tolerance': 50, 'edge': false} For WMS layers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example of value -> Example value

*
* * isChecked: if 'false' the layer visibility will be set to false.
* * iconUrl: layer icon full URL.
* * legendRule: WMS rule used to get a layer icon.
* * isLegendExpanded: if 'true' the legend is expanded by default.
* * metadataUrl: Display a popup with the content of the given URL if
* possible also open a new window.
* * exclusiveGroup: Whether the group contain children that have to be mutually
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contains

*
* * isChecked: if 'false' the layer visibility will be set to false.
* * iconUrl: layer icon full URL.
* * legendRule: WMS rule used to get a layer icon.
* * isLegendExpanded: if 'true' the legend is expanded by default.
* * metadataUrl: Display a popup with the content of the given URL if
* possible also open a new window.
* * exclusiveGroup: Whether the group contain children that have to be mutually
* exclusive, meaning that only one child may be ON at any time.
* * legend: Display the legend of this layers. For WMS and WMTS layers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this layer.

* * legend: Display the legend of this layers. For WMS and WMTS layers.
* * legendImage: The URL to the image used as a legend in the layer tree. For WMS and WMTS layers.
* * maxResolution: The max resolution where the layer is visible. For WMS layers.
* On WMTS layers it will have effect on the node in the layertree but not on the layertree directly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it will have an effect

* * maxResolution: The max resolution where the layer is visible. For WMS layers.
* On WMTS layers it will have effect on the node in the layertree but not on the layertree directly.
* * minResolution: The min resolution where the layer is visible. For WMS layers.
* On WMTS layers it will have effect on the node in the layertree but not on the layer directly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it will have an effect

* * minResolution: The min resolution where the layer is visible. For WMS layers.
* On WMTS layers it will have effect on the node in the layertree but not on the layer directly.
* * ogcServer: The corresponding OGC server for a WMTS layer. For WMTS layers.
* * opacity: Layer opacity. 1.0 means fuly visible, 0 means invisible, For WMS and WMTS layers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fully

* * ogcServer: The corresponding OGC server for a WMTS layer. For WMTS layers.
* * opacity: Layer opacity. 1.0 means fuly visible, 0 means invisible, For WMS and WMTS layers.
* * timeAttribute: The name of the time attribute. For WMS(-T) layers.
* * wmsLayers: A corresponding WMS layer for a WMTS layers. Used to query the WMTS layers and to print it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... for a WMTS layer. Used to query the WMTS layer ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or:
... for WMTS layers. Used to query the WMTS layers and to print them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants