Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend for external layers

property

{string} name

property

{string} url

property

{string} title

Hierarchy

  • ngeoDatasourceOGC
    • default

Index

Constructors

constructor

  • A gmf.externalDatasource.OGC extends a ngeo.datasource.OGC and adds some properties that are proper to GMF and external dataSource only.

    Parameters

    Returns default

Properties

attributes

attributes: Attribute[]

The attributes of the data source.

Note: attributes is not using the conventionnal getter/setter due to: See: https://github.com/google/closure-compiler/issues/1089

dimensionsConfig

dimensionsConfig: Object

The dimensions configuration for the data source.

dimensionsFiltersConfig

dimensionsFiltersConfig: Object

The dimensions applied by filters configuration for the data source.

filterCondition_

filterCondition_: string

The filter condition to apply to the filter rules (if any).

filterRules

filterRules: default[]

A list of filter rules to apply to this data source using the filter condition.

filtrable

filtrable: boolean

Whether the data source is filtrable or not. When null, that means that we do not know if the data source if filtrable or not, yet. In that case, the value of the property needs to be determined from an external way.

inRange

inRange: boolean

A data source is considered 'in range' when it is synchronized to a map view and the resolution of that view is within the range of the maxResolution and minResolution. These 2 properties are required for the inRange property to be dynamic, otherwise its value is always true by default.

The synchronization is made in the import('ngeo/datasource/DataSource').DataSources service.

timeLowerValue

timeLowerValue: number

Time lower value.

timeUpperValue

timeUpperValue: number

Time upper value.

visible

visible: boolean

Whether the data source is visible or not, i.e. whether its is ON or OFF. Defaults to false.

wfsUrl_

wfsUrl_: string

The url to use for (WFS) requests.

Accessors

activeDimensions

  • get activeDimensions(): Object

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

dimensions

  • get dimensions(): Object
  • Returns Object

    Current dimensions to use for this data source

filterCondition

  • get filterCondition(): string
  • set filterCondition(filterCondition: string): void
  • Returns string

    Filter condition

  • Parameters

    • filterCondition: string

      Filter condition

    Returns void

    Filter condition

id

  • get id(): number

identifierAttribute

  • get identifierAttribute(): string

legend

maxResolution

  • get maxResolution(): number

minResolution

  • get minResolution(): number

name

  • get name(): string

ogcAttributesWFS

  • get ogcAttributesWFS(): Object
  • Returns the ogc attributes of only the WFS layers of this data source that are queryable.

    Returns Object

ogcAttributesWMS

  • get ogcAttributesWMS(): Object
  • Returns the ogc attributes of only the WMS layers of this data source that are queryable.

    Returns Object

ogcImageType

  • get ogcImageType(): string

ogcServerType

  • get ogcServerType(): string

ogcType

  • get ogcType(): string

queryIconPosition

  • get queryIconPosition(): number[]

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

snappable

  • get snappable(): boolean

snappingToEdges

  • get snappingToEdges(): boolean

snappingToVertice

  • get snappingToVertice(): boolean

snappingTolerance

  • get snappingTolerance(): number

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

timeProperty

timeRangeValue

wfsFeatureNS

  • get wfsFeatureNS(): string

wfsFeaturePrefix

  • get wfsFeaturePrefix(): string

wfsFormat

  • get wfsFormat(): WFS

wfsLayers

wfsOutputFormat

  • get wfsOutputFormat(): string

wfsUrl

  • get wfsUrl(): string

wmsFormat

  • get wmsFormat(): WMSGetFeatureInfo | default

wmsInfoFormat

  • get wmsInfoFormat(): string

wmsIsSingleTile

  • get wmsIsSingleTile(): boolean

wmsLayers

wmsUrl

  • get wmsUrl(): string

wmtsLayer

  • get wmtsLayer(): string

wmtsUrl

  • get wmtsUrl(): string

Methods

combinableWithDataSourceForWFS

  • combinableWithDataSourceForWFS(dataSource: OGC): 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: OGC): 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): string
  • Parameters

    • layer: string

    Returns string

    Geometry name

getAttributes

getCommonOGCAttributes_

  • getCommonOGCAttributes_(layerNames: string[]): Object
  • 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 Object

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: number, queryableOnly?: boolean): 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?: boolean): 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?: boolean): 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: OGC): 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: OGC): 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.

    export

    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.

isAnyOGCLayerInRange

  • isAnyOGCLayerInRange(res: number, queryableOnly?: boolean): 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

Generated using TypeDoc