Class default

Legend for external layers

Hierarchy

  • GmfDatasourceOGC
    • default

Constructors

constructor

Properties

attributes dimensionsConfig dimensionsFiltersConfig filterCondition_ filterRules filtrable inRange timeLowerValue timeUpperValue visible wfsUrl_

Accessors

activeDimensions combinableForWFS combinableForWMS copyable dimensions filterCondition gmfLayer id identifierAttribute legend maxResolution minResolution name ogcAttributesWFS ogcAttributesWMS ogcImageType ogcServerType ogcType queryable queryIconPosition snappable snappingToEdges snappingTolerance snappingToVertice supportsAttributes supportsDynamicInRange supportsWFS supportsWMS supportsWMTS timeAttributeName timeProperty timeRangeValue wfsFeatureNS wfsFeaturePrefix wfsFormat wfsLayers wfsOutputFormat wfsUrl wmsFormat wmsInfoFormat wmsIsSingleTile wmsLayers wmsUrl wmtsLayer wmtsUrl

Methods

combinableWithDataSourceForWFS combinableWithDataSourceForWMS geometryName getAttributes getCommonOGCAttributes_ getFiltrableWFSLayerName getInRangeWFSLayerNames getWFSLayerNames getWMSLayerNames haveTheSameActiveDimensions haveTheSameActiveDimensionsFilters isAnyOGCLayerInRange setAttributes

Constructors

constructor

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: {}

The dimensions configuration for the data source.

dimensionsFiltersConfig

dimensionsFiltersConfig: {}

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: Rule[]

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(): {}

  • 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

dimensions

  • get dimensions(): {}

  • Returns {}

    Current dimensions to use for this data source

filterCondition

  • get filterCondition(): string

  • Returns string

    Filter condition

  • set filterCondition(filterCondition: string): void

  • Parameters

    • filterCondition: string

      Filter condition

    Returns void

gmfLayer

id

identifierAttribute

  • get identifierAttribute(): string

  • Returns string

    Identifier attribute

legend

maxResolution

minResolution

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

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

timeRangeValue

wfsFeatureNS

  • get wfsFeatureNS(): string

  • Returns string

    WFS feature namespace

wfsFeaturePrefix

  • get wfsFeaturePrefix(): string

  • Returns string

    WFS feature prefix

wfsFormat

wfsLayers

wfsOutputFormat

  • get wfsOutputFormat(): string

  • Returns string

    WFS output format

wfsUrl

wmsFormat

wmsInfoFormat

  • get wmsInfoFormat(): string

  • Returns string

    WMS info format

wmsIsSingleTile

  • get wmsIsSingleTile(): boolean

  • Returns boolean

    WMS is single tile

wmsLayers

wmsUrl

wmtsLayer

  • get wmtsLayer(): string

  • Returns string

    WMTS layer

wmtsUrl

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

    • Optionallayer: string

      The layer name.

    Returns string

    Geometry name

getAttributes

getCommonOGCAttributes_

  • getCommonOGCAttributes_(layerNames: string[]): {}

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

    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: 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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods