The Angular $q service.
Angular timeout service.
Angular rootScope.
Main injector.
ngeo Debounce factory.
Gettext service.
Ngeo event helper service
The ngeo statemanager service.
ngeo location service.
The options.
The gmf datasourcemanager service.
The ngeo wmstime service
The key for map view 'propertychange' event.
A list of projections that the coordinates in the permalink can be in.
Listen to any changes that may occur within the feature in order to update the state of the permalink accordingly.
Feature.
Clean the permalink parameters
firstlevel groups of the tree
Contains the layer name
The layer to inspect
The layer name to find
The containing status
Create a filter group for a given prefix from the query params.
E.g. wfs_ or wfs_0_.
All param keys starting with wfs_.
A filter group.
Get the default theme from url, local storage, user functionalities or defaultTheme constant.
default theme name.
Get the default theme from user functionalities.
default theme name.
Get the background layer object to use to initialize the map from the state manager.
Array of background layer objects.
Background layer.
Get the background layer opacity to use to initialize the map from the state manager.
Opacity.
Get the ngeo features from the state manager for initialization purpose
The features read from the state manager.
Get the coordinate to use to initialize the map view from the state manager.
The coordinate for the map view center.
Get the map crosshair property from the state manager, if defined.
Whether map crosshair property is set or not.
Get the tooltip text from the state manager.
Tooltip text.
Get the zoom level to use to initialize the map view from the state manager.
The zoom for the map view.
Get the query data for a WFS permalink.
The query data.
Called when the background layer changes. Update the state using the background layer label, i.e. its name.
Collection event.
Collection event.
Called when layer being swipe
layer object.
old layer object.
Called when map swipe value change.
Collection event.
Called once upon initialization of the permalink service if there's at least one feature in the ngeoFeatures collection, then called every time the collection changes or any of the features within the collection changes.
Collection event.
Promise
Get the current first level node names in the tree manager and update the correspondent state of the permalink.
Update the time values in the state.
Controller.
The start and optionally the end datetime (for time range selection) selected by user
Data source group.
Listen to the map view property change and update the state accordingly.
The ol3 map object.
ObjectEditing feature
Unregister any event listener from the feature.
Feature.
The global dimensions object.
Set the External Data Sources parameters in the url.
Bind an ol3 map object to this service. The service will, from there on, listen to the properties changed within the map view and update the following state properties: map_x, map_y and map_zoom.
If the service is already bound to a map, those events are unlistened first.
The ol3 map object.
Sets the map crosshair to the center (or the map center if nothing provided). Overwrites an existing map crosshair.
Sets the map tooltip to the center (or the map center if nothing provided). Overwrites an existing map tooltip.
Text to display in tooltip.
Set the time from permalink in datasource and widget.
Controller
Theme name.
Return true if there is a theme specified in the URL path.
Array of path elements.
theme in path.
Data source group.
Remove any event listeners from the current map.
Generated using TypeDoc
The Permalink service for GMF, which uses the
ngeo.statemanager.Serviceto manage the GMF application state. Here's the list of states are are managed:For time layers the time range or time value is added
It can also be used to add different types of things in the map, such as features, external data sources, etc.
This is made using parameters in the url, which can be static (i.e. parameters that always have the same name) or dynamic (i.e. parameters that have a static prefix but with a full name being dynamic).
Here's a complete list of possible parameters and what they do. But first, a legend
=== Parameters [type] ===
[paramameter_name](type) [parameter documentation]=== Parameters (static) ===
A static parameter always have the same name.
baselayer_ref- "string" The name of the base layer that should be set visible as default in the map. If none is set, then the default one in the loaded theme is set instead.eds_n(string),eds_u(string) These parameters stand for:eds_ucontaining the urls to the services andeds_nthe layer names (separated by;). Here's an example: &eds_n=a;b;c,d,e&eds_u=host1.com,host2.com,host3.com, which reads as:map_crosshair(boolean) If this parameter set totrue, then a crosshair marker will be added to the center of the map upon initialization. The marker will stay at this location.map_tooltip(string) If set, then the text defined in this parameter will be added as a tooltip at center of the map upon initialization.map_x(number),map_y(number) These two parameters define a coordinate the map view should be centered to upon initialization. The value must be in the map view projection.map_zoom(number) Defines the zoom level the map view should be zoomed to upon initialitation.rl_features(string) This parameter defines vector features to add to the map upon initializaton. In addition, if the application includes the draw tool, the features added can be modified. The draw tool can also be used to add new features, which are automatically added in the url.tree_groups(string) Defines the layer groups that should be added to the layer tree upon application initialization as a comma-separated list. For example: Layers,Filters,Externalswfs_layer(string) If set, this parameter defines the name of a layer that supports WFS to use to fetch features and add them to the map upon initialization. The dynamic parameterwfs_[]is required to identify the features to fetch.wfs_ngroups(number) If set, thenwfs_layerrepresents the name of a group and this property defines how many layers are in it. Requireswfs_layerto be set.wfs_show_features(boolean) If set tofalseor0, then the features returned by thewfs_layerparameter will not be shown in the map.=== Parameters (dynamic) ===
Dynamic parameters have variable names, which is always composed of:
The same dynamic parameter can be set multiple times, with different suffix values as name.
For example:
&wfs_a=&wfs_b=.wfs_is the static prefixthe name used as reference for this dynamic parameter is
wfs_[]therefore, this example has 2
wfs_[]parameters set, withaandbbeing the variable suffixdim_[](string) Variable suffix: the name of a dimension Value: * Defines the value of a specific dimension to set upon loading the application. For example:&dim_time=2019-01-25T14:45:51.986Z. WMS data sources that support the dimension set will be initialized with its value.tree_enable_[](boolean) Variable suffix: the name of a layer group Value: whether the group should be enabled or not in the layer tree For example:&tree_enable_polygon=true&tree_enable_point=falsemeans that the grouppolygonwill be enabled in the layer tree, but notpoint.tree_group_layers_[](string) Variable suffix: the name of a layer group Value: a comma-separated list of layers within the group that should be enabled upon initialization. For example:&tree_group_layers_polygon=forest,lakemeans that only the layersforestandlakewithin the grouppolygonwould be enabled upon initialization.tree_opacity_[](number) Variable suffix: the name of a layer group Value: Number between 0 (transparent) and 1 (opaque) Defines the opacity of a layer group upon initialization.tree_time_[](date) Variable suffix: the name of a layer group or layer Value: a date or date interval with the resolution of the time of the layer or group Defines the time or time interval for a time layer or a group.wfs_[](string) Variable suffix: the name of an attribute Value: A comma-separated list of values for the attribute This parameter requireswfs_layerin order to work properly. If set, it defines the filters to build to fetch the features to add to the map. For example:&wfs_layer=fuel&wfs_osm_id=1420918679,441134960the layerfuelwill be fetched features with the attributeosm_idequal to1420918679or441134960. Ifwfs_ngroupsis set, then an index is added to after the prefix of thewfs_[]parameter, for example:wfs_ngroups=2&wfs_0_[]=&wfs_1_[]==== More documentation ===
To have the whole possibilities offer by the permalink, these services should be instantiated: ngeoBackgroundLayerMgr, ngeoFeatureOverlayMgr, ngeoFeatureHelper, gmfPermalinkOptions, gmfThemes, gmfObjectEditingManager, gmfThemeManager, defaultTheme, gmfTreeManager, ngeoWfsPermalink, ngeoAutoProjection and ngeoFeatures.
Used functionalities:
default_theme: Theme to use by default.service
gmfPermalink