Class default

attributes

dimensionsConfig

dimensionsFiltersConfig

filterCondition_

filterRules

filtrable

inRange

timeLowerValue

timeUpperValue

visible

wfsUrl_

activeDimensions

• get activeDimensions(): {}

• Returns {}

  Active dimensions

combinableForWFS

• get combinableForWFS(): boolean

• A data source can't be combined to other data source to issue a single WFS request if:

  • it has filter rules set
  • it has time range set

  Returns boolean

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

combinableForWMS

• get combinableForWMS(): boolean

• A data source can't be combined to other data source to issue a single WMS request if:

  • it has filter rules set
  • it has time range set

  Returns boolean

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

copyable

• get copyable(): boolean

• Returns boolean

  Copyable

dimensions

• get dimensions(): {}

• Returns {}

  Current dimensions to use for this data source

filterCondition

• get filterCondition(): string

• Returns string

  Filter condition
• set filterCondition(filterCondition): void

• Parameters

  • filterCondition: string

    Filter condition

  Returns void

gmfLayer

• get gmfLayer(): GmfLayer

• Returns GmfLayer

  GMF layer

id

• get id(): number

• Returns number

  Id

identifierAttribute

• get identifierAttribute(): string

• Returns string

  Identifier attribute

maxResolution

• get maxResolution(): number

• Returns number

  Maximum resolution

minResolution

• get minResolution(): number

• Returns number

  Minimum resolution

name

• get name(): string

• Returns string

  Name

ogcAttributesWFS

• get ogcAttributesWFS(): {}

• Returns the ogc attributes of only the WFS layers of this data source that are queryable.

  Returns {}

ogcAttributesWMS

• get ogcAttributesWMS(): {}

• Returns the ogc attributes of only the WMS layers of this data source that are queryable.

  Returns {}

ogcImageType

• get ogcImageType(): string

• Returns string

  OGC image type

ogcServerType

• get ogcServerType(): string

• Returns string

  OGC server type

ogcType

• get ogcType(): string

• Returns string

  OGC type

queryable

• get queryable(): boolean

• 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.

  Returns boolean

queryIconPosition

• get queryIconPosition(): number[]

• Returns number[]

  The queryIconPosition

snappable

• get snappable(): boolean

• Returns boolean

  Snappable

snappingToEdges

• get snappingToEdges(): boolean

• Returns boolean

  Snapping to edges

snappingTolerance

• get snappingTolerance(): number

• Returns number

  Snapping tolerance

snappingToVertice

• get snappingToVertice(): boolean

• Returns boolean

  Snapping to vertices

supportsAttributes

• get supportsAttributes(): boolean

• 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.

  Returns boolean

  Supports attributes.

supportsDynamicInRange

• get supportsDynamicInRange(): boolean

• Returns boolean

  Whether the data source supports a dynamic inRange property or not, i.e. whether it can be calculated.

supportsWFS

• get supportsWFS(): boolean

• Returns boolean

  Whether the data source supports making WFS requests or not.

supportsWMS

• get supportsWMS(): boolean

• Returns boolean

  Whether the data source supports making WMS requests or not.

supportsWMTS

• get supportsWMTS(): boolean

• Returns boolean

  Whether the data source supports making WTMS requests or not.

timeAttributeName

• get timeAttributeName(): string

• Returns string

  Time attribute name

timeProperty

• get timeProperty(): TimeProperty

• Returns TimeProperty

  Time property

timeRangeValue

• get timeRangeValue(): TimeRange

• Returns TimeRange

  Time range value
• set timeRangeValue(range): void

• Parameters

  • range: TimeRange

    Time range value

  Returns void

wfsFeatureNS

• get wfsFeatureNS(): string

• Returns string

  WFS feature namespace

wfsFeaturePrefix

• get wfsFeaturePrefix(): string

• Returns string

  WFS feature prefix

wfsFormat

• get wfsFormat(): WFS

• Returns WFS

  WFS format.

wfsLayers

• get wfsLayers(): WFSLayer[]

• Returns WFSLayer[]

  WFS layers

wfsOutputFormat

• get wfsOutputFormat(): string

• Returns string

  WFS output format

wfsUrl

• get wfsUrl(): string

• Returns string

  WFS url

wmsFormat

• get wmsFormat(): default | WMSGetFeatureInfo

• Returns default | WMSGetFeatureInfo

  WMS format.

wmsInfoFormat

• get wmsInfoFormat(): string

• Returns string

  WMS info format

wmsIsSingleTile

• get wmsIsSingleTile(): boolean

• Returns boolean

  WMS is single tile

wmsLayers

• get wmsLayers(): WMSLayer[]

• Returns WMSLayer[]

  WMS layers

wmsUrl

• get wmsUrl(): string

• Returns string

  WMS url

wmtsLayer

• get wmtsLayer(): string

• Returns string

  WMTS layer

wmtsUrl

• get wmtsUrl(): string

• Returns string

  WMTS url

combinableWithDataSourceForWFS

• combinableWithDataSourceForWFS(dataSource): boolean

• Parameters

  • dataSource: OGC

    Data source.

  Returns boolean

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

combinableWithDataSourceForWMS

• combinableWithDataSourceForWMS(dataSource): boolean

• Parameters

  • dataSource: OGC

    Data source.

  Returns boolean

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

geometryName

• geometryName(layer?): string

• Parameters

  • Optionallayer: string

    The layer name.

  Returns string

  Geometry name

getAttributes

• getAttributes(): Attribute[]

• Returns Attribute[]

  Attributes

getCommonOGCAttributes_

• getCommonOGCAttributes_(layerNames): {}

• Collect the ogc attributes that are shared among the given layers, i.e. only the attributes that are in all the given layers are returned.

  Among the attributes, geometry columns are returned as well. Therefore, if there are no attributes with a geometry name returned, then the Filter tool have the possibilily to filter the data source using spatial filters.

  Parameters

  • layerNames: string[]

    List of layer names

  Returns {}

getFiltrableWFSLayerName

• getFiltrableWFSLayerName(): string

• Returns the filtrable WFS layer name.

  Although a data source may contain multiple WFS wfs layers, only the first one is returned. We don't need to return more than one, since in that case a group is used in the WMS GetMap query, and each queryable layers will end up being used in WFS GetData queries sent.

  Returns string

  WFS layer name.

getInRangeWFSLayerNames

• getInRangeWFSLayerNames(res, queryableOnly?): string[]

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

  Parameters

  • res: number

    Resolution.
  • queryableOnly: boolean = false

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

  Returns string[]

  The WFS layer names that are in range.

getWFSLayerNames

• getWFSLayerNames(queryableOnly?): string[]

• Returns the list of WFS layer names.

  Parameters

  • queryableOnly: boolean = false

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

  Returns string[]

  The WFS layer names.

getWMSLayerNames

• getWMSLayerNames(queryableOnly?): string[]

• Returns the list of WMS layer names.

  Parameters

  • queryableOnly: boolean = false

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

  Returns string[]

  The WMS layer names.

haveTheSameActiveDimensions

• haveTheSameActiveDimensions(dataSource): boolean

• Parameters

  • dataSource: OGC

    Remote data source to compare with this one.

  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.

haveTheSameActiveDimensionsFilters

• haveTheSameActiveDimensionsFilters(dataSource): boolean

• Compare active dimensions filters of two data sources. As OpenLayers WFS format does not allow constructing multiple typenames GetFeature request with different filters we need to combine data sources depending on active dimensions filters.

  Parameters

  • dataSource: OGC

    Remote data source to compare with this one.

  Returns boolean

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

  Export

isAnyOGCLayerInRange

• isAnyOGCLayerInRange(res, queryableOnly?): boolean

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

  Parameters

  • 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

• setAttributes(attributes): void

• Parameters

  • attributes: Attribute[]

    Attributes

  Returns void