Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WFSFeatureStoreConstructorOptions

Constructor options for WFSFeatureStore.

Hierarchy

Overview

Properties

Optional codec

codec: Codec

The Codec which will be used to convert the server response to LuciadRIA feature instances. If omitted, the codec is derived from the outputFormat or defaulted to GeoJsonCodec if outputFormat is not set. Replace the codec if you want to support another format. The codec must support only the decode() method as this is a read-only Store implementation.

Optional credentials

credentials: boolean

Whether credentials should be included with every HTTP request.

Optional geometryName

geometryName: string

A geometry property name that is used in the BBOX OGC filter when querying WFS service. The spatial filter can contain an optional geometry property name, which refers to the property that should be used to retrieve a feature's geometry. Default: null

Optional methods

methods: string[]

An array HTTP methods that can be used to communicate with the server. The store supports GET and POST. Default: ["GET","POST"]

Optional outputFormat

outputFormat: string

Configures the outputFormat parameter on the request. For HTTP GET requests, the default outputFormat parameter is JSON, for HTTP POST requests, the default is application/json. Use this parameter if the server expects a different outputFormat parameter to respond with GeoJSON encoded data or if you want to support another format. Note that the outputFormat is also used to derive the Codec. Default: ["1.1.0","1.0.0"]

reference

The reference in which the data corresponding to the specified type name is defined. This should match the reference of the FeatureModel on which this Store is used. This reference will be passed to the Codec#decode method so it can set the correct reference on the Features.

Optional requestHeaders

requestHeaders: {} | null

An object literal that represents headers (as a key-value map) to send with each HTTP request. If set (and not empty), an XHR with the specified headers will be performed instead of creating an Image.

Optional requestParameters

requestParameters: {} | null

An object literal that represents the request parameters (as a key-value map) to send with each HTTP request. If set and not empty, the parameters will be added to the HTTP requests.

since

2021.0

serviceURL

serviceURL: string

The location of the WFS service endpoint.

Optional swapAxes

swapAxes: string[]

Indicates whether this Store should swap the axis ordering of coordinates for the specified reference identifier(s) in the OGC BBOX filter when querying the WFS service. If undefined, the axis ordering dictated by the model reference is respected. For each specified reference, the order will be reversed. This is for example needed for EPSG:4326 data that is encoded in longitude-latitude order instead of latitude-longitude.

typeName

typeName: string | QName

The name of the feature type this query will be requesting from the server. The type name should be specified as either a string or a QName object. A QName object is a JavaScript object that contains three string properties: prefix, namespace, localPart.

Optional versions

versions: string[]

An array of versions strings that the server supports. The WFSFeatureStore will select the most appropriate version to communicate with the server. An Error will be thrown if no supported versions are available.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method