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

ImageSource
- VectorSource

Constructors

constructor

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

Properties

`Private` _targetProjection

_targetProjection: string

`Readonly` containsFn

containsFn: CustomContainsFn

`Readonly` data

data: string | object | Feature<Geometry>[]

`Readonly` dataProjection

dataProjection: 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` format

format: FeatureFormat

`Readonly` isImageSource

isImageSource: boolean = true

`Readonly` isVectorSource

isVectorSource: boolean = true

`Readonly` source

source: VectorSource<Geometry>

style

style: Style | StyleFunction

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

type

type: string

version

version: number

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

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

adjustExtentAndPixelSize

adjustExtentAndPixelSize(requestExtent, requestWidth, requestHeight, margin?): {
    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 {
    extent: Extent;
    height: number;
    width: number;
}
The adjusted parameters.
- extent: Extent
- height: number
- width: number
Inherited from ImageSource.adjustExtentAndPixelSize
- Defined in sources/ImageSource.ts:169

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

`Private` createBuilderGroup

createBuilderGroup(extent, size): BuilderGroup
Parameters
- extent: Extent
  
  The target extent.
- size: Vector2
  
  The target pixel size.
Returns BuilderGroup
The builder group, or null if no features have been rendered.
- Defined in sources/VectorSource.ts:336

`Private` createImage

createImage(id, extent, size): ImageResult
Parameters
- id: string
  
  The unique id of the request.
- extent: Extent
  
  The request extent.
- size: Vector2
  
  The size in pixels of the request.
Returns ImageResult
The image result.
- Defined in sources/VectorSource.ts:382

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

forEachFeature

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

getCrs

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

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

getCurrentExtent

getCurrentExtent(): Extent
Returns Extent
- Defined in sources/VectorSource.ts:323

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

getFeatureById

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

getFeatures

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

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

getImages

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

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;
  }
  
  Options.
  - 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:396

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

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

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

update

update(): void
Raises an event to reload the source.

Returns void
Inherited from ImageSource.update
- Defined in sources/ImageSource.ts:200

Class VectorSource

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: VectorSourceOptions

Returns VectorSource

Properties

Private _targetProjection

Readonly containsFn

Readonly data

Readonly dataProjection

datatype

Readonly flipY

Readonly format

Readonly isImageSource

Readonly isVectorSource

Readonly source

style

type

version

Accessors

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

T extends "updated"

Parameters

type: T

listener: EventListener<ImageSourceEvents[T], T, VectorSource>

Returns void

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<{}, T, VectorSource>

Returns void

adjustExtentAndPixelSize

Parameters

requestExtent: Extent

requestWidth: number

requestHeight: number

margin: number = 0

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

extent: Extent

height: number

width: number

contains

Parameters

extent: Extent

Returns boolean

Private createBuilderGroup

Parameters

extent: Extent

size: Vector2

Returns BuilderGroup

Private createImage

Parameters

id: string

extent: Extent

size: Vector2

Returns ImageResult

dispatchEvent

Type Parameters

T extends "updated"

Parameters

event: BaseEvent<T> & ImageSourceEvents[T]

Returns void

dispose

Returns void

forEachFeature

Parameters

callback: ((arg0) => unknown)

`Private` _targetProjection

`Readonly` containsFn

`Readonly` data

`Readonly` dataProjection

`Readonly` flipY

`Readonly` format

`Readonly` isImageSource

`Readonly` isVectorSource

`Readonly` source

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

`Private` createBuilderGroup

`Private` createImage

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

opts: {
targetProjection: string;
}