Class VectorSource

An image source that reads vector data. Internally, this wraps an OpenLayers' VectorSource. This uses OpenLayers' styles and features.

Note: to assign a new style to the source, use setStyle instead of the style property.

Example

// To load a remote GeoJSON file
const source = new VectorSource({
     data: 'http://example.com/data.geojson',
     format: new GeoJSON(), // Pass the OpenLayers FeatureFormat here
     style: new Style(...), // Pass an OpenLayers style here
});

// To load a local GeoJSON
const source = new VectorSource({
     data: { "type": "FeatureCollection" ... },
     format: new GeoJSON(), // Pass the OpenLayers FeatureFormat here
     style: new Style(...), // Pass an OpenLayers style here
});

// To load features directly (no need to pass a format as the features are already decoded.)
const source = new VectorSource({
     data: [new Feature(...)], // Pass the OpenLayers features here
     style: new Style(...), // Pass an OpenLayers style here
});

Hierarchy (view full)

ImageSource
- VectorSource

Constructors

constructor

new VectorSource(options): VectorSource
Parameters
- options: VectorSourceOptions
  Options.
Returns VectorSource
Overrides ImageSource.constructor
- Defined in sources/VectorSource.ts:200

Properties

`Readonly`containsFn

containsFn: undefined | CustomContainsFn

`Readonly`data

data: DataSource

`Readonly`dataProjection

dataProjection: undefined | string

datatype

datatype: TextureDataType

Gets the datatype of images generated by this source.

`Readonly`flipY

flipY: boolean

Gets whether images generated from this source should be flipped vertically.

`Readonly`isImageSource

isImageSource: boolean = true

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isVectorSource

isVectorSource: true = ...

`Readonly`source

source: external.olsource.Vector<Feature<Geometry>>

`Optional`style

style?: Style | Style[] | StyleFunction

The current style. Note: to set a new style, use setStyle() instead.

`Readonly`synchronous

synchronous: boolean = false

If true, this source can immediately generate images without any delay.

`Readonly`type

type: "VectorSource" = ...

Accessors

colorSpace

get colorSpace(): ColorSpace
Gets the color space of the textures generated by this source.

Returns ColorSpace
Inherited from ImageSource.colorSpace
- Defined in sources/ImageSource.ts:170

featureCount

get featureCount(): number
Returns number
- Defined in sources/VectorSource.ts:284

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, VectorSource>
  The function that gets called when the event is fired.
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, VectorSource>
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

addFeature

addFeature(feature): void
Adds a feature to this source.
Parameters
- feature: Feature<Geometry>
  The feature to add.
Returns void
- Defined in sources/VectorSource.ts:301

addFeatures

addFeatures(features): void
Adds features to this source.
Parameters
- features: Feature<Geometry>[]
  The features to add.
Returns void
- Defined in sources/VectorSource.ts:311

adjustExtentAndPixelSize

adjustExtentAndPixelSize(requestExtent, requestWidth, requestHeight, margin?): null | {
    extent: Extent;
    height: number;
    width: number;
}
Returns an adjusted extent, width and height so that request pixels are aligned with source pixels, and requests do not oversample the source.
Parameters
- requestExtent: Extent
  The request extent.
- requestWidth: number
  The width, in pixels, of the request extent.
- requestHeight: number
  The height, in pixels, of the request extent.
- margin: number = 0
  The margin, in pixels, around the initial extent.
Returns null | {
    extent: Extent;
    height: number;
    width: number;
}
The adjusted parameters.
Inherited from ImageSource.adjustExtentAndPixelSize
- Defined in sources/ImageSource.ts:192

clear

clear(): void
Removes all feature in this source.

Returns void
- Defined in sources/VectorSource.ts:330

contains

contains(extent): boolean
Gets whether this source contains the specified extent. If a custom contains function is provided, it will be used. Otherwise, intersects is used.

This method is mainly used to discard non-relevant requests (i.e don't process regions that are not relevant to this source).
Parameters
- extent: Extent
  The extent to test.
Returns boolean
Inherited from ImageSource.contains
- Defined in sources/ImageSource.ts:236

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "updated"
Parameters
- event: BaseEvent<T> & ImageSourceEvents[T]
  The event that gets fired.
Returns void
Inherited from ImageSource.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Disposes unmanaged resources of this source.

Returns void
Inherited from ImageSource.dispose
- Defined in sources/ImageSource.ts:291

forEachFeature

forEachFeature(callback): void
Applies the callback for each feature in this source.
Parameters
- callback: ((arg0: Feature<Geometry>) => unknown)
  The callback.
  - - (arg0): unknown
    - Parameters
      arg0: Feature<Geometry>
      Returns unknown
Returns void
- Defined in sources/VectorSource.ts:381

getCrs

getCrs(): string
Returns the CRS of this source.

Returns string
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/VectorSource.ts:385

getCurrentExtent

getCurrentExtent(): null | Extent
Returns null | Extent
- Defined in sources/VectorSource.ts:396

getExtent

getExtent(): Extent
Returns the extent of this source expressed in the CRS of the source.

Returns Extent
The extent of the source.
Overrides ImageSource.getExtent
- Defined in sources/VectorSource.ts:392

getFeatureById

getFeatureById(id): null | Feature<Geometry>
Returns the feature with the specified id.
Parameters
- id: string | number
  The feature id.
Returns null | Feature<Geometry>
The feature.
- Defined in sources/VectorSource.ts:372

getFeatures

getFeatures(): Feature<Geometry>[]
Returns an array with the feature in this source.

Returns Feature<Geometry>[]
The features.
- Defined in sources/VectorSource.ts:293

getImages

getImages(options): {
id: string;
request: (() => ImageResult);
}[]
Gets the images for the specified extent and pixel size.
Parameters
- options: GetImageOptions
  The options.
Returns {
id: string;
request: (() => ImageResult);
}[]
An array containing the functions to generate the images asynchronously.
Overrides ImageSource.getImages
- Defined in sources/VectorSource.ts:485

getMemoryUsage

getMemoryUsage(_context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- _context: GetMemoryUsageContext
Returns void
Inherited from ImageSource.getMemoryUsage
- Defined in sources/ImageSource.ts:163

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, VectorSource>
  The function that gets called when the event is fired.
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, VectorSource>
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

initialize

initialize(opts): Promise<void>
Initializes the source.
Parameters
- opts: {
  targetProjection: string;
  }
  - targetProjection: string
Returns Promise<void>
A promise that resolves when the source is initialized.
Overrides ImageSource.initialize
- Defined in sources/VectorSource.ts:258

intersects

intersects(extent): boolean
Test the intersection between the specified extent and this source's extent. This method may be overriden to perform special logic.
Parameters
- extent: Extent
  The extent to test.
Returns boolean
true if the extent and this source extent intersects, false otherwise.
Overrides ImageSource.intersects
- Defined in sources/VectorSource.ts:469

loadFeatures

loadFeatures(): Promise<void>
Loads the features from this source, either from:
- the URL
- the data string (for example a GeoJSON string)
- the features array
Returns Promise<void>
- Defined in sources/VectorSource.ts:234

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<ImageSourceEvents[T], T, VectorSource>
  The listener function that gets removed.
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, VectorSource>
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

removeFeature

removeFeature(feature): void
Removes a feature from this source.
Parameters
- feature: Feature<Geometry>
  The feature to remove.
Returns void
- Defined in sources/VectorSource.ts:321

reproject

reproject(feature): void
Reprojects a feature from the source projection into the target (instance) projection.
Parameters
- feature: Feature<Geometry>
  The feature to reproject.
Returns void
- Defined in sources/VectorSource.ts:254

setStyle

setStyle(style): void
Change the style of this source. This triggers an update of the source.
Parameters
- style: Style | StyleFunction
  The style, or style function.
Returns void
- Defined in sources/VectorSource.ts:219

update

update(extent?): void
Raises an event to reload the source.
Parameters
- Optionalextent: Extent
Returns void
Inherited from ImageSource.update
- Defined in sources/ImageSource.ts:222

updateFeature

updateFeature(...feature): void
Updates the region associated with the feature(s).
Parameters
- Rest...feature: Feature<Geometry>[]
  The feature(s) to update.
Returns void
- Defined in sources/VectorSource.ts:339

Class VectorSource

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VectorSource

Properties

ReadonlycontainsFn

Readonlydata

ReadonlydataProjection

datatype

ReadonlyflipY

ReadonlyisImageSource

ReadonlyisMemoryUsage

ReadonlyisVectorSource

Readonlysource

Optionalstyle

Readonlysynchronous

Readonlytype

Accessors

colorSpace

Returns ColorSpace

featureCount

Returns number

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

addFeature

Parameters

Returns void

addFeatures

Parameters

Returns void

adjustExtentAndPixelSize

Parameters

Returns null | { extent: Extent; height: number; width: number; }

clear

Returns void

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

forEachFeature

Parameters

Parameters

Returns unknown

Returns void

getCrs

Returns string

getCurrentExtent

Returns null | Extent

getExtent

Returns Extent

getFeatureById

Parameters

Returns null | Feature<Geometry>

getFeatures

Returns Feature<Geometry>[]

getImages

Parameters

Returns { id: string; request: (() => ImageResult); }[]

getMemoryUsage

Parameters

Returns void

`Readonly`containsFn

`Readonly`data

`Readonly`dataProjection

`Readonly`flipY

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`isVectorSource

`Readonly`source

`Optional`style

`Readonly`synchronous

`Readonly`type

Returns null | {
extent: Extent;
height: number;
width: number;
}

Returns {
id: string;
request: (() => ImageResult);
}[]