Namespace: ngeox
ngeox.BackgroundEvent
ngeox.CreateFilterOptions
The options to use when creating a filter using the ngeo.RuleHelper
service.
Properties:
Name | Type |
---|---|
dataSource |
ngeox.datasource.DataSource |
incDimensions |
boolean | undefined |
incTime |
boolean | undefined |
filter |
ol.format.filter.Filter | undefined |
filterRules |
!Array:.<ngeox.rule.Rule:> | undefined |
srsName |
string | undefined |
Members
dataSource: ngeox.datasource.DataSource
The data source from which to get the filterRules that will be used to create the OL filter object.
filter: ol.format.filter.Filter|undefined
A filter that is directly given the the method instead of creating one. Useful to automatically combine the time values.
filterRules: Array:.<!ngeox.rule.Rule:>|undefined
An alternative list of filter rules to use instead of those that are defined within the data source. Useful when one wants to get the data of a given filter without applying it to the data source.
incDimensions: boolean|undefined
Whether to include the dimensions related filters. Default to true
.
incTime: boolean|undefined
Whether to include the data source's time values in the filter created. The
property that contains those values is timeRangeValue
. Defaults to false
.
When building a filter for WMS, it should not be included as it is given as
the TIME parameter of the query instead. When used for a WFS request, it
should be included in the filter.
srsName: string|undefined
The SRS name used with the spatial filters created by the method.
ngeox.CreatePrint
ngeox.DesktopGeolocationDirectiveOptions
Options for the mobile geolocations directive.
Properties:
Name | Type |
---|---|
accuracyFeatureStyle |
ol.style.Style | Array:.<ol.style.Style:> | ol.StyleFunction | undefined |
positionFeatureStyle |
ol.style.Style | Array:.<ol.style.Style:> | ol.StyleFunction | undefined |
zoom |
number | undefined |
Members
accuracyFeatureStyle: ol.style.Style|Array:.<ol.style.Style:>|ol.StyleFunction|undefined
The style to use to sketch the accuracy feature, which is a regular polygon.
positionFeatureStyle: ol.style.Style|Array:.<ol.style.Style:>|ol.StyleFunction|undefined
The style to use to sketch the position feature, which is a point.
zoom: number|undefined
If set, in addition to recentering the map view at the location, determines the zoom level to set when obtaining a new position.
ngeox.DimensionFilterConfig
ngeox.Dimensions
Dimensions definition.
ngeox.DimensionsActive
Active dimensions definition, where the value can't be null.
ngeox.DimensionsFiltersConfig
Dimensions applied by filters configuration.
ngeox.dmsCoordinates
Format a coordinates as DMS coordinates. Arguments:
- coordinates Array of two numbers.
- opt_fractionDigits Optional number of digit. Default to 0.
- opt_template Optional template. Default to '{x} {y}'. Where "{x}" will be replaced by the easting coordinate, {y} by the northing one. Note: Use a html entity to use the semicolon symbol into a template.
Properties:
Name | Type |
---|---|
function(ol.Coordinate, |
string |
ngeox.Download
ngeox.DrawEvent
ngeox.duration
Format a duration in seconds to a more readable form. Arguments:
- duration The duration in seconds.
Properties:
Name | Type |
---|---|
function(number) |
string |
ngeox.FilterCondition
ngeox.GridColumnDef
Members
name: String
Name of a column.
ngeox.ImportDndOptions
ngeox.ImportLocalOptions
ngeox.ImportOnlineOptions
ngeox.ImportWmsGetCapItemOptions
ngeox.ImportWmtsGetCapItemOptions
ngeox.IssueGetFeaturesOptions
The options to use when sending GetFeature/GetFeatureInfo requests using the querent or map query service.
Properties:
Name | Type |
---|---|
bboxAsGETParam |
boolean | undefined |
coordinate |
ol.Coordinate | undefined |
dataSources |
Array:.<ngeox.datasource.DataSource:> | undefined |
extent |
ol.Extent | undefined |
filter |
ol.format.filter.Filter | undefined |
limit |
number | undefined |
map |
ol.Map |
queryableDataSources |
ngeox.QueryableDataSources | undefined |
tolerancePx |
number | undefined |
wfsCount |
boolean | undefined |
Members
bboxAsGETParam: boolean|undefined
Pass the queried bbox as a parameter of the GET query on WFS requests. Default to false.
coordinate: ol.Coordinate|undefined
The coordinate to issue the requests with, which can end up with either WMS or WFS requests.
dataSources: Array:.<ngeox.datasource.DataSource:>|undefined
List of data sources to query. Only those that meet the requirements will
actually be queried. The querent service requires either the dataSources
or queryableDataSources
property to be set.
extent: ol.Extent|undefined
The extent to issue the requests with, which can end up with WFS requests only.
filter: ol.format.filter.Filter|undefined
A filter to additionally use with the query. Only used by WFS requests. If a filter is defined, then it is used instead of the data source's filter rules.
limit: number|undefined
The maximum number of features to get per request.
map: ol.Map
The ol3 map object. Used to fill some parameters of the queries, such as 'srs' and filter the queryable layers within the data sources.
queryableDataSources: ngeox.QueryableDataSources|undefined
A hash of queryable data sources, which must meet all requirements. The
querent service requires either the dataSources
or queryableDataSources
property to be set.
tolerancePx: number|undefined
A tolerance value in pixels used to create an extent from a coordinate to issue WFS requests.
wfsCount: boolean|undefined
When set, before making WFS GetFeature requests to fetch features,
WFS GetFeature requests with resultType = 'hits'
are made first. If
the number of records for the request would exceed the limit, then
no features are returned.
ngeox.MapFeatureOverlayGroup
ngeox.MeasureEvent
ngeox.MenuActionOptions
The options for an action item for the contextual menu overlay.
Properties:
Name | Type |
---|---|
cls |
string | undefined |
label |
string | undefined |
name |
string |
Members
cls: string|undefined
CSS class name(s) to use for the icon of the action item.
label: string|undefined
The label to display for the action item. If not defined, the name is used.
name: string
A unique name for the menu action, which is used in the event fired when the action is clicked.
ngeox.MenuEvent
ngeox.MenuOptions
The options for the contextual menu overlay.
Properties:
Name | Type |
---|---|
actions |
Array:.<ngeox.MenuActionOptions:> |
autoClose |
boolean | undefined |
Members
actions: Array:.<ngeox.MenuActionOptions:>
A list of menu actions.
autoClose: boolean|undefined
Whether to automatically close the contextual menu when an action is
clicked or not. Defaults to true
.
title: string|undefined
A title to display as header of the contextual menu.
ngeox.Message
A message to display by the ngeo notification service.
Properties:
Name | Type |
---|---|
delay |
number | undefined |
popup |
boolean | undefined |
msg |
string |
target |
angular.JQLite | Element | string | undefined |
type |
string | undefined |
Members
delay: number|undefined
The delay in milliseconds the message is shown. Defaults to 7000
.
msg: string
The message text to display
popup: boolean|undefined
Whether the message should be displayed inside a popup window or not.
Defaults to false
.
target: angular.JQLite|Element|string|undefined
The target element (or selector to get the element) in which to display the message. If not defined, then the default target of the notification service is used.
type: string|undefined
The type of message. Defaults to info
.
ngeox.miscDebounce
Provides a debounce function used to debounce calls to a user-provided function.
Properties:
Name | Type |
---|---|
function(function(?), |
function |
ngeox.miscGetBrowserLanguage
Provides a function that returns the most appropriate 2-letter language code depending on the list of available languages and the browser languages settings.
Properties:
Name | Type |
---|---|
function(Array. |
string |
ngeox.miscSortableOptions
ngeox.miscToolActivateMgrEntry
ngeox.MobileGeolocationDirectiveOptions
Options for the mobile geolocations directive.
Properties:
Name | Type |
---|---|
accuracyFeatureStyle |
ol.style.Style | Array:.<ol.style.Style:> | ol.StyleFunction | undefined |
positionFeatureStyle |
ol.style.Style | Array:.<ol.style.Style:> | ol.StyleFunction | undefined |
zoom |
number | undefined |
autorotate |
boolean | undefined |
Members
accuracyFeatureStyle: ol.style.Style|Array:.<ol.style.Style:>|ol.StyleFunction|undefined
The style to use to sketch the accuracy feature, which is a regular polygon.
positionFeatureStyle: ol.style.Style|Array:.<ol.style.Style:>|ol.StyleFunction|undefined
The style to use to sketch the position feature, which is a point.
zoom: number|undefined
If set, in addition to recentering the map view at the location, determines the zoom level to set when obtaining a new position.
ngeox.ModifyEvent
ngeox.NominatimSearchResponseResult
ngeox.NominatimSearchResult
ngeox.number
Format a number with a precision.
Arguments:
- opt_precision: The used precision, default is 3.
Properties:
Name | Type |
---|---|
function(number, |
string |
ngeox.numberCoordinates
Format a couple of numbers as number coordinates.
Arguments:
- coordinates Array of two numbers.
- opt_fractionDigits Optional number of digit. Default to 0.
- opt_template Optional template. Default to '{x} {y}'. Where "{x}" will be replaced by the easting coordinate and "{y}" by the northing one. Note: Use a html entity to use the semicolon symbol into a template.
Properties:
Name | Type |
---|---|
function(ol.Coordinate, |
string |
ngeox.PopupFactory
ngeox.PopupOptions
The options for a popup created by the popup factory.
Properties:
Name | Type |
---|---|
autoDestroy |
boolean | undefined |
cls |
string | undefined |
content |
* | undefined |
height |
string | undefined |
title |
string | undefined |
url |
string | undefined |
width |
string | undefined |
Members
autoDestroy: boolean|undefined
Whether the popup should be automatically destroyed when hidden or not.
Defaults to false
.
cls: string|undefined
Extra class name to add to the popup.
content: *|undefined
The content of the popup. Either the content or URL must be set.
height: string|undefined
The height of the popup.
title: string|undefined
The title of the popup.
url: string|undefined
The URL to use for the iframe to include as content for the popup.
width: string|undefined
The width of the popup.
ngeox.QuerentResult
Hash of features by data source ids.
ngeox.QuerentResultItem
The definition of a result item returned by the querent service.
Properties:
Name | Type |
---|---|
features |
Array:.<ol.Feature:> |
tooManyFeatures |
boolean | undefined |
totalFeatureCount |
number | undefined |
Members
features: Array:.<ol.Feature:>
The list of features that were returned by the query.
limit: number
The maximum number of features to get with the query.
tooManyFeatures: boolean|undefined
Set if the query would have returned to many features. When set, no features are returned.
totalFeatureCount: number|undefined
The total number of features that would have been returned by the query.
ngeox.QueryableDataSources
A hash that contains 2 lists of queryable data sources: wfs
and wms
.
The same data source can only be in one of the two lists. The wfs
list
has priority, i.e. if the data source supports WFS, it's put in the
wfs
list.
Properties:
Name | Type |
---|---|
wfs |
!Array:.<!ngeox.datasource.OGC:> |
wms |
!Array:.<!ngeox.datasource.OGC:> |
Members
wfs: Array:.<ngeox.datasource.OGC:>
List of queryable data sources that support WFS.
wms: Array:.<ngeox.datasource.OGC:>
List of queryable data sources that support WMS.
ngeox.QueryOptions
The options for the query service.
Properties:
Name | Type |
---|---|
bboxAsGETParam |
boolean | undefined |
limit |
number | undefined |
queryCountFirst |
boolean | undefined |
sourceIdsProperty |
string | undefined |
tolerance |
number | undefined |
featureNS |
string | undefined |
featurePrefix |
string | undefined |
geometryName |
string | undefined |
Members
bboxAsGETParam: boolean|undefined
Pass the queried bbox as a parameter of the GET query on WFS requests. Default to false.
featureNS: string|undefined
The feature namespace for WFS GetFeature requests. The default is
http://mapserver.gis.umn.edu/mapserver
.
featurePrefix: string|undefined
The feature prefix for WFS GetFeature requests. The default is feature
.
geometryName: string|undefined
The name of the geometry property for WFS GetFeature requests. The default is geom
.
limit: number|undefined
The maximum number of records per request the query service should ask.
Defaults to 50
. Note that sources sharing the same URL are combined
together in a single request. This limit will still apply to those.
queryCountFirst: boolean|undefined
For WFS sources, should the number of features first be requested with
resultType=hits
before requesting the actual features in an seconds request?
Defaults to false
.
sourceIdsProperty: string|undefined
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. Defaults to
querySourceIds
.
tolerance: number|undefined
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 size of the bbox.
The default is 3
pixel.
ngeox.QueryResult
Results of the query source.
Properties:
Name | Type |
---|---|
sources |
!Array:.<ngeox.QueryResultSource:> |
total |
number |
pending |
boolean |
Members
pending: boolean
If at least one source is pending.
(non-null) sources: Array:.<ngeox.QueryResultSource:>
Results for each query source.
total: number
The number of results for all sources.
ngeox.QueryResultSource
Results for a query source.
Properties:
Name | Type |
---|---|
features |
Array:.<ol.Feature:> |
id |
number | string |
label |
string |
limit |
number |
pending |
boolean |
queried |
boolean |
tooManyResults |
boolean |
totalFeatureCount |
number | undefined |
Members
features: Array:.<ol.Feature:>
The matching features for this source.
id: number|string
Identifier (can be not unique).
label: string
Label.
limit: number
The maximum number of features that can be returned for a query with this source.
pending: boolean
Is the request for this source still ongoing?
queried: boolean
Has this source been queried for the last query request?
tooManyResults: boolean
If the last query for this source would return more features than the configured limit.
totalFeatureCount: number|undefined
If tooManyResults
is true
, this contains the total number of features.
ngeox.RotateEvent
ngeox.RoutingOptions
Properties:
Name | Type |
---|---|
backendUrl |
string | undefined |
profiles |
Array:.<ngeox.RoutingProfile:> | undefined |
ngeox.RoutingProfile
ngeox.RoutingVia
ngeox.ScaleselectorOptions
Members
dropup: boolean|undefined
True to get a drop menu that opens imself to the top, instead of the bottom.
ngeox.SearchDirectiveListeners
Properties:
Name | Type |
---|---|
open |
function | undefined |
close |
function | undefined |
cursorchange |
function | undefined |
select |
function | undefined |
autocomplete |
function | undefined |
datasetsempty |
function | undefined |
Members
autocomplete: function|undefined
close: function|undefined
cursorchange: function|undefined
datasetsempty: function|undefined
open: function|undefined
select: function|undefined
ngeox.SortableOptions
ngeox.TimeProperty
Time object
Properties:
Name | Type |
---|---|
widget |
ngeox.TimePropertyWidgetEnum |
maxValue |
string |
minValue |
string |
maxDefValue |
string | null |
minDefValue |
string | null |
mode |
ngeox.TimePropertyModeEnum |
resolution |
ngeox.TimePropertyResolutionEnum | undefined |
values |
Array:.<string:> | undefined |
interval |
Array:.<number:> |
ngeox.TimeRange
ngeox.unitPrefix
Format a number with the prefix and unit.
Arguments:
- opt_unit: The unit to used, default is ''.
- opt_type: (unit|square|binary) the type of units, default is 'unit'.
- opt_precision: The used precision, default is 3.
Properties:
Name | Type |
---|---|
function(number, |
string |
ngeox.WfsPermalinkData
Properties:
Name | Type |
---|---|
wfsType |
string |
filterGroups |
Array:.<ngeox.WfsPermalinkFilterGroup:> |
showFeatures |
boolean |
ngeox.WfsPermalinkFilter
ngeox.WfsPermalinkFilterGroup
ngeox.WfsPermalinkOptions
The options for the WFS query service (permalink).
Properties:
Name | Type |
---|---|
url |
string |
wfsTypes |
!Array:.<ngeox.WfsType:> |
pointRecenterZoom |
number | undefined |
defaultFeatureNS |
string |
defaultFeaturePrefix |
string |
maxFeatures |
number | undefined |
Members
maxFeatures: number|undefined
The maximum number of records per request the query service should ask.
Defaults to 50
.
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.
url: string
URL to the WFS server.
(non-null) wfsTypes: Array:.<ngeox.WfsType:>
The queryable WFS types.
ngeox.WfsType
A WFS type. To be used with ngeox.WfsPermalinkOptions
.
Properties:
Name | Type |
---|---|
featureType |
string |
label |
string | undefined |
featureNS |
string | undefined |
featurePrefix |
string | undefined |
Members
defaultFeatureNS: string
The default namespace URI used for features. This will be used if no custom namespace is given for a WFS type.
defaultFeaturePrefix: string
The default prefix for the feature namespace. This will be used if no custom prefix is given for a WFS type.
featureNS: string|undefined
The namespace URI used for features. If not given, the default namespace set
in ngeox.WfsPermalinkOptions
will be used.
featurePrefix: string|undefined
The prefix for the feature namespace. If not given, the default prefix set
in ngeox.WfsPermalinkOptions
will be used.
featureType: string
The feature type name. Required.
label: string|undefined
The field of a feature used as label.