Class WfsClient<WfsXmlTypes>

Type Parameters

WfsXmlTypes = XmlTypes

Hierarchy (View Summary)

WfsClient

Index

Constructors

Properties

featureNS featureNsWithPrefix featurePrefix maxFeatures ogcServer version

Methods

completeGetFeatureOptions describeFeatureType getDescribeFeatureTypeUrl getElementToTypeName getFeature getFeatureOptionsFromSelectionParam getFeatureRaw getServerWfs manageLayerAttribute validateLayerAttributeType

Constructors

constructor

new WfsClient<WfsXmlTypes = string>(
    ogcServer: ServerOgc,
    options: WfsClientOptions,
    context: IGirafeContext,
): WfsClient<WfsXmlTypes>
Type Parameters
- WfsXmlTypes = string
Parameters
- ogcServer: ServerOgc
- options: WfsClientOptions
- context: IGirafeContext
Returns WfsClient<WfsXmlTypes>
- Defined in src/tools/wfs/wfsclient.ts:42

Properties

`Protected`featureNS

featureNS: string

`Protected`featureNsWithPrefix

featureNsWithPrefix: Record<string, string> = {}

`Protected`featurePrefix

featurePrefix: string

`Protected`maxFeatures

maxFeatures: number

`Protected`ogcServer

ogcServer: ServerOgc

`Protected`version

version: string = '1.1.0'

Methods

`Protected`completeGetFeatureOptions

completeGetFeatureOptions(
options: GetFeatureOptionsPartial,
): Promise<WriteGetFeatureOptions[]>
Creates a WriteGetFeatureOptions object by expanding the provided partial options. Required for a ol GetFeature WFS request.
Parameters
- options: GetFeatureOptionsPartial
Returns Promise<WriteGetFeatureOptions[]>
- Defined in src/tools/wfs/wfsclient.ts:296

`Protected`describeFeatureType

describeFeatureType(): Promise<ServerWfs<WfsXmlTypes>>
Returns Promise<ServerWfs<WfsXmlTypes>>
- Defined in src/tools/wfs/wfsclient.ts:74

`Protected`getDescribeFeatureTypeUrl

getDescribeFeatureTypeUrl(): string
Returns string
- Defined in src/tools/wfs/wfsclient.ts:196

`Protected`getElementToTypeName

getElementToTypeName(xml: Document): Record<string, string>
Parameters
- xml: Document
Returns Record<string, string>
- Defined in src/tools/wfs/wfsclient.ts:175

getFeature

getFeature(options: SelectionParam): Promise<Feature<Geometry>[]>
Gets features from a WFS server. Configure the request by providing a GeoGirafe SelectionParam or an ol GetFeatureOptions object.
Parameters
- options: SelectionParam
Returns Promise<Feature<Geometry>[]>
- Defined in src/tools/wfs/wfsclient.ts:209
getFeature(options: GetFeatureOptionsPartial): Promise<Feature<Geometry>[]>
Gets features from a WFS server. Configure the request by providing a GeoGirafe SelectionParam or an ol GetFeatureOptions object.
Parameters
- options: GetFeatureOptionsPartial
Returns Promise<Feature<Geometry>[]>
- Defined in src/tools/wfs/wfsclient.ts:210

`Protected`getFeatureOptionsFromSelectionParam

getFeatureOptionsFromSelectionParam(
selectionParam: SelectionParam,
): GetFeatureOptionsPartial | null
Transforms a SelectionParam object, originating from a map selection, into a GetFeatureOptionsPartial object, needed for performing the WFS GetFeature request.
Parameters
- selectionParam: SelectionParam
Returns GetFeatureOptionsPartial | null
- Defined in src/tools/wfs/wfsclient.ts:236

`Protected`getFeatureRaw

getFeatureRaw(
getFeatureOptions: WriteGetFeatureOptions,
): Promise<Feature<Geometry>[]>
Sends a GetFeature request to a WFS endpoint based on provided options and parses the received GML answer.
Parameters
- getFeatureOptions: WriteGetFeatureOptions
Returns Promise<Feature<Geometry>[]>
- Defined in src/tools/wfs/wfsclient.ts:323

getServerWfs

getServerWfs(): Promise<ServerWfs<WfsXmlTypes>>
Returns Promise<ServerWfs<WfsXmlTypes>>
- Defined in src/tools/wfs/wfsclient.ts:70

`Protected`manageLayerAttribute

manageLayerAttribute(
    serverWfs: ServerWfs<WfsXmlTypes>,
    element: Element,
    featureType: string,
): boolean
Parameters
- serverWfs: ServerWfs<WfsXmlTypes>
- element: Element
- featureType: string
Returns boolean
- Defined in src/tools/wfs/wfsclient.ts:137

`Protected`validateLayerAttributeType

validateLayerAttributeType(type: string): boolean
Parameters
- type: string
Returns boolean
- Defined in src/tools/wfs/wfsclient.ts:171