Namespace: gmfx
gmfx.AuthenticationDefaultResponse
gmfx.AuthenticationEvent
gmfx.AuthenticationFunctionalities
Availables functionalities.
Properties:
| Name | Type |
|---|---|
default_basemap |
Array:.<string:> |
default_theme |
Array:.<string:> |
filtrable_layers |
Array:.<string:> | undefined |
location |
Array:.<string:> |
Members
default_basemap: Array:.<string:>
Base maps to use by default.
default_theme: Array:.<string:>
Theme to use by default.
filtrable_layers: Array:.<string:>|undefined
A list of layer names that can be filtered.
location: Array:.<string:>
Availables locations.
gmfx.AuthenticationLoginResponse
gmfx.ComparisonFilter
Members
operator: string
The type of operator for the comparison filter.
property: string
The name of the property for the comparison filter.
value: string
The value for the comparison filter that must match the combinaison of the operator and property.
gmfx.Config
A part of the application config.
Properties:
| Name | Type |
|---|---|
srid |
number |
positionFeatureStyle |
ol.style.Style | undefined |
accuracyFeatureStyle |
ol.style.Style | undefined |
geolocationZoom |
number | undefined |
autorotate |
boolean | undefined |
mapViewConfig |
olx.ViewOptions | undefined |
mapControls |
ol.Collection:.<ol.control.Control:> | Array:.<ol.control.Control:> | undefined |
mapInteractions |
ol.Collection:.<ol.interaction.Interaction:> | Array:.<ol.interaction.Interaction:> | undefined |
mapPixelRatio |
number | undefined |
gmfx.ExternalOGCServer
gmfx.GridMergeTabs
Configuration option for gmf.query.gridComponent 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.
gmfx.GridSource
Configuration for a grid tab.
Properties:
| Name | Type |
|---|---|
configuration |
ngeo.grid.Config |
source |
ngeox.QueryResultSource |
Members
configuration: ngeo.grid.Config
Configuration used to initialize a grid.
source: ngeox.QueryResultSource
Results of the query source.
gmfx.LidarPoint
Profile point after measure or after parsing of the binary array returned by Pytree
Properties:
| Name | Type |
|---|---|
distance |
number | undefined |
altitude |
number | undefined |
color_packed |
Array:.<number:> | undefined |
coords |
Array:.<number:> | undefined |
intensity |
number | undefined |
classification |
number | undefined |
set |
boolean | undefined |
gmfx.LidarPointAttributeList
The lidar point attribute list width default option
Properties:
| Name | Type |
|---|---|
availableOptions |
Array:.<lidarprofileServer.ConfigPointAttributes:> | undefined |
selectedOption |
lidarprofileServer.ConfigPointAttributes | undefined |
gmfx.LidarprofileClientConfig
gmfx.LidarprofilePoints
The object containing all points in profile
Properties:
| Name | Type |
|---|---|
distance |
Array:.<number:> | undefined |
altitude |
Array:.<number:> | undefined |
color_packed |
Array:.<Array:.<number:>> | undefined |
intensity |
Array:.<number:> | undefined |
classification |
Array:.<number:> | undefined |
coords |
Array:.<Array:.<number:>> | undefined |
gmfx.MousePositionProjection
Projection object for the MousePositionDirective. Define a label and a filter to use to display coordinates for a projection.
Properties:
| Name | Type |
|---|---|
code |
string |
label |
string |
filter |
string |
Members
code: string
The epsg name of a projection.
filter: string
The filter function to use to format this projection. Arguments can be passed with colon as separator (example: MyFilter:args1:args2:...)
label: string
The label to display with this projection.
gmfx.ObjectEditingQueryableLayerInfo
Members
layerNode: gmfThemes.GmfLayerWMS
ogcServer: gmfThemes.GmfOgcServer
gmfx.ObjectEditingToolsOptions
Additional configuration options for the object editing tools directive.
Properties:
| Name | Type |
|---|---|
regularPolygonRadius |
number | undefined |
Members
regularPolygonRadius: number|undefined
The radius of the shapes created by the regular polygon radius creation
tool. Default value is 100. The value is in map units.
gmfx.PasswordValidator
gmfx.PermalinkOptions
Configuration options for the permalink service.
Properties:
| Name | Type |
|---|---|
crosshairStyle |
Array:.<(null:|ol.style.Style:)> | null | ol.FeatureStyleFunction | ol.style.Style | undefined |
crosshairEnabledByDefault |
boolean | undefined |
projectionCodes |
Array:.<string:> | undefined |
useLocalStorage |
boolean | undefined |
pointRecenterZoom |
number | undefined |
Members
crosshairEnabledByDefault: boolean|undefined
Display the crosshair, gets overridden by the map_crosshair parameter. Default is false.
crosshairStyle: Array:.<(null:|ol.style.Style:)>|null|ol.FeatureStyleFunction|ol.style.Style|undefined
An alternate style for the crosshair feature added by the permalink service.
pointRecenterZoom: number|undefined
Zoom level to use when result is a single point feature. If not set the map is not zoomed to a specific zoom level.
projectionCodes: Array:.<string:>|undefined
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.
useLocalStorage: boolean|undefined
Store the values in the local storage. Default is false.
gmfx.PrintLayoutInfo
Fields that can come from a print v3 server and can be used in the partial of the gmf print panel.
Properties:
| Name | Type |
|---|---|
simpleAttributes |
Array:.<gmfx.PrintSimpleAttributes:> | undefined |
attributes |
Array:.<string:> |
dpi |
number | undefined |
dpis |
Array:.<number:> | undefined |
formats |
Object:.<string:, boolean:> | undefined |
layout |
string | undefined |
layouts |
Array:.<string:> | undefined |
legend |
boolean | undefined |
scale |
number | undefined |
scales |
Array:.<number:> | undefined |
Members
dpi: number|undefined
The selected 'dpi'.
dpis: Array:.<number:>|undefined
The list of 'dpis'.
formats: Object:.<string:, boolean:>|undefined
The list of active 'formats' (png, pdf, ...).
layout: string|undefined
The selected 'layout'.
layouts: Array:.<string:>|undefined
The list of 'layouts'.
legend: boolean|undefined
The legend checkbox.
scale: number|undefined
The selected 'scale'.
scales: Array:.<number:>|undefined
The list of 'scales'
simpleAttributes: Array:.<gmfx.PrintSimpleAttributes:>|undefined
Custom print layoutInfo.
gmfx.PrintSimpleAttributes
Object that can be used to generate a form field.
Properties:
| Name | Type |
|---|---|
default |
string | boolean | number | undefined |
name |
string |
type |
string |
Members
default: string|boolean|number|undefined
Default value of the form field.
name: string
Name of the form field.
type: string
Type of the field. Can be 'String', 'Boolean' or 'Number'.
gmfx.ProfileHoverPointInformations
Information to display for a given point in the profile. The point is typically given by the profile's hover.
Properties:
| Name | Type |
|---|---|
coordinate |
ol.Coordinate | undefined |
distance |
number | undefined |
elevations |
Object:.<string:, number:> | undefined |
xUnits |
string | undefined |
yUnits |
string | undefined |
Members
coordinate: ol.Coordinate|undefined
Coordinate of the point.
distance: number|undefined
distance of the point on the line. Can be in meters or kilometers.
elevations: Object:.<string:, number:>|undefined
Elevations of the point (example: {aster: 556.5, srtm: 560}).
xUnits: string|undefined
Units of the x axis.
yUnits: string|undefined
Units of the y axis.
gmfx.ProfileLineConfiguration
Configuration object for one profile's line.
Properties:
| Name | Type |
|---|---|
color |
string | undefined |
zExtractor |
function | undefined |
Members
color: string|undefined
Color of the line (hex color string).
zExtractor: function|undefined
Extract the elevation of a point (an item of the elevation data array).
gmfx.SearchComponentDatasource
Datasource configuration options for the search directive.
Properties:
| Name | Type |
|---|---|
bloodhoundOptions |
BloodhoundOptions | undefined |
labelKey |
string |
groupValues |
Array:.<string:> | undefined |
groupActions |
Array:.<string:> | undefined |
projection |
string | undefined |
typeaheadDatasetOptions |
TypeaheadDataset | undefined |
url |
string |
Members
bloodhoundOptions: BloodhoundOptions|undefined
The optional Bloodhound configuration for this data set. See: https://github.com/twitter/typeahead.js/blob/master/doc/bloodhound.md
groupActions: Array:.<string:>|undefined
List of allowed actions. The list may contain a combination of
add_theme, add_group or add_layer
groupValues: Array:.<string:>|undefined
Possible values for the 'layer_name' key. Used to define groups of dataset.
labelKey: string|undefined
The name of a corresponding GeoJSON property key in the current dataset. The bound value of this property key will be used as label.
projection: string|undefined
The geometry's projection for this set of data.
typeaheadDatasetOptions: TypeaheadDataset|undefined
The optional Typeahead configuration for this dataset. See: https://github.com/twitter/typeahead.js/blob/master/ doc/jquery_typeahead.md#datasets
url: string
Url of the search service. Must contain a '%QUERY' term that will be replaced by the input string.
gmfx.ShortenerAPIRequestParams
gmfx.ShortenerAPIResponse
Members
(static) data: gmfx.ShortenerAPIResponseData
Response payload to the shortener API
(static) status: number|undefined
HTTP status
gmfx.ShortenerAPIResponseData
gmfx.StylesObject
gmfx.ThemesOptions
Configuration options for the themes service.
Properties:
| Name | Type |
|---|---|
addBlankBackgroundLayer |
boolean | undefined |
Members
addBlankBackgroundLayer: boolean|undefined
Whether to add a blank background layer to the list of available backgrounds.
gmfx.TreeManagerFullState
gmfx.User
Properties:
| Name | Type |
|---|---|
functionalities |
gmfx.AuthenticationFunctionalities | null |
is_password_changed |
boolean | null |
role_id |
number | null |
role_name |
string | null |
username |
string | null |
Members
functionalities: gmfx.AuthenticationFunctionalities|null
Configured functionalities of the user.
is_password_changed: boolean|null
True if the password of the user has been changed. False otherwise.
role_id: number|null
the role id of the user.
role_name: string|null
The role name of the user.
username: string|null
The name of the user.