The full configuration
The definition of an external OGC server
The color.
Configuration option for {@link import('gmf/query/gridComponent').GmfQueryGridComponent} to merge grid tabs.
E.g. 'two_wheels_park': ['velo_park', 'moto_park']} merges the sources
with label velo_park and moto_park into a new source two_wheels_park.
Configuration object for one profile's line.
Color of the line (hex color string).
Extract the elevation of a point (an item of the elevation data array).
The map definition.
Maximum number tiles to load simultaneously.
The minimum distance in pixels the cursor must move to be detected as a map move event instead of a click. Increasing this value can make it easier to click on the map.
The ratio between physical pixels and device-independent pixels (dips) on the device.
Projection object for the MousePositionDirective. Define a label and a filter to use to display coordinates for a projection.
The epsg name of a projection.
The filter function to use to format this projection. Arguments can be passed with colon as separator (example: MyFilter:args1:args2:...)
The label to display with this projection.
The key is the server type (mapserver, qgis, ...), if the
value is false the name of the layer will be not displayed. This is used to avoid duplicated title,
as text and in the legend image.
The key is the server type (mapserver,
qgis, ...) or image for an URL from a metadata. The value is some additional parameters set in the
query string.
Display or not groups title in the legend. default is true. Switching to false is useful to obtains a "flat" legend.
Use or not the bbox. Default to true. For QGIS server only.
A projection definitions.
The definition.
The extent.
Specify radius for regular polygons, or radius1 and radius2 for stars. See also: https://openlayers.org/en/latest/examples/regularshape.html
Shape's angle in radians. A value of 0 will have one of the shape's point facing up.
Displacement of the shape
Fill style.
Number of points for stars and regular polygons. In case of a polygon, the number of points is the number of sides.
Radius of a regular polygon.
Outer radius of a star.
Inner radius of a star.
Whether to rotate the shape with the view.
Rotation in radians (positive rotation clockwise).
Stroke style.
The action
The title
Datasource configuration options for the search directive.
The optional Bloodhound configuration for this data set. See: https://github.com/twitter/typeahead.js/blob/master/doc/bloodhound.md
List of allowed actions. The list may contain a
combination of add_theme, add_group or add_layer
Possible values for the 'layer_name' key. Used to define groups of dataset.
The name of a corresponding GeoJSON property key in the current dataset. The bound value of this property key will be used as label.
The geometry's projection for this set of data.
The optional Twitter.Typeahead. configuration for this dataset. See: https://github.com/twitter/typeahead.js/blob/master/
URL of the search service. Must contain a '%QUERY' term that will be replaced by the input string.
Internal: the compiled regular expression.
The regexp expression that must match to do the replacement.
The regexp flags.
The template to use to create a new value as replacement if the regex matches.
The color.
Line cap style: butt, round, or square.
Line dash pattern. Default is null (no dash).
Please note that Internet Explorer 10 and lower do not support the setLineDash method on
the CanvasRenderingContext2D and therefore this option will have no visual effect in these browsers.
Line dash offset.
Line join style: bevel, round, or miter.
Miter limit.
Width.
The style description.
The circle config.
The fill color.
The regular shape config.
The stoke config.
The z index.
The view definition.
The initial center for
the view. If a user projection is not set, the coordinate system for the center is
specified with the projection option. Layer sources will not be fetched if this
is not set, but the center can be set later with {@link #setCenter}.
If true, the extent constraint will only apply to the view center and not the whole extent.
If true, the view will always animate to the closest zoom level after an interaction; false means intermediary zoom levels are allowed.
Rotation constraint.
false means no constraint. true means no constraint, but snap to zero
near zero. A number constrains the rotation to that number of values. For
example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees.
Enable rotation.
If false, a rotation constraint that always sets the rotation to zero is
used. The constrainRotation option has no effect if enableRotation is
false.
The extent that constrains the view, in other words, nothing outside of this extent can be visible on the map.
The maximum resolution used to determine
the resolution constraint. It is used together with minResolution (or
maxZoom) and zoomFactor. If unspecified it is calculated in such a way
that the projection's validity extent fits in a 256x256 px tile. If the
projection is Spherical Mercator (the default) then maxResolution defaults
to 40075016.68557849 / 256 = 156543.03392804097.
The maximum zoom level used to determine the
resolution constraint. It is used together with minZoom (or
maxResolution) and zoomFactor. Note that if minResolution is also
provided, it is given precedence over maxZoom.
The minimum resolution used to determine
the resolution constraint. It is used together with maxResolution (or
minZoom) and zoomFactor. If unspecified it is calculated assuming 29
zoom levels (with a factor of 2). If the projection is Spherical Mercator
(the default) then minResolution defaults to
40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253.
The minimum zoom level used to determine the
resolution constraint. It is used together with maxZoom (or
minResolution) and zoomFactor. Note that if maxResolution is also
provided, it is given precedence over minZoom.
If false the view is constrained so
only one world is visible, and you cannot pan off the edge. If true the map
may show multiple worlds at low zoom levels. Only used if the projection is
global. Note that if extent is also provided it is given precedence.
The main projection.
The initial resolution for the view. The
units are projection units per pixel (e.g. meters per pixel). An
alternative to setting this is to set zoom. Layer sources will not be
fetched if neither this nor zoom are defined, but they can be set later
with {@link #setZoom} or {@link #setResolution}.
Resolutions to determine the
resolution constraint. If set the maxResolution, minResolution,
minZoom, maxZoom, and zoomFactor options are ignored.
The initial rotation for the view in radians (positive rotation clockwise, 0 means North).
Allow the view to be zoomed out to show the full configured extent. By default, when a view is configured with an extent, users will not be able to zoom out so the viewport exceeds the extent in either dimension. This means the full extent may not be visible if the viewport is taller or wider than the aspect ratio of the configured extent. If showFullExtent is true, the user will be able to zoom out so that the viewport exceeds the height or width of the configured extent, but not both, allowing the full extent to be shown.
If true, the extent
constraint will be applied smoothly, i.e. allow the view to go slightly outside
of the given extent.
If true, the resolution min/max values will be applied smoothly, i. e. allow the view to exceed slightly the given resolution or zoom bounds.
Only used if resolution is not defined. Zoom
level used to calculate the initial resolution for the view.
The zoom factor used to compute the corresponding resolution.
A WFS type. To be used with {@link WfsPermalinkOptions }.
The default namespace URI used for features. This will be used if no custom namespace is given for a WFS type.
The default prefix for the feature namespace. This will be used if no custom prefix is given for a WFS type.
The namespace URI used for features. If not given, the default namespace set in {@link WfsPermalinkOptions } will be used.
The prefix for the feature namespace. If not given, the default prefix set in {@link WfsPermalinkOptions } will be used.
The feature type name. Required.
The field of a feature used as label.
URL to the authentication web service.
Default language
URL to the full-text search web service.
The Authentication configuration.
Whether to show the change password button. Default to true.
You can also specify a PasswordValidator object to add constraint on user's new password.
Whether to show the password forgotten link. Default to true.
Don't request a new user object from the back-end after logging out if the logged-in user's role has this role.
The background layer selector options
The background layer with an opacity slider.
The raster service parameters
The CSV file name.
Additional CSS for the different elements
Use to inject custom javascript from an URL.
Use to inject custom stylesheet from an URL.
The WMS info format to be used with Arcgis OGC server.
The disclaimers options
Whether to use disclaimer messages elsewhere or not. Default to false.
If true, you should use the externalMessage and the externalVisibility too.
Only display the disclaimer if the layer is visible.
Defaults to true.
Whether to show the disclaimer messages in popups or not.
Defaults to false.
The display query grid component options.
A style object for all features from the result of the query.
Maximum zoom-level to use when zooming to selected features.
Configuration to merge grids with the same attributes into a single grid.
Should empty columns be hidden? Default: false.
A style object for the currently selected features.
The display query window component options.
If the query result window is collapsed.
If the attributes with null values should be displayed.
A style object for all features from the result of the query.
A style object for the currently selected features.
If true, immediately return to the main edit panel after save. Default is false.
A style object for highlighting of feature.
The buffer in pixels to use when making queries to get the features.
The elevation (raster) options.
Elevation layers to use.
Elevation layers configurations.
Floor dimension values and labels.
[Experimental] Whether all the layer group is expanded by default.
if true, open metadataURLs in a new window. Otherwise open them in a popup.
URL to the layers web service.
The number of significant digits to display.
A style for the measure area.
The number of significant digits to display.
A style for the measure length.
The number of significant digits to display.
The used formatter
Raster elevation layers to get information under the point and its configuration.
A style for the measure point.
The list of the projections.
Additional configuration options for the object editing tools directive.
The radius of the shapes created by the regular polygon radius creation tool. The value is in map units.
The application wide options.
The zoom control options
The css variables, in particular brand-primary and brand-secondary that will set all the branding.
Show the geolocalisation button.
The map interactions.
The map definition.
The map control.
The map interactions.
Show the information bar.
The view definition.
The default zoom.
Configuration options for the permalink service.
Display the crosshair, gets overridden by the
map_crosshair parameter. Default is false.
An alternate style for the crosshair feature added by the permalink service.
Zoom level to use when result is a single point feature. If not set the map is not zoomed to a specific zoom level.
EPSG codes (e.g. 'EPSG:3857' or '3857'). The permalink service will accept coordinates in these projections and try to detect which projection the given coordinates are in.
Store the values in the local storage. Default is false.
optional. Key, value object to define default value in each of your print panel field. The key refers to the property's name of the field. Example: {'comments': 'demo', 'legend': false}. Doesn't work for the DPI and the scale. Server's values are used in priority.
The list of attributes that should be hidden.
Options used to build the legend.
True to apply rotation on the mask instead of the map. By default, the map rotates.
URL to MapFishPrint.
URL to the profile web service.
The elevation (raster) options.
The hover point style.
Maximum limit of points to request.
The available projections definitions.
Use the query grid instead the query window to display the query result.
URL to the raster web service.
Clear button in the input search.
Whether to let the user change the style of the feature on the map.
codes of supported projections for coordinates search (projections must be defined in ol3). If not provided, only the map's view projection format will be supported.
The used datasources.
bloodhound request delay in ms.
maximum zoom we will zoom on result.
The placeholder.
A map of styles to apply on searched features. Keys must be the 'layer_name' property of features except for coordinates where the key ifor its style is the value of the constant 'gmf.COORDINATES_LAYER_NAME'. The 'default' key is used to apply the default style.
Enhable email.
URL to the shortener web service.
The snapping options
The max number of features in the extent to allows snapping
Configuration options for the themes service.
Whether to add a blank background layer to the list of available backgrounds.
Flush mode active?
URL to the theme web service.
Does the application use tow factor authentication
Languages URL
File encoding of the CSV file.
File extension of the CSV file.
Whether to include the header in the exported file or not.
Quote character.
Separator character.
Options for the geolocation directive.
The style to use to sketch the accuracy feature, which is a regular polygon.
Toggle geolocating at loading time if true.
Autorotate.
The style to use to sketch the position feature, which is a point.
If set, in addition to recentering the map view at the location, determines the zoom level to set when obtaining a new position
URL of the test page to detect online/offline.
URL to the WFS server.
Options for the profile.
Show a simplified profile when true.
Show a simplified x axis with only both end ticks.
Configuration object for the profile's
Inline CSS style definition to inject in the SVG. lines. The key string of each object is used as class for its respective svg line.
Inline CSS style definition to inject in the SVG.
The options for the query service.
Pass the queried bbox as a parameter of the GET query on WFS requests.
The feature namespace for WFS GetFeature requests.
The feature prefix for WFS GetFeature requests.
The name of the geometry property for WFS GetFeature requests.
The maximum number of records per request the query service should ask. Note that sources sharing the same URL are combined together in a single request. This limit will still apply to those.
For WFS sources, should the number of features first be
requested with resultType=hits before requesting the actual features in an seconds request?
Should be used on window result but not on grid result.
Defines the name of the layer property that holds the ids of the sources. Use this if you have more than one source bound to a layer.
When issuing an identify feature request at a click position, either a
WMS GetFeatureInfo or a WFS GetFeature request will be used. For GetFeature requests a bbox is built
around the position. This tolerance in pixel determines the minimal size of the bbox.
Same as tolerance but for touch devices.
The scale selector options
True to get a drop menu that opens imself to the top, instead of the bottom.
The available scales
Configuration object for streetview.
Buffer size for Mapillary bbox
ClientId for Mapillary
The viewer to use (google or mapillary)
List of replacements for string to html.
Load tiles up to preload levels. By default preload is Infinity, which means load all tiles on the top of the visible level. See also preload value in documentation for ol.Layer.Tile.
Regexp used to identify the used keys.
The options for the WFS query service (permalink).
The maximum number of records per request the query service should ask.
Zoom level to use when result is a single point feature. If not set the map is not zoomed to a specific zoom level.
The queryable WFS types.
The WMS info format to be used with Arcgis OGC server.
URL to LIDAR profile pytree service.
The description of the style
The OpenLayers stale
Generated using TypeDoc
displacement