sources and layers.

This commit is contained in:
Simon Seyock
2021-06-23 14:26:17 +02:00
committed by Andreas Hocevar
parent e9a161740a
commit 7fc664c3fe
10 changed files with 69 additions and 1 deletions

View File

@@ -8,6 +8,11 @@ import {assert} from '../asserts.js';
import {assign} from '../obj.js';
import {clamp} from '../math.js';
/**
* @typedef {import("../ObjectEventType").Types|'change:extent'|'change:maxResolution'|'change:maxZoom'|
* 'change:minResolution'|'change:minZoom'|'change:opacity'|'change:visible'|'change:zIndex'} BaseLayerObjectEventTypes
*/
/**
* @typedef {Object} Options
* @property {string} [className='ol-layer'] A CSS class name to set to the layer element.
@@ -47,6 +52,12 @@ class BaseLayer extends BaseObject {
constructor(options) {
super();
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<BaseLayerObjectEventTypes, import("../Object").ObjectEvent>}
*/
this.on;
/**
* @type {Object<string, *>}
*/

View File

@@ -61,6 +61,14 @@ class BaseTileLayer extends Layer {
delete baseOptions.useInterimTilesOnError;
super(baseOptions);
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>}
*/
this.on;
this.setPreload(options.preload !== undefined ? options.preload : 0);
this.setUseInterimTilesOnError(
options.useInterimTilesOnError !== undefined

View File

@@ -96,6 +96,14 @@ class Layer extends BaseLayer {
super(baseOptions);
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>}
*/
this.on;
/**
* @private
* @type {?import("../events.js").EventsKey}

View File

@@ -95,6 +95,14 @@ class VectorTileLayer extends BaseVectorLayer {
)
);
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>}
*/
this.on;
if (options.renderMode === VectorTileRenderType.IMAGE) {
//FIXME deprecated - remove this check in v7.
//eslint-disable-next-line

View File

@@ -51,5 +51,5 @@ export default {
*/
/**
* @typedef {MapRenderEventTypes|'prerender'} RenderEventTypes
* @typedef {'postrender'|'prerender'} LayerRenderEventTypes
*/

View File

@@ -38,6 +38,10 @@ export const ImageSourceEventType = {
IMAGELOADERROR: 'imageloaderror',
};
/**
* @typedef {'imageloadend'|'imageloaderror'|'imageloadstart'} ImageSourceEventTypes
*/
/**
* @classdesc
* Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this
@@ -89,6 +93,13 @@ class ImageSource extends Source {
state: options.state,
});
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<ImageSourceEventTypes, ImageSourceEvent>}
*/
this.on;
/**
* @private
* @type {Array<number>}

View File

@@ -52,6 +52,13 @@ class TileSource extends Source {
wrapX: options.wrapX,
});
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("./TileEventType").TileSourceEventTypes, TileSourceEvent>}
*/
this.on;
/**
* @private
* @type {boolean}

View File

@@ -28,3 +28,7 @@ export default {
*/
TILELOADERROR: 'tileloaderror',
};
/**
* @typedef {'tileloadstart'|'tileloadend'|'tileloaderror'} TileSourceEventTypes
*/

View File

@@ -177,6 +177,13 @@ class VectorSource extends Source {
wrapX: options.wrapX !== undefined ? options.wrapX : true,
});
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("./VectorEventType").VectorSourceEventTypes, VectorSourceEvent>}
*/
this.on;
/**
* @private
* @type {import("../featureloader.js").FeatureLoader}

View File

@@ -56,3 +56,7 @@ export default {
*/
FEATURESLOADERROR: 'featuresloaderror',
};
/**
* @typedef {'addfeature'|'clear'|'removefeature'|'featuresloadstart'|'featuresloadend'|'featuresloaderror'} VectorSourceEventTypes
*/