Class SourceWFS

Hierarchy

VectorSource
- SourceWFS

Index

Constructors

Properties

_description _legends _metadata _originators _producer _quicklookUrl _thumbnail _title canRotate disposed loading name on once projection service un viewRejector viewResolver

Methods

addChangeListener addEventListener addFeature addFeatureInternal addFeatures addFeaturesInternal applyProperties changed clear dispatchEvent dispose disposeInternal forEachFeature forEachFeatureAtCoordinateDirect forEachFeatureInExtent forEachFeatureIntersectingExtent get getAttributions getAttributionsCollapsible getClosestFeatureToCoordinate getExtent getFeatureById getFeatureByUid getFeatures getFeaturesAtCoordinate getFeaturesCollection getFeaturesInExtent getFormat getInterpolate getKeys getListeners getOverlaps getProjection getProperties getPropertiesInternal getResolutions getRevision getState getUrl getView getWrapX hasFeature hasListener hasProperties isEmpty loadFeatures notify onceInternal onInternal ready refresh removeChangeListener removeEventListener removeFeature removeFeatureInternal removeFeatures removeLoadedExtent set setAttributions setLoader setOverlaps setProperties setState setUrl unInternal unset

Constructors

constructor

new SourceWFS(
    options: {
        apiKey?: string;
        configuration?: any;
        description?: string;
        layer: string;
        legends?: any[];
        maxFeatures?: number;
        metadata?: any[];
        olParams?: any;
        producer?: string;
        quicklookUrl?: string;
        ssl?: boolean;
        thumbnail?: string;
        title?: string;
    },
): SourceWFS
Parameters
- options: {
      apiKey?: string;
      configuration?: any;
      description?: string;
      layer: string;
      legends?: any[];
      maxFeatures?: number;
      metadata?: any[];
      olParams?: any;
      producer?: string;
      quicklookUrl?: string;
      ssl?: boolean;
      thumbnail?: string;
      title?: string;
  }
  options for function call.
  - OptionalapiKey?: string
    
    Access key to Geoportal platform
  - Optionalconfiguration?: any
    
    configuration (cf. example)
  - Optionaldescription?: string
    
    description of the layer
  - layer: string
    
    Layer name (e.g. "")
  - Optionallegends?: any[]
    
    Legends objects associated to the layer
  - OptionalmaxFeatures?: number
    
    maximum features (max: 5000)
  - Optionalmetadata?: any[]
    
    Metadata objects associated to the layer
  - OptionalolParams?: any
    
    other options for ol.source.Vector function (see ol.source.Vector)
  - Optionalproducer?: string
    
    producer of the layer
  - OptionalquicklookUrl?: string
    
    quicklookUrl of the layer
  - Optionalssl?: boolean
    
    if set true, enforce protocol https (only for nodejs)
  - Optionalthumbnail?: string
    
    thumbnail of the layer
  - Optionaltitle?: string
    
    title of the layer
Returns SourceWFS
Example
```
var sourceWFS = new ol.source.GeoportalWFS({
     layer: "",
     maxFeatures: 500,
     olParams: {}
});
```
Overrides VectorSource.constructor
- Defined in src/packages/Layers/SourceWFS.js:48

Properties

_description

_description: any

_legends

_legends: any

_metadata

_metadata: any

_originators

_originators: any

_producer

_producer: any

_quicklookUrl

_quicklookUrl: any

_thumbnail

_thumbnail: any

_title

_title: any

canRotate

canRotate: boolean

Rotation can be requested from the source.

`Protected`disposed

disposed: boolean

The object has already been disposed.

loading

loading: number | boolean

This source is currently loading data. Sources that defer loading to the map's tile queue never set this to a truthy value.

name

name: string

on

on: VectorSourceOnSignature<EventsKey, Feature<Geometry, { [x: string]: any }>>

once

once: VectorSourceOnSignature<
EventsKey,
Feature<Geometry, { [x: string]: any }>,
>

`Protected`projection

projection: Projection | null

service

service: string

un

un: VectorSourceOnSignature<void>

`Protected`viewRejector

viewRejector: ((arg0: Error) => void) | null

`Protected`viewResolver

viewResolver: ((arg0: ViewOptions) => void) | null

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from VectorSource.addChangeListener
- Defined in node_modules/ol/Object.d.ts:145

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from VectorSource.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

addFeature

addFeature(feature: Feature): void
Add a single feature to the source. If you want to add a batch of features at once, call module:ol/source/Vector~VectorSource#addFeatures #addFeatures() instead. A feature will not be added to the source if feature with the same id is already there. The reason for this behavior is to avoid feature duplication when using bbox or tile loading strategies. Note: this also applies if a module:ol/Collection~Collection is used for features, meaning that if a feature with a duplicate id is added in the collection, it will be removed from it right away.
Parameters
- feature: Feature
  Feature to add.
Returns void

Api
Inherited from VectorSource.addFeature
- Defined in node_modules/ol/source/Vector.d.ts:372

`Protected`addFeatureInternal

addFeatureInternal(feature: Feature): void
Protected
Add a feature without firing a change event.
Parameters
- feature: Feature
  Feature.
Returns void
Inherited from VectorSource.addFeatureInternal
- Defined in node_modules/ol/source/Vector.d.ts:378

addFeatures

addFeatures(features: Feature<Geometry, { [x: string]: any }>[]): void
Add a batch of features to the source.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features to add.
Returns void

Api
Inherited from VectorSource.addFeatures
- Defined in node_modules/ol/source/Vector.d.ts:398

`Protected`addFeaturesInternal

addFeaturesInternal(features: Feature<Geometry, { [x: string]: any }>[]): void
Protected
Add features without firing a change event.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features.
Returns void
Inherited from VectorSource.addFeaturesInternal
- Defined in node_modules/ol/source/Vector.d.ts:404

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from VectorSource.applyProperties
- Defined in node_modules/ol/Object.d.ts:172

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void

Api
Inherited from VectorSource.changed
- Defined in node_modules/ol/Observable.d.ts:74

clear

clear(fast?: boolean): void
Remove all features from the source.
Parameters
- Optionalfast: boolean
  Skip dispatching of module:ol/source/Vector.VectorSourceEvent#event:removefeature events.
Returns void

Api
Inherited from VectorSource.clear
- Defined in node_modules/ol/source/Vector.d.ts:415

dispatchEvent

dispatchEvent(event: string | BaseEvent): boolean | undefined
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.
Parameters
- event: string | BaseEvent
  Event object.
Returns boolean | undefined
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from VectorSource.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from VectorSource.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from VectorSource.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

forEachFeature

forEachFeature<T>(callback: (arg0: Feature) => T): T | undefined
Iterate through all features on the source, calling the provided callback with each one. If the callback returns any "truthy" value, iteration will stop and the function will return the same value. Note: this function only iterate through the feature that have a defined geometry.
Type Parameters
- T
Parameters
- callback: (arg0: Feature) => T
  Called with each feature on the source. Return a truthy value to stop iteration.
Returns T | undefined
The return value from the last call to the callback.

Api
Inherited from VectorSource.forEachFeature
- Defined in node_modules/ol/source/Vector.d.ts:428

forEachFeatureAtCoordinateDirect

forEachFeatureAtCoordinateDirect<T>(
coordinate: Coordinate,
callback: (arg0: Feature) => T,
): T | undefined
Iterate through all features whose geometries contain the provided coordinate, calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

For module:ol/render/Feature~RenderFeature features, the callback will be called for all features.
Type Parameters
- T
Parameters
- coordinate: Coordinate
  Coordinate.
- callback: (arg0: Feature) => T
  Called with each feature whose goemetry contains the provided coordinate.
Returns T | undefined
The return value from the last call to the callback.
Inherited from VectorSource.forEachFeatureAtCoordinateDirect
- Defined in node_modules/ol/source/Vector.d.ts:444

forEachFeatureInExtent

forEachFeatureInExtent<T>(
extent: Extent,
callback: (arg0: Feature) => T,
): T | undefined
Iterate through all features whose bounding box intersects the provided extent (note that the feature's geometry may not intersect the extent), calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you are interested in features whose geometry intersects an extent, call the module:ol/source/Vector~VectorSource#forEachFeatureIntersectingExtent #forEachFeatureIntersectingExtent() method instead.

When useSpatialIndex is set to false, this method will loop through all features, equivalent to module:ol/source/Vector~VectorSource#forEachFeature #forEachFeature().
Type Parameters
- T
Parameters
- extent: Extent
  Extent.
- callback: (arg0: Feature) => T
  Called with each feature whose bounding box intersects the provided extent.
Returns T | undefined
The return value from the last call to the callback.

Api
Inherited from VectorSource.forEachFeatureInExtent
- Defined in node_modules/ol/source/Vector.d.ts:464

forEachFeatureIntersectingExtent

forEachFeatureIntersectingExtent<T>(
extent: Extent,
callback: (arg0: Feature) => T,
): T | undefined
Iterate through all features whose geometry intersects the provided extent, calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you only want to test for bounding box intersection, call the module:ol/source/Vector~VectorSource#forEachFeatureInExtent #forEachFeatureInExtent() method instead.
Type Parameters
- T
Parameters
- extent: Extent
  Extent.
- callback: (arg0: Feature) => T
  Called with each feature whose geometry intersects the provided extent.
Returns T | undefined
The return value from the last call to the callback.

Api
Inherited from VectorSource.forEachFeatureIntersectingExtent
- Defined in node_modules/ol/source/Vector.d.ts:480

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from VectorSource.get
- Defined in node_modules/ol/Object.d.ts:114

getAttributions

getAttributions(): Attribution | null
Get the attribution function for the source.

Returns Attribution | null
Attribution function.

Api
Inherited from VectorSource.getAttributions
- Defined in node_modules/ol/source/Source.d.ts:155

getAttributionsCollapsible

getAttributionsCollapsible(): boolean
Returns boolean
Attributions are collapsible.

Api
Inherited from VectorSource.getAttributionsCollapsible
- Defined in node_modules/ol/source/Source.d.ts:160

getClosestFeatureToCoordinate

getClosestFeatureToCoordinate(
coordinate: Coordinate,
filter?: (arg0: Feature) => boolean,
): Feature<Geometry, { [x: string]: any }> | null
Get the closest feature to the provided coordinate.

This method is not available when the source is configured with useSpatialIndex set to false and the features in this source are of type module:ol/Feature~Feature.
Parameters
- coordinate: Coordinate
  Coordinate.
- Optionalfilter: (arg0: Feature) => boolean
  Feature filter function. The filter function will receive one argument, the module:ol/Feature~Feature feature and it should return a boolean value. By default, no filtering is made.
Returns Feature<Geometry, { [x: string]: any }> | null
Closest feature (or null if none found).

Api
Inherited from VectorSource.getClosestFeatureToCoordinate
- Defined in node_modules/ol/source/Vector.d.ts:531

getExtent

getExtent(extent?: Extent): Extent | null
Get the extent of the features currently in the source.

This will return null when the source is configured with useSpatialIndex set to false.
Parameters
- Optionalextent: Extent
  Destination extent. If provided, no new extent will be created. Instead, that extent's coordinates will be overwritten.
Returns Extent | null
Extent.

Api
Inherited from VectorSource.getExtent
- Defined in node_modules/ol/source/Vector.d.ts:542

getFeatureById

getFeatureById(
id: string | number,
): Feature<Geometry, { [x: string]: any }> | null
Get a feature by its identifier (the value returned by feature.getId()). When RenderFeatures are used, getFeatureById() can return an array of RenderFeatures. This allows for handling of GeometryCollection geometries, where format readers create one RenderFeature per GeometryCollection member. Note that the index treats string and numeric identifiers as the same. So source.getFeatureById(2) will return a feature with id '2' or 2.
Parameters
- id: string | number
  Feature identifier.
Returns Feature<Geometry, { [x: string]: any }> | null
The feature (or null if not found).

Api
Inherited from VectorSource.getFeatureById
- Defined in node_modules/ol/source/Vector.d.ts:555

getFeatureByUid

getFeatureByUid(uid: string): Feature<Geometry, { [x: string]: any }> | null
Get a feature by its internal unique identifier (using getUid).
Parameters
- uid: string
  Feature identifier.
Returns Feature<Geometry, { [x: string]: any }> | null
The feature (or null if not found).
Inherited from VectorSource.getFeatureByUid
- Defined in node_modules/ol/source/Vector.d.ts:562

getFeatures

getFeatures(): Feature<Geometry, { [x: string]: any }>[]
Get a snapshot of the features currently on the source in random order. The returned array is a copy, the features are references to the features in the source.

Returns Feature<Geometry, { [x: string]: any }>[]
Features.

Api
Inherited from VectorSource.getFeatures
- Defined in node_modules/ol/source/Vector.d.ts:495

getFeaturesAtCoordinate

getFeaturesAtCoordinate(
coordinate: Coordinate,
): Feature<Geometry, { [x: string]: any }>[]
Get all features whose geometry intersects the provided coordinate.
Parameters
- coordinate: Coordinate
  Coordinate.
Returns Feature<Geometry, { [x: string]: any }>[]
Features.

Api
Inherited from VectorSource.getFeaturesAtCoordinate
- Defined in node_modules/ol/source/Vector.d.ts:502

getFeaturesCollection

getFeaturesCollection(): | Collection<Feature<Geometry, { [x: string]: any }>>
| null
Get the features collection associated with this source. Will be null unless the source was configured with useSpatialIndex set to false, or with a module:ol/Collection~Collection as features.

Returns Collection<Feature<Geometry, { [x: string]: any }>> | null
The collection of features.

Api
Inherited from VectorSource.getFeaturesCollection
- Defined in node_modules/ol/source/Vector.d.ts:488

getFeaturesInExtent

getFeaturesInExtent(
extent: Extent,
projection?: Projection,
): Feature<Geometry, { [x: string]: any }>[]
Get all features whose bounding box intersects the provided extent. Note that this returns an array of all features intersecting the given extent in random order (so it may include features whose geometries do not intersect the extent).

When useSpatialIndex is set to false, this method will return all features.
Parameters
- extent: Extent
  Extent.
- Optionalprojection: Projection
  Include features where extent exceeds the x-axis bounds of projection and wraps around the world.
Returns Feature<Geometry, { [x: string]: any }>[]
Features.

Api
Inherited from VectorSource.getFeaturesInExtent
- Defined in node_modules/ol/source/Vector.d.ts:517

getFormat

getFormat(): FeatureFormat<Feature<Geometry, { [x: string]: any }>> | null
Get the format associated with this source.

Returns FeatureFormat<Feature<Geometry, { [x: string]: any }>> | null
} The feature format.

Api
Inherited from VectorSource.getFormat
- Defined in node_modules/ol/source/Vector.d.ts:569

getInterpolate

getInterpolate(): boolean
Returns boolean
Use linear interpolation when resampling.
Inherited from VectorSource.getInterpolate
- Defined in node_modules/ol/source/Source.d.ts:198

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from VectorSource.getKeys
- Defined in node_modules/ol/Object.d.ts:120

getListeners

getListeners(type: string): Listener[] | undefined
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Parameters
- type: string
  Type.
Returns Listener[] | undefined
Listeners.
Inherited from VectorSource.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getOverlaps

getOverlaps(): boolean
Returns boolean
The source can have overlapping geometries.
Inherited from VectorSource.getOverlaps
- Defined in node_modules/ol/source/Vector.d.ts:573

getProjection

getProjection(): Projection | null
Get the projection of the source.

Returns Projection | null
Projection.

Api
Inherited from VectorSource.getProjection
- Defined in node_modules/ol/source/Source.d.ts:166

getProperties

getProperties(): NoInfer<{ [x: string]: any }>
Get an object of all property names and values.

Returns NoInfer<{ [x: string]: any }>
Object.

Api
Inherited from VectorSource.getProperties
- Defined in node_modules/ol/Object.d.ts:126

getPropertiesInternal

getPropertiesInternal(): Partial<NoInfer<{ [x: string]: any }>> | null
Get an object of all property names and values.

Returns Partial<NoInfer<{ [x: string]: any }>> | null
Object.
Inherited from VectorSource.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:131

getResolutions

getResolutions(projection?: Projection): number[] | null
Parameters
- Optionalprojection: Projection
  Projection.
Returns number[] | null
Resolutions.
Inherited from VectorSource.getResolutions
- Defined in node_modules/ol/source/Source.d.ts:171

getRevision

getRevision(): number
Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns number
Revision.

Api
Inherited from VectorSource.getRevision
- Defined in node_modules/ol/Observable.d.ts:81

getState

getState(): State
Get the state of the source, see import("./Source.js").State for possible states.

Returns State
State.

Api
Inherited from VectorSource.getState
- Defined in node_modules/ol/source/Source.d.ts:190

getUrl

getUrl(): string | FeatureUrlFunction | undefined
Get the url associated with this source.

Returns string | FeatureUrlFunction | undefined
The url.

Api
Inherited from VectorSource.getUrl
- Defined in node_modules/ol/source/Vector.d.ts:580

getView

getView(): Promise<ViewOptions>
Returns Promise<ViewOptions>
A promise for view-related properties.
Inherited from VectorSource.getView
- Defined in node_modules/ol/source/Source.d.ts:175

getWrapX

getWrapX(): boolean | undefined
Returns boolean | undefined
Wrap X.
Inherited from VectorSource.getWrapX
- Defined in node_modules/ol/source/Source.d.ts:194

hasFeature

hasFeature(feature: Feature): boolean
Returns true if the feature is contained within the source.
Parameters
- feature: Feature
  Feature.
Returns boolean
Has feature.

Api
Inherited from VectorSource.hasFeature
- Defined in node_modules/ol/source/Vector.d.ts:592

hasListener

hasListener(type?: string): boolean
Parameters
- Optionaltype: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from VectorSource.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from VectorSource.hasProperties
- Defined in node_modules/ol/Object.d.ts:135

isEmpty

isEmpty(): boolean
Returns boolean
Is empty.
Inherited from VectorSource.isEmpty
- Defined in node_modules/ol/source/Vector.d.ts:596

loadFeatures

loadFeatures(extent: Extent, resolution: number, projection: Projection): void
Parameters
- extent: Extent
  Extent.
- resolution: number
  Resolution.
- projection: Projection
  Projection.
Returns void
Inherited from VectorSource.loadFeatures
- Defined in node_modules/ol/source/Vector.d.ts:602

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from VectorSource.notify
- Defined in node_modules/ol/Object.d.ts:140

`Protected`onceInternal

onceInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from VectorSource.onceInternal
- Defined in node_modules/ol/Observable.d.ts:95

`Protected`onInternal

onInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from VectorSource.onInternal
- Defined in node_modules/ol/Observable.d.ts:88

`Protected`ready

ready(): Promise<void>
Protected
Resolve once the source is ready to be used (its state is ready), or reject if it fails to load (its state is error). Sources that configure asynchronously can use this to expose data (e.g. dimensions) through a promise instead of the change event.

Returns Promise<void>
Resolves when the source is ready.
Inherited from VectorSource.ready
- Defined in node_modules/ol/source/Source.d.ts:184

refresh

refresh(): void
Refreshes the source. The source will be cleared, and data from the server will be reloaded.

Returns void

Api
Inherited from VectorSource.refresh
- Defined in node_modules/ol/source/Source.d.ts:203

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from VectorSource.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:150

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from VectorSource.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

removeFeature

removeFeature(feature: Feature): void
Remove a single feature from the source. If you want to batch remove features, use the module:ol/source/Vector~VectorSource#removeFeatures #removeFeatures() method instead.
Parameters
- feature: Feature
  Feature to remove.
Returns void

Api
Inherited from VectorSource.removeFeature
- Defined in node_modules/ol/source/Vector.d.ts:629

`Protected`removeFeatureInternal

removeFeatureInternal(feature: Feature): boolean
Protected
Remove feature without firing a change event.
Parameters
- feature: Feature
  Feature.
Returns boolean
True if the feature was removed, false if it was not found.
Inherited from VectorSource.removeFeatureInternal
- Defined in node_modules/ol/source/Vector.d.ts:636

removeFeatures

removeFeatures(features: Feature<Geometry, { [x: string]: any }>[]): void
Batch remove features from the source. If you want to remove all features at once, use the module:ol/source/Vector~VectorSource#clear #clear() method instead.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features to remove.
Returns void

Api
Inherited from VectorSource.removeFeatures
- Defined in node_modules/ol/source/Vector.d.ts:621

removeLoadedExtent

removeLoadedExtent(extent: Extent): void
Marks an extent as not loaded, preserving any loaded areas outside it.

Any previously loaded extent overlapping the given extent is split into its remaining non-overlapping parts using module:ol/extent~getDifference getDifference(), which are then re-inserted into the tree.
Parameters
- extent: Extent
  Extent to mark as not loaded.
Returns void

Api
Inherited from VectorSource.removeLoadedExtent
- Defined in node_modules/ol/source/Vector.d.ts:613

set

set(key: string, value: any, silent?: boolean): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from VectorSource.set
- Defined in node_modules/ol/Object.d.ts:158

setAttributions

setAttributions(attributions: AttributionLike | undefined): void
Set the attributions of the source.
Parameters
- attributions: AttributionLike | undefined
  Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.
Returns void

Api
Inherited from VectorSource.setAttributions
- Defined in node_modules/ol/source/Source.d.ts:211

setLoader

setLoader(loader: FeatureLoader<FeatureLike>): void
Set the new loader of the source. The next render cycle will use the new loader.
Parameters
- loader: FeatureLoader<FeatureLike>
  The loader to set.
Returns void

Api
Inherited from VectorSource.setLoader
- Defined in node_modules/ol/source/Vector.d.ts:650

setOverlaps

setOverlaps(overlaps: boolean): void
Parameters
- overlaps: boolean
  The source can have overlapping geometries.
Returns void
Inherited from VectorSource.setOverlaps
- Defined in node_modules/ol/source/Vector.d.ts:660

setProperties

setProperties(values: Partial<NoInfer<Properties>>, silent?: boolean): void
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Parameters
- values: Partial<NoInfer<Properties>>
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from VectorSource.setProperties
- Defined in node_modules/ol/Object.d.ts:166

setState

setState(state: State): void
Set the state of the source.
Parameters
- state: State
  State.
Returns void
Inherited from VectorSource.setState
- Defined in node_modules/ol/source/Source.d.ts:216

setUrl

setUrl(url: string | FeatureUrlFunction): void
Points the source to a new url. The next render cycle will use the new url.
Parameters
- url: string | FeatureUrlFunction
  Url.
Returns void

Api
Inherited from VectorSource.setUrl
- Defined in node_modules/ol/source/Vector.d.ts:656

`Protected`unInternal

unInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns void
Inherited from VectorSource.unInternal
- Defined in node_modules/ol/Observable.d.ts:102

unset

unset(key: string, silent?: boolean): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optionalsilent: boolean
  Unset without triggering an event.
Returns void

Api
Inherited from VectorSource.unset
- Defined in node_modules/ol/Object.d.ts:179

Class SourceWFS

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalapiKey?: string

Optionalconfiguration?: any

Optionaldescription?: string

layer: string

Optionallegends?: any[]

OptionalmaxFeatures?: number

Optionalmetadata?: any[]

OptionalolParams?: any

Optionalproducer?: string

OptionalquicklookUrl?: string

Optionalssl?: boolean

Optionalthumbnail?: string

Optionaltitle?: string

Returns SourceWFS

Example

Properties

_description

_legends

_metadata

_originators

_producer

_quicklookUrl

_thumbnail

_title

canRotate

Protecteddisposed

loading

name

on

once

Protectedprojection

service

un

ProtectedviewRejector

ProtectedviewResolver

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

addFeature

Parameters

Returns void

Api

ProtectedaddFeatureInternal

Parameters

Returns void

addFeatures

Parameters

Returns void

Api

ProtectedaddFeaturesInternal

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

clear

Parameters

Returns void

Api

dispatchEvent

Parameters

Returns boolean | undefined

Api

dispose

`Optional`apiKey?: string

`Optional`configuration?: any

`Optional`description?: string

`Optional`legends?: any[]

`Optional`maxFeatures?: number

`Optional`metadata?: any[]

`Optional`olParams?: any

`Optional`producer?: string

`Optional`quicklookUrl?: string

`Optional`ssl?: boolean

`Optional`thumbnail?: string

`Optional`title?: string

`Protected`disposed

`Protected`projection

`Protected`viewRejector

`Protected`viewResolver

`Protected`addFeatureInternal

`Protected`addFeaturesInternal

`Protected`applyProperties

`Protected`disposeInternal