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 Summary)

ImageSource
- VectorSource

Constructors

constructor

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

Properties

`Readonly`containsFn

containsFn: CustomContainsFn | undefined

`Readonly`data

data: DataSource

`Readonly`dataProjection

dataProjection: CoordinateSystem | undefined

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 = ...

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isVectorSource

isVectorSource: true = ...

`Readonly`priority

priority: RequestPriority = 'auto'

`Readonly`source

source: VectorSource

`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`transparent

transparent: boolean

`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:201

featureCount

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

Methods

addFeature

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

addFeatures

addFeatures(features: Feature<Geometry, { [x: string]: any }>[]): void
Adds features to this source.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  The features to add.
Returns void
- Defined in sources/VectorSource.ts:321

adjustExtentAndPixelSize

adjustExtentAndPixelSize(
    requestExtent: Extent,
    requestWidth: number,
    requestHeight: number,
    margin?: number,
): GridExtent | null
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 GridExtent | null
The adjusted parameters.
Inherited from ImageSource.adjustExtentAndPixelSize
- Defined in sources/ImageSource.ts:223

clear

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

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

contains

contains(extent: 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:267

dispose

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

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

forEachFeature

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

getCrs

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

Returns CoordinateSystem
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/VectorSource.ts:395

getCurrentExtent

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

getExtent

getExtent(): Extent
Returns the extent of this source expressed in the CRS of the source. Might be null if the extent of the source is not known.

Returns Extent
The extent of the source, if any.
Overrides ImageSource.getExtent
- Defined in sources/VectorSource.ts:402

getFeatureById

getFeatureById(
id: string | number,
): Feature<Geometry, { [x: string]: any }> | null
Returns the feature with the specified id.
Parameters
- id: string | number
  The feature id.
Returns Feature<Geometry, { [x: string]: any }> | null
The feature.
- Defined in sources/VectorSource.ts:382

getFeatures

getFeatures(): Feature<Geometry, { [x: string]: any }>[]
Returns an array with the feature in this source.

Returns Feature<Geometry, { [x: string]: any }>[]
The features.
- Defined in sources/VectorSource.ts:303

getImages

getImages(options: GetImageOptions): ImageResponse[]
Gets the images for the specified extent and pixel size.
Parameters
- options: GetImageOptions
  The options.
Returns ImageResponse[]
An array containing the functions to generate the images asynchronously.
Overrides ImageSource.getImages
- Defined in sources/VectorSource.ts:495

getMemoryUsage

getMemoryUsage(_context: GetMemoryUsageContext): 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:194

initialize

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

intersects

intersects(extent: 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:479

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:244

removeFeature

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

reproject

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

setStyle

setStyle(style: Style | StyleFunction): 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:229

update

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

updateFeature

updateFeature(...feature: Feature<Geometry, { [x: string]: any }>[]): void
Updates the region associated with the feature(s).
Parameters
- ...feature: Feature<Geometry, { [x: string]: any }>[]
  The feature(s) to update.
Returns void
- Defined in sources/VectorSource.ts:349

Class VectorSource

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VectorSource

Properties

ReadonlycontainsFn

Readonlydata

ReadonlydataProjection

datatype

ReadonlyflipY

ReadonlyisImageSource

ReadonlyisMemoryUsage

ReadonlyisVectorSource

Readonlypriority

Readonlysource

Optionalstyle

Readonlysynchronous

Readonlytransparent

Readonlytype

Accessors

colorSpace

Returns ColorSpace

featureCount

Returns number

Methods

addFeature

Parameters

Returns void

addFeatures

Parameters

Returns void

adjustExtentAndPixelSize

Parameters

Returns GridExtent | null

clear

Returns void

contains

Parameters

Returns boolean

dispose

Returns void

forEachFeature

Parameters

Returns void

getCrs

Returns CoordinateSystem

getCurrentExtent

Returns Extent | null

getExtent

Returns Extent

getFeatureById

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

getFeatures

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

getImages

Parameters

Returns ImageResponse[]

getMemoryUsage

Parameters

Returns void

initialize

Parameters

Returns Promise<void>

intersects

Parameters

Returns boolean

loadFeatures

Returns Promise<void>

removeFeature

Parameters

Returns void

`Readonly`containsFn

`Readonly`data

`Readonly`dataProjection

`Readonly`flipY

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`isVectorSource

`Readonly`priority

`Readonly`source

`Optional`style

`Readonly`synchronous

`Readonly`transparent

`Readonly`type