Class: module:OGC

ngeo.datasource.module:OGC.ngeo.datasource.module:OGC

new module:OGC(options)

A data source contains information of a single source of data that can show or fetch the data using an OGC server. Several OGC service types are supported by this data source: WMS, WMTS and even WFS.

You can use the information stored within an OGC data source to do all sorts of things:

  • issue WMS/WFS queries
  • apply filter rules on it
  • create ol.layer.Layer objects using the WMS, WMTS or event WFS information
Parameters:
Name Type Description
options ngeox.datasource.OGCOptions

Options.

Implements:

Members

activeDimensions

Implements:

combinableForWFS: boolean

Implements:

combinableForWMS: boolean

Implements:

copyable

dimensionsConfig

dimensionsConfig

filterCondition

Implements:

filterCondition

Implements:

filterRules

Implements:

filterRules

Implements:

filtrable

filtrable

geometryName

ogcImageType

ogcLayers

ogcServerType

ogcType

queryable

Whether the data source is queryable or not. For an OGC data source to be queryable, it requires the support of WFS or WMS and at least one ogc layer to be querable.

Implements:

snappable

snappingToEdges

snappingTolerance

snappingToVertice

supportsAttributes

To be able to do advanced operations on a data source, such as editing or filtering, a data source must be bound to 1 set of attributes. These attributes are the ones defined by an ogcLayer. This means that to be considered to support having attributes defined, you either need to define them directly when creating the data source, or if you let the querent service get them for you using a WFS DescribeFeatureType request, the data source must have only 1 ogcLayer set, which must be queryable.

supportsWFS: boolean

Implements:

supportsWMS: boolean

Implements:

supportsWMTS

timeAttributeName

timeLowerValue

timeLowerValue

timeProperty

timeRangeValue

timeRangeValue

timeUpperValue

timeUpperValue

wfsFeatureNS

wfsFeaturePrefix

wfsFormat

wfsOutputFormat

wfsUrl

Implements:

wmsFormat

wmsInfoFormat

wmsIsSingleTile

wmsUrl: string|undefined

Implements:

wmtsLayer

wmtsUrl

Methods

combinableWithDataSourceForWFS(dataSource)

Parameters:
Name Type Description
dataSource ngeox.datasource.OGC

Data source.

Implements:
Returns:
boolean

Whether this data source can be combined to the given other data source to fetch features in a single WFS request.

combinableWithDataSourceForWMS(dataSource)

Parameters:
Name Type Description
dataSource ngeox.datasource.OGC

Data source.

Implements:
Returns:
boolean

Whether this data source can be combined to the given other data source to fetch features in a single WMS request.

getAttributes()

getFiltrableOGCLayerName()

Returns the filtrable OGC layer name. This methods asserts that the name exists and is filtrable.

Returns:
string

OGC layer name.

getInRangeOGCLayerNames(res, queryableOnly)

Returns a list of OGC layer names that are in range of a given resolution. If there's no OGC layers defined, an empty array is returned.

Parameters:
Name Type Default Description
res number

Resolution.

queryableOnly boolean false

Whether to additionally check if the OGC layer is queryable as well or not. Defaults to false.

Returns:
Array.

The OGC layer names that are in range.

getOGCLayerNames(queryableOnly)

Returns the list of OGC layer names.

Parameters:
Name Type Default Description
queryableOnly boolean false

Whether to additionally check if the OGC layer is queryable as well or not. Defaults to false.

Returns:
Array.

The OGC layer names.

haveTheSameActiveDimensions(dataSource)

Parameters:
Name Type Description
dataSource !ngeox.datasource.OGC

Remote data source to compare with this one.

Implements:
Returns:
boolean

Whether the two data sources have the same active dimensions. If both have no dimensions, they are considered to be sharing the same dimensions.

isAnyOGCLayerInRange(res, queryableOnly)

Check if there's at least one OGC layer in range of a given resolution.

Parameters:
Name Type Default Description
res number

Resolution.

queryableOnly boolean false

Whether to additionally check if the OGC layer is queryable as well or not. Defaults to false.

Returns:
boolean

At least one OGC layer is in range.

setAttributes()