Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GmfExternalDatasourceOGC

Legend for external layers

property

{string} name

property

{string} url

property

{string} title

Hierarchy

  • OGC
    • GmfExternalDatasourceOGC

Index

Constructors

Accessors

Methods

Constructors

constructor

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
    override

    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
    override

    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

  • get legend(): 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
  • override

    Returns boolean

    Whether the data source supports making WFS requests or not.

supportsWMS

  • get supportsWMS(): boolean
  • override

    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

  • get timeProperty(): TimeProperty

timeRangeValue

  • get timeRangeValue(): TimeRange
  • set timeRangeValue(range: TimeRange): void

  • Returns TimeRange

    Time range value

  • Parameters

    • range: TimeRange

      Time range value

    Returns void

    Time range value

wfsFeatureNS

  • get wfsFeatureNS(): string

wfsFeaturePrefix

  • get wfsFeaturePrefix(): string

wfsFormat

  • get wfsFormat(): WFS

wfsLayers

  • get wfsLayers(): WFSLayer[]

wfsOutputFormat

  • get wfsOutputFormat(): string

wfsUrl

  • get wfsUrl(): string

wmsFormat

wmsInfoFormat

  • get wmsInfoFormat(): string

wmsIsSingleTile

  • get wmsIsSingleTile(): boolean

wmsLayers

  • get wmsLayers(): WMSLayer[]

wmsUrl

  • get wmsUrl(): string

wmtsLayer

  • get wmtsLayer(): string

wmtsUrl

  • get wmtsUrl(): string

Methods

combinableWithDataSourceForWFS

  • combinableWithDataSourceForWFS(dataSource: OGC): boolean
  • override

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

    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

      The layer name.

    Returns string

    Geometry name

getAttributes

  • getAttributes(): Attribute[]

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.

    • Default value 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

    • Default value 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

    • Default value 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
  • override

    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
    override

    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.

    • Default value 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: Attribute[]): void

  • Parameters

    • attributes: Attribute[]

      Attributes

    Returns void

Generated using TypeDoc