ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5335 from probins/typedefs

Browse Source 
Move typedefs to separate file
This commit is contained in:
Andreas Hocevar
2016-05-13 10:23:14 +02:00
parent 9523fb6edd 0daa2cf574
commit 4626554a18
75 changed files with 828 additions and 807 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/animation.js
-1
View File
@@ -1,7 +1,6 @@
goog.provide('ol.animation');
goog.require('ol');
goog.require('ol.PreRenderFunction');
goog.require('ol.ViewHint');
goog.require('ol.coordinate');
goog.require('ol.easing');
src/ol/attribution.js
-7
View File
@@ -4,13 +4,6 @@ goog.require('ol.TileRange');
goog.require('ol.math');
/**
* @typedef {string|Array.<string>|ol.Attribution|Array.<ol.Attribution>}
* @api
*/
ol.AttributionLike;
/**
* @classdesc
* An attribution for a layer source.
src/ol/canvasfunction.js
-17
View File
@@ -1,17 +0,0 @@
goog.provide('ol.CanvasFunctionType');
/**
* A function returning the canvas element (`{HTMLCanvasElement}`)
* used by the source as an image. The arguments passed to the function are:
* {@link ol.Extent} the image extent, `{number}` the image resolution,
* `{number}` the device pixel ratio, {@link ol.Size} the image size, and
* {@link ol.proj.Projection} the image projection. The canvas returned by
* this function is cached by the source. The this keyword inside the function
* references the {@link ol.source.ImageCanvas}.
*
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
* @api
*/
ol.CanvasFunctionType;
src/ol/centerconstraint.js
-7
View File
@@ -1,15 +1,8 @@
goog.provide('ol.CenterConstraint');
goog.provide('ol.CenterConstraintType');
goog.require('ol.math');
/**
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
*/
ol.CenterConstraintType;
/**
* @param {ol.Extent} extent Extent.
* @return {ol.CenterConstraintType} The constraint.
src/ol/color/color.js
-12
View File
@@ -3,7 +3,6 @@
// causes occasional loss of precision and rounding errors, especially in the
// alpha channel.
goog.provide('ol.Color');
goog.provide('ol.color');
goog.require('goog.asserts');
@@ -13,17 +12,6 @@ goog.require('ol');
goog.require('ol.math');
/**
* A color represented as a short array [red, green, blue, alpha].
* red, green, and blue should be integers in the range 0..255 inclusive.
* alpha should be a float in the range 0..1 inclusive. If no alpha value is
* given then `1` will be used.
* @typedef {Array.<number>}
* @api
*/
ol.Color;
/**
* This RegExp matches # followed by 3 or 6 hex digits.
* @const
src/ol/colorlike.js
-11
View File
@@ -1,19 +1,8 @@
goog.provide('ol.ColorLike');
goog.provide('ol.colorlike');
goog.require('ol.color');
/**
* A type accepted by CanvasRenderingContext2D.fillStyle.
* Represents a color, pattern, or gradient.
*
* @typedef {string|CanvasPattern|CanvasGradient}
* @api
*/
ol.ColorLike;
/**
* @param {ol.Color|ol.ColorLike} color Color.
* @return {ol.ColorLike} The color as an ol.ColorLike
src/ol/control/mousepositioncontrol.js
-1
View File
@@ -5,7 +5,6 @@ goog.provide('ol.control.MousePosition');
goog.require('ol.events');
goog.require('ol.events.EventType');
goog.require('ol.Object');
goog.require('ol.TransformFunction');
goog.require('ol.control.Control');
goog.require('ol.proj');
goog.require('ol.proj.Projection');
src/ol/coordinate.js
-20
View File
@@ -1,29 +1,9 @@
goog.provide('ol.Coordinate');
goog.provide('ol.CoordinateFormatType');
goog.provide('ol.coordinate');
goog.require('ol.math');
goog.require('ol.string');
/**
* A function that takes a {@link ol.Coordinate} and transforms it into a
* `{string}`.
*
* @typedef {function((ol.Coordinate|undefined)): string}
* @api stable
*/
ol.CoordinateFormatType;
/**
* An array of numbers representing an xy coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate
* @api stable
*/
ol.Coordinate;
/**
* Add `delta` to `coordinate`. `coordinate` is modified in place and returned
* by the function.
src/ol/events.js
+1 -34
View File
@@ -3,6 +3,7 @@ goog.provide('ol.events.EventType');
goog.provide('ol.events.KeyCode');
goog.require('ol.object');
goog.require('ol.events.EventTargetLike');
/**
@@ -61,40 +62,6 @@ ol.events.KeyCode = {
ol.events.LISTENER_MAP_PROP_ = 'olm_' + ((Math.random() * 1e4) | 0);
/**
* @typedef {EventTarget|ol.events.EventTarget|
* {addEventListener: function(string, Function, boolean=),
* removeEventListener: function(string, Function, boolean=),
* dispatchEvent: function(string)}}
*/
ol.events.EventTargetLike;
/**
* Key to use with {@link ol.Observable#unByKey}.
*
* @typedef {{bindTo: (Object|undefined),
* boundListener: (ol.events.ListenerFunctionType|undefined),
* callOnce: boolean,
* deleteIndex: (number|undefined),
* listener: ol.events.ListenerFunctionType,
* target: (EventTarget|ol.events.EventTarget),
* type: string}}
* @api
*/
ol.events.Key;
/**
* Listener function. This function is called with an event object as argument.
* When the function returns `false`, event propagation will stop.
*
* @typedef {function(ol.events.Event)|function(ol.events.Event): boolean}
* @api
*/
ol.events.ListenerFunctionType;
/**
* @param {ol.events.Key} listenerObj Listener object.
* @return {ol.events.ListenerFunctionType} Bound listener.
src/ol/events/condition.js
-10
View File
@@ -6,16 +6,6 @@ goog.require('ol.MapBrowserEvent.EventType');
goog.require('ol.MapBrowserPointerEvent');
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a
* `{boolean}`. If the condition is met, true should be returned.
*
* @typedef {function(ol.MapBrowserEvent): boolean}
* @api stable
*/
ol.events.ConditionType;
/**
* Return `true` if only the alt-key is pressed, `false` otherwise (e.g. when
* additionally the shift-key is pressed).
src/ol/extent.js
-9
View File
@@ -1,4 +1,3 @@
goog.provide('ol.Extent');
goog.provide('ol.extent');
goog.provide('ol.extent.Corner');
goog.provide('ol.extent.Relationship');
@@ -6,14 +5,6 @@ goog.provide('ol.extent.Relationship');
goog.require('goog.asserts');
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Extent;
/**
* Extent corner.
* @enum {string}
src/ol/feature.js
-13
View File
@@ -1,5 +1,4 @@
goog.provide('ol.Feature');
goog.provide('ol.FeatureStyleFunction');
goog.require('goog.asserts');
goog.require('ol.events');
@@ -284,18 +283,6 @@ ol.Feature.prototype.setGeometryName = function(name) {
};
/**
* A function that returns an array of {@link ol.style.Style styles} given a
* resolution. The `this` keyword inside the function references the
* {@link ol.Feature} to be styled.
*
* @typedef {function(this: ol.Feature, number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api stable
*/
ol.FeatureStyleFunction;
/**
* Convert the provided object into a feature style function. Functions passed
* through unchanged. Arrays of ol.style.Style or single style objects wrapped
src/ol/featureloader.js
-34
View File
@@ -1,5 +1,3 @@
goog.provide('ol.FeatureLoader');
goog.provide('ol.FeatureUrlFunction');
goog.provide('ol.featureloader');
goog.require('goog.asserts');
@@ -11,38 +9,6 @@ goog.require('ol.proj.Projection');
goog.require('ol.xml');
/**
* {@link ol.source.Vector} sources use a function of this type to load
* features.
*
* This function takes an {@link ol.Extent} representing the area to be loaded,
* a `{number}` representing the resolution (map units per pixel) and an
* {@link ol.proj.Projection} for the projection as arguments. `this` within
* the function is bound to the {@link ol.source.Vector} it's called from.
*
* The function is responsible for loading the features and adding them to the
* source.
* @api
* @typedef {function(this:ol.source.Vector, ol.Extent, number,
* ol.proj.Projection)}
*/
ol.FeatureLoader;
/**
* {@link ol.source.Vector} sources use a function of this type to get the url
* to load features from.
*
* This function takes an {@link ol.Extent} representing the area to be loaded,
* a `{number}` representing the resolution (map units per pixel) and an
* {@link ol.proj.Projection} for the projection as arguments and returns a
* `{string}` representing the URL.
* @api
* @typedef {function(ol.Extent, number, ol.proj.Projection) : string}
*/
ol.FeatureUrlFunction;
/**
* @param {string|ol.FeatureUrlFunction} url Feature URL service.
* @param {ol.format.Feature} format Feature format.
src/ol/format/kmlformat.js
-14
View File
@@ -41,20 +41,6 @@ goog.require('ol.style.Text');
goog.require('ol.xml');
/**
* @typedef {{x: number, xunits: (ol.style.IconAnchorUnits|undefined),
* y: number, yunits: (ol.style.IconAnchorUnits|undefined)}}
*/
ol.format.KMLVec2_;
/**
* @typedef {{flatCoordinates: Array.<number>,
* whens: Array.<number>}}
*/
ol.format.KMLGxTrackObject_;
/**
* @classdesc
* Feature format for reading and writing data in the KML format.
src/ol/format/ogc/filter.js
+1
View File
@@ -18,6 +18,7 @@ goog.provide('ol.format.ogc.filter.IsNull');
goog.provide('ol.format.ogc.filter.IsBetween');
goog.provide('ol.format.ogc.filter.IsLike');
goog.require('ol.Extent');
goog.require('ol.Object');
src/ol/format/wfsformat.js
-20
View File
@@ -82,26 +82,6 @@ ol.format.WFS.FEATURE_PREFIX = 'feature';
ol.format.WFS.XMLNS = 'http://www.w3.org/2000/xmlns/';
/**
* Number of features; bounds/extent.
* @typedef {{numberOfFeatures: number,
* bounds: ol.Extent}}
* @api stable
*/
ol.format.WFS.FeatureCollectionMetadata;
/**
* Total deleted; total inserted; total updated; array of insert ids.
* @typedef {{totalDeleted: number,
* totalInserted: number,
* totalUpdated: number,
* insertIds: Array.<string>}}
* @api stable
*/
ol.format.WFS.TransactionResponse;
/**
* @const
* @type {string}
src/ol/format/wktformat.js
+2 -8
View File
@@ -366,12 +366,6 @@ ol.format.WKT.prototype.writeGeometryText = function(geometry, opt_options) {
};
/**
* @typedef {{type: number, value: (number|string|undefined), position: number}}
*/
ol.format.WKT.Token;
/**
* @const
* @enum {number}
@@ -451,7 +445,7 @@ ol.format.WKT.Lexer.prototype.nextChar_ = function() {
/**
* Fetch and return the next token.
* @return {!ol.format.WKT.Token} Next string token.
* @return {!ol.format.WKTToken} Next string token.
*/
ol.format.WKT.Lexer.prototype.nextToken = function() {
var c = this.nextChar_();
@@ -537,7 +531,7 @@ ol.format.WKT.Parser = function(lexer) {
this.lexer_ = lexer;
/**
* @type {ol.format.WKT.Token}
* @type {ol.format.WKTToken}
* @private
*/
this.token_;
src/ol/framestate.js
-19
View File
@@ -1,19 +0,0 @@
goog.provide('ol.PostRenderFunction');
goog.provide('ol.PreRenderFunction');
/**
* @typedef {function(ol.Map, ?olx.FrameState): boolean}
*/
ol.PostRenderFunction;
/**
* Function to perform manipulations before rendering. This function is called
* with the {@link ol.Map} as first and an optional {@link olx.FrameState} as
* second argument. Return `true` to keep this function for the next frame,
* `false` to remove it.
* @typedef {function(ol.Map, ?olx.FrameState): boolean}
* @api
*/
ol.PreRenderFunction;
src/ol/geolocation.js
-1
View File
@@ -6,7 +6,6 @@ goog.provide('ol.GeolocationProperty');
goog.require('ol.events');
goog.require('ol.events.EventType');
goog.require('ol.Object');
goog.require('ol.TransformFunction');
goog.require('ol.geom.Geometry');
goog.require('ol.geom.Polygon');
goog.require('ol.has');
src/ol/imagecanvas.js
-11
View File
@@ -91,14 +91,3 @@ ol.ImageCanvas.prototype.load = function() {
ol.ImageCanvas.prototype.getImage = function(opt_context) {
return this.canvas_;
};
/**
* A function that is called to trigger asynchronous canvas drawing. It is
* called with a "done" callback that should be called when drawing is done.
* If any error occurs during drawing, the "done" callback should be called with
* that error.
*
* @typedef {function(function(Error))}
*/
ol.ImageCanvasLoader;
src/ol/imageloadfunction.js
-21
View File
@@ -1,21 +0,0 @@
goog.provide('ol.ImageLoadFunctionType');
/**
* A function that takes an {@link ol.Image} for the image and a `{string}` for
* the src as arguments. It is supposed to make it so the underlying image
* {@link ol.Image#getImage} is assigned the content specified by the src. If
* not specified, the default is
*
* function(image, src) {
* image.getImage().src = src;
* }
*
* Providing a custom `imageLoadFunction` can be useful to load images with
* post requests or - in general - through XHR requests, where the src of the
* image element would be set to a data URI when the content is loaded.
*
* @typedef {function(ol.Image, string)}
* @api
*/
ol.ImageLoadFunctionType;
src/ol/interaction/dragboxinteraction.js
-10
View File
@@ -79,16 +79,6 @@ ol.DragBoxEvent = function(type, coordinate, mapBrowserEvent) {
goog.inherits(ol.DragBoxEvent, ol.events.Event);
/**
* A function that takes a {@link ol.MapBrowserEvent} and two
* {@link ol.Pixel}s and returns a `{boolean}`. If the condition is met,
* true should be returned.
* @typedef {function(ol.MapBrowserEvent, ol.Pixel, ol.Pixel):boolean}
* @api
*/
ol.interaction.DragBoxEndConditionType;
/**
* @classdesc
* Allows the user to draw a vector box by clicking and dragging on the map,
src/ol/interaction/dragpaninteraction.js
+1 -1
View File
@@ -2,7 +2,7 @@ goog.provide('ol.interaction.DragPan');
goog.require('goog.asserts');
goog.require('ol.Kinetic');
goog.require('ol.Pixel');
goog.require('ol.ViewHint');
goog.require('ol.coordinate');
goog.require('ol.functions');
src/ol/interaction/drawinteraction.js
-13
View File
@@ -850,19 +850,6 @@ ol.interaction.Draw.getMode_ = function(type) {
};
/**
* Function that takes coordinates and an optional existing geometry as
* arguments, and returns a geometry. The optional existing geometry is the
* geometry that is returned when the function is called without a second
* argument.
* @typedef {function(!(ol.Coordinate|Array.<ol.Coordinate>|
* Array.<Array.<ol.Coordinate>>), ol.geom.SimpleGeometry=):
* ol.geom.SimpleGeometry}
* @api
*/
ol.interaction.DrawGeometryFunctionType;
/**
* Draw mode. This collapses multi-part geometry types with their single-part
* cousins.
src/ol/interaction/modifyinteraction.js
-11
View File
@@ -11,7 +11,6 @@ goog.require('ol.CollectionEventType');
goog.require('ol.Feature');
goog.require('ol.MapBrowserEvent.EventType');
goog.require('ol.MapBrowserPointerEvent');
goog.require('ol.Pixel');
goog.require('ol.ViewHint');
goog.require('ol.array');
goog.require('ol.coordinate');
@@ -83,16 +82,6 @@ ol.interaction.ModifyEvent = function(type, features, mapBrowserPointerEvent) {
goog.inherits(ol.interaction.ModifyEvent, ol.events.Event);
/**
* @typedef {{depth: (Array.<number>|undefined),
* feature: ol.Feature,
* geometry: ol.geom.SimpleGeometry,
* index: (number|undefined),
* segment: Array.<ol.Extent>}}
*/
ol.interaction.SegmentDataType;
/**
* @classdesc
* Interaction for modifying feature geometries.
src/ol/interaction/pointerinteraction.js
-1
View File
@@ -3,7 +3,6 @@ goog.provide('ol.interaction.Pointer');
goog.require('ol');
goog.require('ol.MapBrowserEvent.EventType');
goog.require('ol.MapBrowserPointerEvent');
goog.require('ol.Pixel');
goog.require('ol.interaction.Interaction');
goog.require('ol.object');
src/ol/interaction/selectinteraction.js
-11
View File
@@ -30,17 +30,6 @@ ol.interaction.SelectEventType = {
};
/**
* A function that takes an {@link ol.Feature} or {@link ol.render.Feature} and
* an {@link ol.layer.Layer} and returns `true` if the feature may be selected
* or `false` otherwise.
* @typedef {function((ol.Feature|ol.render.Feature), ol.layer.Layer):
* boolean}
* @api
*/
ol.interaction.SelectFilterFunction;
/**
* @classdesc
* Events emitted by {@link ol.interaction.Select} instances are instances of
src/ol/interaction/snapinteraction.js
+12 -32
View File
@@ -9,7 +9,6 @@ goog.require('ol.CollectionEventType');
goog.require('ol.Feature');
goog.require('ol.Object');
goog.require('ol.Observable');
goog.require('ol.Pixel');
goog.require('ol.coordinate');
goog.require('ol.events');
goog.require('ol.events.EventType');
@@ -130,7 +129,7 @@ ol.interaction.Snap = function(opt_options) {
options.pixelTolerance : 10;
/**
* @type {function(ol.interaction.Snap.SegmentDataType, ol.interaction.Snap.SegmentDataType): number}
* @type {function(ol.interaction.SnapSegmentDataType, ol.interaction.SnapSegmentDataType): number}
* @private
*/
this.sortByDistance_ = ol.interaction.Snap.sortByDistance.bind(this);
@@ -138,7 +137,7 @@ ol.interaction.Snap = function(opt_options) {
/**
* Segment RTree for each layer
* @type {ol.structs.RBush.<ol.interaction.Snap.SegmentDataType>}
* @type {ol.structs.RBush.<ol.interaction.SnapSegmentDataType>}
* @private
*/
this.rBush_ = new ol.structs.RBush();
@@ -379,7 +378,7 @@ ol.interaction.Snap.prototype.shouldStopEvent = ol.functions.FALSE;
* @param {ol.Pixel} pixel Pixel
* @param {ol.Coordinate} pixelCoordinate Coordinate
* @param {ol.Map} map Map.
* @return {ol.interaction.Snap.ResultType} Snap result
* @return {ol.interaction.SnapResultType} Snap result
*/
ol.interaction.Snap.prototype.snapTo = function(pixel, pixelCoordinate, map) {
@@ -438,7 +437,7 @@ ol.interaction.Snap.prototype.snapTo = function(pixel, pixelCoordinate, map) {
vertexPixel = [Math.round(vertexPixel[0]), Math.round(vertexPixel[1])];
}
}
return /** @type {ol.interaction.Snap.ResultType} */ ({
return /** @type {ol.interaction.SnapResultType} */ ({
snapped: snapped,
vertex: vertex,
vertexPixel: vertexPixel
@@ -480,7 +479,7 @@ ol.interaction.Snap.prototype.writeLineStringGeometry_ = function(feature, geome
var i, ii, segment, segmentData;
for (i = 0, ii = coordinates.length - 1; i < ii; ++i) {
segment = coordinates.slice(i, i + 2);
segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: segment
});
@@ -501,7 +500,7 @@ ol.interaction.Snap.prototype.writeMultiLineStringGeometry_ = function(feature,
coordinates = lines[j];
for (i = 0, ii = coordinates.length - 1; i < ii; ++i) {
segment = coordinates.slice(i, i + 2);
segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: segment
});
@@ -521,7 +520,7 @@ ol.interaction.Snap.prototype.writeMultiPointGeometry_ = function(feature, geome
var coordinates, i, ii, segmentData;
for (i = 0, ii = points.length; i < ii; ++i) {
coordinates = points[i];
segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: [coordinates, coordinates]
});
@@ -544,7 +543,7 @@ ol.interaction.Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geo
coordinates = rings[j];
for (i = 0, ii = coordinates.length - 1; i < ii; ++i) {
segment = coordinates.slice(i, i + 2);
segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: segment
});
@@ -562,7 +561,7 @@ ol.interaction.Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geo
*/
ol.interaction.Snap.prototype.writePointGeometry_ = function(feature, geometry) {
var coordinates = geometry.getCoordinates();
var segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
var segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: [coordinates, coordinates]
});
@@ -582,7 +581,7 @@ ol.interaction.Snap.prototype.writePolygonGeometry_ = function(feature, geometry
coordinates = rings[j];
for (i = 0, ii = coordinates.length - 1; i < ii; ++i) {
segment = coordinates.slice(i, i + 2);
segmentData = /** @type {ol.interaction.Snap.SegmentDataType} */ ({
segmentData = /** @type {ol.interaction.SnapSegmentDataType} */ ({
feature: feature,
segment: segment
});
@@ -592,25 +591,6 @@ ol.interaction.Snap.prototype.writePolygonGeometry_ = function(feature, geometry
};
/**
* @typedef {{
* snapped: {boolean},
* vertex: (ol.Coordinate|null),
* vertexPixel: (ol.Pixel|null)
* }}
*/
ol.interaction.Snap.ResultType;
/**
* @typedef {{
* feature: ol.Feature,
* segment: Array.<ol.Coordinate>
* }}
*/
ol.interaction.Snap.SegmentDataType;
/**
* Handle all pointer events events.
* @param {ol.MapBrowserEvent} evt A move event.
@@ -646,8 +626,8 @@ ol.interaction.Snap.handleUpEvent_ = function(evt) {
/**
* Sort segments by distance, helper function
* @param {ol.interaction.Snap.SegmentDataType} a The first segment data.
* @param {ol.interaction.Snap.SegmentDataType} b The second segment data.
* @param {ol.interaction.SnapSegmentDataType} a The first segment data.
* @param {ol.interaction.SnapSegmentDataType} b The second segment data.
* @return {number} The difference in distance.
* @this {ol.interaction.Snap}
*/
src/ol/layer/layerbase.js
-14
View File
@@ -22,20 +22,6 @@ ol.layer.LayerProperty = {
};
/**
* @typedef {{layer: ol.layer.Layer,
* opacity: number,
* sourceState: ol.source.State,
* visible: boolean,
* managed: boolean,
* extent: (ol.Extent|undefined),
* zIndex: number,
* maxResolution: number,
* minResolution: number}}
*/
ol.layer.LayerState;
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
src/ol/loadingstrategy.js
-10
View File
@@ -1,16 +1,6 @@
goog.provide('ol.LoadingStrategy');
goog.provide('ol.loadingstrategy');
/**
* One of `all`, `bbox`, `tile`.
*
* @typedef {function(ol.Extent, number): Array.<ol.Extent>}
* @api
*/
ol.LoadingStrategy;
/**
* Strategy function for loading all features with a single request.
* @param {ol.Extent} extent Extent.
src/ol/map.js
-14
View File
@@ -20,7 +20,6 @@ goog.require('ol.MapEventType');
goog.require('ol.Object');
goog.require('ol.ObjectEvent');
goog.require('ol.ObjectEventType');
goog.require('ol.Pixel');
goog.require('ol.RendererType');
goog.require('ol.TileQueue');
goog.require('ol.View');
@@ -1443,19 +1442,6 @@ ol.Map.prototype.unskipFeature = function(feature) {
};
/**
* @typedef {{controls: ol.Collection.<ol.control.Control>,
* interactions: ol.Collection.<ol.interaction.Interaction>,
* keyboardEventTarget: (Element|Document),
* logos: (Object.<string, (string|Element)>),
* overlays: ol.Collection.<ol.Overlay>,
* rendererConstructor:
* function(new: ol.renderer.Map, Element, ol.Map),
* values: Object.<string, *>}}
*/
ol.MapOptionsInternal;
/**
* @param {olx.MapOptions} options Map options.
* @return {ol.MapOptionsInternal} Internal map options.
src/ol/overlay.js
-1
View File
@@ -8,7 +8,6 @@ goog.require('ol.events');
goog.require('goog.style');
goog.require('ol.Map');
goog.require('ol.MapEventType');
goog.require('ol.Pixel');
goog.require('ol.Object');
goog.require('ol.animation');
goog.require('ol.dom');
src/ol/pixel.js
-10
View File
@@ -1,10 +0,0 @@
goog.provide('ol.Pixel');
/**
* An array with two elements, representing a pixel. The first element is the
* x-coordinate, the second the y-coordinate of the pixel.
* @typedef {Array.<number>}
* @api stable
*/
ol.Pixel;
src/ol/proj/proj.js
-10
View File
@@ -5,21 +5,11 @@ goog.provide('ol.proj.Units');
goog.require('goog.asserts');
goog.require('ol');
goog.require('ol.TransformFunction');
goog.require('ol.extent');
goog.require('ol.object');
goog.require('ol.sphere.NORMAL');
/**
* A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
* @api stable
*/
ol.proj.ProjectionLike;
/**
* Projection units: `'degrees'`, `'ft'`, `'m'`, `'pixels'`, `'tile-pixels'` or
* `'us-ft'`.
src/ol/raster/operation.js
-20
View File
@@ -1,4 +1,3 @@
goog.provide('ol.raster.Operation');
goog.provide('ol.raster.OperationType');
@@ -11,22 +10,3 @@ ol.raster.OperationType = {
PIXEL: 'pixel',
IMAGE: 'image'
};
/**
* A function that takes an array of input data, performs some operation, and
* returns an array of ouput data. For `'pixel'` type operations, functions
* will be called with an array of {@link ol.raster.Pixel} data and should
* return an array of the same. For `'image'` type operations, functions will
* be called with an array of {@link ImageData
* https://developer.mozilla.org/en-US/docs/Web/API/ImageData} and should return
* an array of the same. The operations are called with a second "data"
* argument, which can be used for storage. The data object is accessible
* from raster events, where it can be initialized in "beforeoperations" and
* accessed again in "afteroperations".
*
* @typedef {function((Array.<ol.raster.Pixel>|Array.<ImageData>), Object):
* (Array.<ol.raster.Pixel>|Array.<ImageData>)}
* @api
*/
ol.raster.Operation;
src/ol/raster/pixel.js
-10
View File
@@ -1,10 +0,0 @@
// goog.provide can't be removed from files which only contain a typedef
goog.provide('ol.raster.Pixel');
/**
* An array of numbers representing pixel values.
* @typedef {Array.<number>} ol.raster.Pixel
* @api
*/
ol.raster.Pixel;
src/ol/render/canvas/canvas.js
-25
View File
@@ -1,31 +1,6 @@
goog.provide('ol.render.canvas');
/**
* @typedef {{fillStyle: ol.ColorLike}}
*/
ol.render.canvas.FillState;
/**
* @typedef {{lineCap: string,
* lineDash: Array.<number>,
* lineJoin: string,
* lineWidth: number,
* miterLimit: number,
* strokeStyle: string}}
*/
ol.render.canvas.StrokeState;
/**
* @typedef {{font: string,
* textAlign: string,
* textBaseline: string}}
*/
ol.render.canvas.TextState;
/**
* @const
* @type {string}
src/ol/render/canvas/canvasimmediate.js
+11 -11
View File
@@ -71,31 +71,31 @@ ol.render.canvas.Immediate = function(context, pixelRatio, extent, transform, vi
/**
* @private
* @type {?ol.render.canvas.FillState}
* @type {?ol.render.canvasFillState}
*/
this.contextFillState_ = null;
/**
* @private
* @type {?ol.render.canvas.StrokeState}
* @type {?ol.render.canvasStrokeState}
*/
this.contextStrokeState_ = null;
/**
* @private
* @type {?ol.render.canvas.TextState}
* @type {?ol.render.canvasTextState}
*/
this.contextTextState_ = null;
/**
* @private
* @type {?ol.render.canvas.FillState}
* @type {?ol.render.canvasFillState}
*/
this.fillState_ = null;
/**
* @private
* @type {?ol.render.canvas.StrokeState}
* @type {?ol.render.canvasStrokeState}
*/
this.strokeState_ = null;
@@ -203,19 +203,19 @@ ol.render.canvas.Immediate = function(context, pixelRatio, extent, transform, vi
/**
* @private
* @type {?ol.render.canvas.FillState}
* @type {?ol.render.canvasFillState}
*/
this.textFillState_ = null;
/**
* @private
* @type {?ol.render.canvas.StrokeState}
* @type {?ol.render.canvasStrokeState}
*/
this.textStrokeState_ = null;
/**
* @private
* @type {?ol.render.canvas.TextState}
* @type {?ol.render.canvasTextState}
*/
this.textState_ = null;
@@ -700,7 +700,7 @@ ol.render.canvas.Immediate.prototype.drawMultiPolygon = function(geometry) {
/**
* @param {ol.render.canvas.FillState} fillState Fill state.
* @param {ol.render.canvasFillState} fillState Fill state.
* @private
*/
ol.render.canvas.Immediate.prototype.setContextFillState_ = function(fillState) {
@@ -720,7 +720,7 @@ ol.render.canvas.Immediate.prototype.setContextFillState_ = function(fillState)
/**
* @param {ol.render.canvas.StrokeState} strokeState Stroke state.
* @param {ol.render.canvasStrokeState} strokeState Stroke state.
* @private
*/
ol.render.canvas.Immediate.prototype.setContextStrokeState_ = function(strokeState) {
@@ -772,7 +772,7 @@ ol.render.canvas.Immediate.prototype.setContextStrokeState_ = function(strokeSta
/**
* @param {ol.render.canvas.TextState} textState Text state.
* @param {ol.render.canvasTextState} textState Text state.
* @private
*/
ol.render.canvas.Immediate.prototype.setContextTextState_ = function(textState) {
src/ol/render/canvas/canvasreplay.js
+9 -9
View File
@@ -1538,19 +1538,19 @@ ol.render.canvas.TextReplay = function(tolerance, maxExtent, resolution) {
/**
* @private
* @type {?ol.render.canvas.FillState}
* @type {?ol.render.canvasFillState}
*/
this.replayFillState_ = null;
/**
* @private
* @type {?ol.render.canvas.StrokeState}
* @type {?ol.render.canvasStrokeState}
*/
this.replayStrokeState_ = null;
/**
* @private
* @type {?ol.render.canvas.TextState}
* @type {?ol.render.canvasTextState}
*/
this.replayTextState_ = null;
@@ -1586,19 +1586,19 @@ ol.render.canvas.TextReplay = function(tolerance, maxExtent, resolution) {
/**
* @private
* @type {?ol.render.canvas.FillState}
* @type {?ol.render.canvasFillState}
*/
this.textFillState_ = null;
/**
* @private
* @type {?ol.render.canvas.StrokeState}
* @type {?ol.render.canvasStrokeState}
*/
this.textStrokeState_ = null;
/**
* @private
* @type {?ol.render.canvas.TextState}
* @type {?ol.render.canvasTextState}
*/
this.textState_ = null;
@@ -1638,7 +1638,7 @@ ol.render.canvas.TextReplay.prototype.drawText = function(flatCoordinates, offse
/**
* @param {ol.render.canvas.FillState} fillState Fill state.
* @param {ol.render.canvasFillState} fillState Fill state.
* @private
*/
ol.render.canvas.TextReplay.prototype.setReplayFillState_ = function(fillState) {
@@ -1662,7 +1662,7 @@ ol.render.canvas.TextReplay.prototype.setReplayFillState_ = function(fillState)
/**
* @param {ol.render.canvas.StrokeState} strokeState Stroke state.
* @param {ol.render.canvasStrokeState} strokeState Stroke state.
* @private
*/
ol.render.canvas.TextReplay.prototype.setReplayStrokeState_ = function(strokeState) {
@@ -1704,7 +1704,7 @@ ol.render.canvas.TextReplay.prototype.setReplayStrokeState_ = function(strokeSta
/**
* @param {ol.render.canvas.TextState} textState Text state.
* @param {ol.render.canvasTextState} textState Text state.
* @private
*/
ol.render.canvas.TextReplay.prototype.setReplayTextState_ = function(textState) {
src/ol/renderer/canvas/canvaslayerrenderer.js
-1
View File
@@ -2,7 +2,6 @@ goog.provide('ol.renderer.canvas.Layer');
goog.require('goog.asserts');
goog.require('goog.vec.Mat4');
goog.require('ol.Pixel');
goog.require('ol.extent');
goog.require('ol.layer.Layer');
goog.require('ol.render.Event');
src/ol/renderer/webgl/webglmaprenderer.js
+2 -8
View File
@@ -33,12 +33,6 @@ goog.require('ol.webgl.Context');
goog.require('ol.webgl.WebGLContextEventType');
/**
* @typedef {{magFilter: number, minFilter: number, texture: WebGLTexture}}
*/
ol.renderer.webgl.TextureCacheEntry;
/**
* @constructor
* @extends {ol.renderer.Map}
@@ -110,7 +104,7 @@ ol.renderer.webgl.Map = function(container, map) {
/**
* @private
* @type {ol.structs.LRUCache.<ol.renderer.webgl.TextureCacheEntry|null>}
* @type {ol.structs.LRUCache.<ol.renderer.webglTextureCacheEntry|null>}
*/
this.textureCache_ = new ol.structs.LRUCache();
@@ -300,7 +294,7 @@ ol.renderer.webgl.Map.prototype.disposeInternal = function() {
if (!gl.isContextLost()) {
this.textureCache_.forEach(
/**
* @param {?ol.renderer.webgl.TextureCacheEntry} textureCacheEntry
* @param {?ol.renderer.webglTextureCacheEntry} textureCacheEntry
* Texture cache entry.
*/
function(textureCacheEntry) {
src/ol/reproj/image.js
-6
View File
@@ -11,12 +11,6 @@ goog.require('ol.reproj');
goog.require('ol.reproj.Triangulation');
/**
* @typedef {function(ol.Extent, number, number) : ol.ImageBase}
*/
ol.reproj.ImageFunctionType;
/**
* @classdesc
* Class encapsulating single reprojected image.
src/ol/reproj/tile.js
-6
View File
@@ -13,12 +13,6 @@ goog.require('ol.reproj');
goog.require('ol.reproj.Triangulation');
/**
* @typedef {function(number, number, number, number) : ol.Tile}
*/
ol.reproj.TileFunctionType;
/**
* @classdesc
* Class encapsulating single reprojected tile.
src/ol/reproj/triangulation.js
-9
View File
@@ -6,15 +6,6 @@ goog.require('ol.math');
goog.require('ol.proj');
/**
* Single triangle; consists of 3 source points and 3 target points.
*
* @typedef {{source: Array.<ol.Coordinate>,
* target: Array.<ol.Coordinate>}}
*/
ol.reproj.Triangle;
/**
* @classdesc
* Class containing triangulation of the given target extent.
src/ol/resolutionconstraint.js
-7
View File
@@ -1,16 +1,9 @@
goog.provide('ol.ResolutionConstraint');
goog.provide('ol.ResolutionConstraintType');
goog.require('ol.array');
goog.require('ol.math');
/**
* @typedef {function((number|undefined), number, number): (number|undefined)}
*/
ol.ResolutionConstraintType;
/**
* @param {Array.<number>} resolutions Resolutions.
* @return {ol.ResolutionConstraintType} Zoom function.
src/ol/rotationconstraint.js
-7
View File
@@ -1,15 +1,8 @@
goog.provide('ol.RotationConstraint');
goog.provide('ol.RotationConstraintType');
goog.require('ol.math');
/**
* @typedef {function((number|undefined), number): (number|undefined)}
*/
ol.RotationConstraintType;
/**
* @param {number|undefined} rotation Rotation.
* @param {number} delta Delta.
src/ol/size.js
-9
View File
@@ -1,18 +1,9 @@
goog.provide('ol.Size');
goog.provide('ol.size');
goog.require('goog.asserts');
/**
* An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Size;
/**
* Returns a buffered size.
* @param {ol.Size} size Size.
src/ol/source/imagearcgisrestsource.js
-1
View File
@@ -4,7 +4,6 @@ goog.require('goog.asserts');
goog.require('goog.uri.utils');
goog.require('ol');
goog.require('ol.Image');
goog.require('ol.ImageLoadFunctionType');
goog.require('ol.events');
goog.require('ol.events.EventType');
goog.require('ol.extent');
src/ol/source/imagecanvassource.js
-1
View File
@@ -1,6 +1,5 @@
goog.provide('ol.source.ImageCanvas');
goog.require('ol.CanvasFunctionType');
goog.require('ol.ImageCanvas');
goog.require('ol.extent');
goog.require('ol.source.Image');
src/ol/source/imagemapguidesource.js
-1
View File
@@ -4,7 +4,6 @@ goog.require('ol.events');
goog.require('ol.events.EventType');
goog.require('goog.uri.utils');
goog.require('ol.Image');
goog.require('ol.ImageLoadFunctionType');
goog.require('ol.extent');
goog.require('ol.object');
goog.require('ol.source.Image');
src/ol/source/imagesource.js
-11
View File
@@ -11,17 +11,6 @@ goog.require('ol.reproj.Image');
goog.require('ol.source.Source');
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* extent: (null|ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* projection: ol.proj.ProjectionLike,
* resolutions: (Array.<number>|undefined),
* state: (ol.source.State|undefined)}}
*/
ol.source.ImageOptions;
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
src/ol/source/imagestaticsource.js
-1
View File
@@ -3,7 +3,6 @@ goog.provide('ol.source.ImageStatic');
goog.require('ol.events');
goog.require('ol.events.EventType');
goog.require('ol.Image');
goog.require('ol.ImageLoadFunctionType');
goog.require('ol.ImageState');
goog.require('ol.dom');
goog.require('ol.extent');
src/ol/source/rastersource.js
+1 -9
View File
@@ -91,7 +91,7 @@ ol.source.Raster = function(options) {
/**
* The most recently rendered state.
* @type {?ol.source.Raster.RenderedState}
* @type {?ol.source.RasterRenderedState}
* @private
*/
this.renderedState_ = null;
@@ -445,14 +445,6 @@ ol.source.Raster.createTileRenderer_ = function(source) {
};
/**
* @typedef {{revision: number,
* resolution: number,
* extent: ol.Extent}}
*/
ol.source.Raster.RenderedState;
/**
* @classdesc
* Events emitted by {@link ol.source.Raster} instances are instances of this
src/ol/source/source.js
-10
View File
@@ -20,16 +20,6 @@ ol.source.State = {
};
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* logo: (string|olx.LogoOptions|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.SourceOptions;
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
src/ol/source/tileimagesource.js
-1
View File
@@ -3,7 +3,6 @@ goog.provide('ol.source.TileImage');
goog.require('goog.asserts');
goog.require('ol.ImageTile');
goog.require('ol.TileCache');
goog.require('ol.TileLoadFunctionType');
goog.require('ol.TileState');
goog.require('ol.events');
goog.require('ol.events.EventType');
src/ol/source/tilesource.js
-15
View File
@@ -14,21 +14,6 @@ goog.require('ol.tilecoord');
goog.require('ol.tilegrid.TileGrid');
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* cacheSize: (number|undefined),
* extent: (ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* opaque: (boolean|undefined),
* tilePixelRatio: (number|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.TileOptions;
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
src/ol/source/urltilesource.js
-19
View File
@@ -7,25 +7,6 @@ goog.require('ol.source.Tile');
goog.require('ol.source.TileEvent');
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* cacheSize: (number|undefined),
* extent: (ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* opaque: (boolean|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* tileLoadFunction: ol.TileLoadFunctionType,
* tilePixelRatio: (number|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined),
* url: (string|undefined),
* urls: (Array.<string>|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.UrlTileOptions;
/**
* @classdesc
* Base class for sources providing tiles divided into a tile grid over http.
src/ol/source/vectortilesource.js
-1
View File
@@ -1,6 +1,5 @@
goog.provide('ol.source.VectorTile');
goog.require('ol.TileLoadFunctionType');
goog.require('ol.TileState');
goog.require('ol.VectorTile');
goog.require('ol.events');
src/ol/structs/lrucache.js
-9
View File
@@ -259,12 +259,3 @@ ol.structs.LRUCache.prototype.set = function(key, value) {
this.entries_[key] = entry;
++this.count_;
};
/**
* @typedef {{key_: string,
* newer: ol.structs.LRUCacheEntry,
* older: ol.structs.LRUCacheEntry,
* value_: *}}
*/
ol.structs.LRUCacheEntry;
src/ol/style/atlasmanager.js
+6 -31
View File
@@ -5,16 +5,6 @@ goog.require('goog.asserts');
goog.require('ol');
goog.require('ol.dom');
/**
* Provides information for an image inside an atlas manager.
* `offsetX` and `offsetY` is the position of the image inside
* the atlas image `image` and the position of the hit-detection image
* inside the hit-detection atlas image `hitImage`.
* @typedef {{offsetX: number, offsetY: number, image: HTMLCanvasElement,
* hitImage: HTMLCanvasElement}}
*/
ol.style.AtlasManagerInfo;
/**
* Manages the creation of image atlases.
@@ -239,15 +229,6 @@ ol.style.AtlasManager.prototype.add_ = function(isHitAtlas, id, width, height,
};
/**
* Provides information for an image inside an atlas.
* `offsetX` and `offsetY` are the position of the image inside
* the atlas image `image`.
* @typedef {{offsetX: number, offsetY: number, image: HTMLCanvasElement}}
*/
ol.style.AtlasInfo;
/**
* This class facilitates the creation of image atlases.
*
@@ -275,7 +256,7 @@ ol.style.Atlas = function(size, space) {
/**
* @private
* @type {Array.<ol.style.Atlas.Block>}
* @type {Array.<ol.style.AtlasBlock>}
*/
this.emptyBlocks_ = [{x: 0, y: 0, width: size, height: size}];
@@ -351,7 +332,7 @@ ol.style.Atlas.prototype.add = function(id, width, height, renderCallback, opt_t
/**
* @private
* @param {number} index The index of the block.
* @param {ol.style.Atlas.Block} block The block to split.
* @param {ol.style.AtlasBlock} block The block to split.
* @param {number} width The width of the entry to insert.
* @param {number} height The height of the entry to insert.
*/
@@ -359,9 +340,9 @@ ol.style.Atlas.prototype.split_ = function(index, block, width, height) {
var deltaWidth = block.width - width;
var deltaHeight = block.height - height;
/** @type {ol.style.Atlas.Block} */
/** @type {ol.style.AtlasBlock} */
var newBlock1;
/** @type {ol.style.Atlas.Block} */
/** @type {ol.style.AtlasBlock} */
var newBlock2;
if (deltaWidth > deltaHeight) {
@@ -410,8 +391,8 @@ ol.style.Atlas.prototype.split_ = function(index, block, width, height) {
* blocks (that are potentially smaller) are filled first.
* @private
* @param {number} index The index of the block to remove.
* @param {ol.style.Atlas.Block} newBlock1 The 1st block to add.
* @param {ol.style.Atlas.Block} newBlock2 The 2nd block to add.
* @param {ol.style.AtlasBlock} newBlock1 The 1st block to add.
* @param {ol.style.AtlasBlock} newBlock2 The 2nd block to add.
*/
ol.style.Atlas.prototype.updateBlocks_ = function(index, newBlock1, newBlock2) {
var args = [index, 1];
@@ -423,9 +404,3 @@ ol.style.Atlas.prototype.updateBlocks_ = function(index, newBlock1, newBlock2) {
}
this.emptyBlocks_.splice.apply(this.emptyBlocks_, args);
};
/**
* @typedef {{x: number, y: number, width: number, height: number}}
*/
ol.style.Atlas.Block;
src/ol/style/circlestyle.js
+4 -11
View File
@@ -227,13 +227,6 @@ ol.style.Circle.prototype.load = ol.nullFunction;
ol.style.Circle.prototype.unlistenImageChange = ol.nullFunction;
/**
* @typedef {{strokeStyle: (string|undefined), strokeWidth: number,
* size: number, lineDash: Array.<number>}}
*/
ol.style.Circle.RenderOptions;
/**
* @private
* @param {ol.style.AtlasManager|undefined} atlasManager An atlas manager.
@@ -259,7 +252,7 @@ ol.style.Circle.prototype.render_ = function(atlasManager) {
var size = 2 * (this.radius_ + strokeWidth) + 1;
/** @type {ol.style.Circle.RenderOptions} */
/** @type {ol.style.CircleRenderOptions} */
var renderOptions = {
strokeStyle: strokeStyle,
strokeWidth: strokeWidth,
@@ -320,7 +313,7 @@ ol.style.Circle.prototype.render_ = function(atlasManager) {
/**
* @private
* @param {ol.style.Circle.RenderOptions} renderOptions Render options.
* @param {ol.style.CircleRenderOptions} renderOptions Render options.
* @param {CanvasRenderingContext2D} context The rendering context.
* @param {number} x The origin for the symbol (x).
* @param {number} y The origin for the symbol (y).
@@ -355,7 +348,7 @@ ol.style.Circle.prototype.draw_ = function(renderOptions, context, x, y) {
/**
* @private
* @param {ol.style.Circle.RenderOptions} renderOptions Render options.
* @param {ol.style.CircleRenderOptions} renderOptions Render options.
*/
ol.style.Circle.prototype.createHitDetectionCanvas_ = function(renderOptions) {
this.hitDetectionImageSize_ = [renderOptions.size, renderOptions.size];
@@ -375,7 +368,7 @@ ol.style.Circle.prototype.createHitDetectionCanvas_ = function(renderOptions) {
/**
* @private
* @param {ol.style.Circle.RenderOptions} renderOptions Render options.
* @param {ol.style.CircleRenderOptions} renderOptions Render options.
* @param {CanvasRenderingContext2D} context The context.
* @param {number} x The origin for the symbol (x).
* @param {number} y The origin for the symbol (y).
src/ol/style/imagestyle.js
-10
View File
@@ -13,16 +13,6 @@ ol.style.ImageState = {
};
/**
* @typedef {{opacity: number,
* rotateWithView: boolean,
* rotation: number,
* scale: number,
* snapToPixel: boolean}}
*/
ol.style.ImageOptions;
/**
* @classdesc
* A base class used for creating subclasses and not instantiated in
src/ol/style/regularshapestyle.js
+4 -18
View File
@@ -289,20 +289,6 @@ ol.style.RegularShape.prototype.load = ol.nullFunction;
ol.style.RegularShape.prototype.unlistenImageChange = ol.nullFunction;
/**
* @typedef {{
* strokeStyle: (string|undefined),
* strokeWidth: number,
* size: number,
* lineCap: string,
* lineDash: Array.<number>,
* lineJoin: string,
* miterLimit: number
* }}
*/
ol.style.RegularShape.RenderOptions;
/**
* @private
* @param {ol.style.AtlasManager|undefined} atlasManager An atlas manager.
@@ -342,7 +328,7 @@ ol.style.RegularShape.prototype.render_ = function(atlasManager) {
var size = 2 * (this.radius_ + strokeWidth) + 1;
/** @type {ol.style.RegularShape.RenderOptions} */
/** @type {ol.style.RegularShapeRenderOptions} */
var renderOptions = {
strokeStyle: strokeStyle,
strokeWidth: strokeWidth,
@@ -405,7 +391,7 @@ ol.style.RegularShape.prototype.render_ = function(atlasManager) {
/**
* @private
* @param {ol.style.RegularShape.RenderOptions} renderOptions Render options.
* @param {ol.style.RegularShapeRenderOptions} renderOptions Render options.
* @param {CanvasRenderingContext2D} context The rendering context.
* @param {number} x The origin for the symbol (x).
* @param {number} y The origin for the symbol (y).
@@ -450,7 +436,7 @@ ol.style.RegularShape.prototype.draw_ = function(renderOptions, context, x, y) {
/**
* @private
* @param {ol.style.RegularShape.RenderOptions} renderOptions Render options.
* @param {ol.style.RegularShapeRenderOptions} renderOptions Render options.
*/
ol.style.RegularShape.prototype.createHitDetectionCanvas_ = function(renderOptions) {
this.hitDetectionImageSize_ = [renderOptions.size, renderOptions.size];
@@ -470,7 +456,7 @@ ol.style.RegularShape.prototype.createHitDetectionCanvas_ = function(renderOptio
/**
* @private
* @param {ol.style.RegularShape.RenderOptions} renderOptions Render options.
* @param {ol.style.RegularShapeRenderOptions} renderOptions Render options.
* @param {CanvasRenderingContext2D} context The context.
* @param {number} x The origin for the symbol (x).
* @param {number} y The origin for the symbol (y).
src/ol/style/style.js
-23
View File
@@ -191,18 +191,6 @@ ol.style.Style.prototype.setZIndex = function(zIndex) {
};
/**
* A function that takes an {@link ol.Feature} and a `{number}` representing
* the view's resolution. The function should return a {@link ol.style.Style}
* or an array of them. This way e.g. a vector layer can be styled.
*
* @typedef {function((ol.Feature|ol.render.Feature), number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api
*/
ol.style.StyleFunction;
/**
* Convert the provided object into a style function. Functions passed through
* unchanged. Arrays of ol.style.Style or single style objects wrapped in a
@@ -349,17 +337,6 @@ ol.style.createDefaultEditingStyles = function() {
};
/**
* A function that takes an {@link ol.Feature} as argument and returns an
* {@link ol.geom.Geometry} that will be rendered and styled for the feature.
*
* @typedef {function((ol.Feature|ol.render.Feature)):
* (ol.geom.Geometry|ol.render.Feature|undefined)}
* @api
*/
ol.style.GeometryFunction;
/**
* Function that is called with a feature and returns its default geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature to get the geometry
src/ol/tilecoord.js
-10
View File
@@ -1,19 +1,9 @@
goog.provide('ol.TileCoord');
goog.provide('ol.tilecoord');
goog.require('goog.asserts');
goog.require('ol.extent');
/**
* An array of three numbers representing the location of a tile in a tile
* grid. The order is `z`, `x`, and `y`. `z` is the zoom level.
* @typedef {Array.<number>} ol.TileCoord
* @api
*/
ol.TileCoord;
/**
* @enum {number}
*/
src/ol/tileloadfunction.js
-11
View File
@@ -1,11 +0,0 @@
goog.provide('ol.TileLoadFunctionType');
/**
* A function that takes an {@link ol.Tile} for the tile and a `{string}` for
* the url as arguments.
*
* @typedef {function(ol.Tile, string)}
* @api
*/
ol.TileLoadFunctionType;
src/ol/tilequeue.js
-7
View File
@@ -1,4 +1,3 @@
goog.provide('ol.TilePriorityFunction');
goog.provide('ol.TileQueue');
goog.require('goog.asserts');
@@ -8,12 +7,6 @@ goog.require('ol.TileState');
goog.require('ol.structs.PriorityQueue');
/**
* @typedef {function(ol.Tile, string, ol.Coordinate, number): number}
*/
ol.TilePriorityFunction;
/**
* @constructor
* @extends {ol.structs.PriorityQueue.<Array>}
src/ol/tileurlfunction.js
-18
View File
@@ -1,28 +1,10 @@
goog.provide('ol.TileUrlFunction');
goog.provide('ol.TileUrlFunctionType');
goog.require('goog.asserts');
goog.require('ol.math');
goog.require('ol.tilecoord');
/**
* {@link ol.source.Tile} sources use a function of this type to get the url
* that provides a tile for a given tile coordinate.
*
* This function takes an {@link ol.TileCoord} for the tile coordinate, a
* `{number}` representing the pixel ratio and an {@link ol.proj.Projection} for
* the projection as arguments and returns a `{string}` representing the tile
* URL, or undefined if no tile should be requested for the passed tile
* coordinate.
*
* @typedef {function(ol.TileCoord, number,
* ol.proj.Projection): (string|undefined)}
* @api
*/
ol.TileUrlFunctionType;
/**
* @param {string} template Template.
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
src/ol/transformfunction.js
-13
View File
@@ -1,13 +0,0 @@
goog.provide('ol.TransformFunction');
/**
* A transform function accepts an array of input coordinate values, an optional
* output array, and an optional dimension (default should be 2). The function
* transforms the input coordinate values, populates the output array, and
* returns the output array.
*
* @typedef {function(Array.<number>, Array.<number>=, number=): Array.<number>}
* @api stable
*/
ol.TransformFunction;
src/ol/typedefs-wfs.js
+26
View File
@@ -0,0 +1,26 @@
/**
* typedefs for the WFS sub-sub-namespace
* See typedefs.js for more details
*/
goog.provide('ol.format.WFS.FeatureCollectionMetadata');
goog.provide('ol.format.WFS.TransactionResponse');
/**
* Number of features; bounds/extent.
* @typedef {{numberOfFeatures: number,
* bounds: ol.Extent}}
* @api stable
*/
ol.format.WFS.FeatureCollectionMetadata;
/**
* Total deleted; total inserted; total updated; array of insert ids.
* @typedef {{totalDeleted: number,
* totalInserted: number,
* totalUpdated: number,
* insertIds: Array.<string>}}
* @api stable
*/
ol.format.WFS.TransactionResponse;
src/ol/typedefs.js
+736
View File
@@ -0,0 +1,736 @@
/**
* File for all typedefs used by the compiler, and referenced by JSDoc.
*
* These look like vars (or var properties), but in fact are simply identifiers
* for the Closure compiler. Originally they were included in the appropriate
* namespace file, but with the move away from Closure namespaces and towards
* self-contained standard modules are now all in this file, with two exceptions.
* Unlike the other type definitions - enums and constructor functions - they
* are not code and so are not imported or exported. They are only referred to
* in type-defining comments used by the Closure compiler, and so should not
* appear in module code.
*
* The 2 exceptions are the WFS typedefs which are in a sub-sub-namespace and
* are API. These have been put in their own separate file.
*
* When the code is converted to ES6 modules, the namespace structure will
* disappear, and these typedefs will have to be renamed accordingly, but the
* namespace structure is maintained for the present for backwards compatibility.
*
* In principle, typedefs should not have a `goog.provide` nor should files which
* refer to a typedef in comments need a `goog.require`. However, goog.provides
* are needed for 2 cases, both to prevent compiler errors/warnings:
* - the 1st two for specific errors
* - each sub-namespace needs at least one so the namespace is created when not
* used in the code, as when application code is compiled with the library.
*/
goog.provide('ol.Extent');
goog.provide('ol.events.EventTargetLike');
goog.provide('ol.format.KMLVec2_');
goog.provide('ol.interaction.DragBoxEndConditionType');
goog.provide('ol.layer.LayerState');
goog.provide('ol.proj.ProjectionLike');
goog.provide('ol.raster.Operation');
goog.provide('ol.render.canvas.FillState');
goog.provide('ol.renderer.webgl.TextureCacheEntry');
goog.provide('ol.reproj.ImageFunctionType');
goog.provide('ol.source.ImageOptions');
goog.provide('ol.structs.LRUCacheEntry');
goog.provide('ol.style.AtlasBlock');
goog.provide('ol.webgl.BufferCacheEntry');
goog.provide('ol.xml.NodeStackItem');
/**
* @typedef {string|Array.<string>|ol.Attribution|Array.<ol.Attribution>}
* @api
*/
ol.AttributionLike;
/**
* A function returning the canvas element (`{HTMLCanvasElement}`)
* used by the source as an image. The arguments passed to the function are:
* {@link ol.Extent} the image extent, `{number}` the image resolution,
* `{number}` the device pixel ratio, {@link ol.Size} the image size, and
* {@link ol.proj.Projection} the image projection. The canvas returned by
* this function is cached by the source. The this keyword inside the function
* references the {@link ol.source.ImageCanvas}.
*
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
* @api
*/
ol.CanvasFunctionType;
/**
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
*/
ol.CenterConstraintType;
/**
* A color represented as a short array [red, green, blue, alpha].
* red, green, and blue should be integers in the range 0..255 inclusive.
* alpha should be a float in the range 0..1 inclusive. If no alpha value is
* given then `1` will be used.
* @typedef {Array.<number>}
* @api
*/
ol.Color;
/**
* A type accepted by CanvasRenderingContext2D.fillStyle.
* Represents a color, pattern, or gradient.
*
* @typedef {string|CanvasPattern|CanvasGradient}
* @api
*/
ol.ColorLike;
/**
* An array of numbers representing an xy coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate
* @api stable
*/
ol.Coordinate;
/**
* A function that takes a {@link ol.Coordinate} and transforms it into a
* `{string}`.
*
* @typedef {function((ol.Coordinate|undefined)): string}
* @api stable
*/
ol.CoordinateFormatType;
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Extent;
/**
* {@link ol.source.Vector} sources use a function of this type to load
* features.
*
* This function takes an {@link ol.Extent} representing the area to be loaded,
* a `{number}` representing the resolution (map units per pixel) and an
* {@link ol.proj.Projection} for the projection as arguments. `this` within
* the function is bound to the {@link ol.source.Vector} it's called from.
*
* The function is responsible for loading the features and adding them to the
* source.
* @api
* @typedef {function(this:ol.source.Vector, ol.Extent, number,
* ol.proj.Projection)}
*/
ol.FeatureLoader;
/**
* A function that returns an array of {@link ol.style.Style styles} given a
* resolution. The `this` keyword inside the function references the
* {@link ol.Feature} to be styled.
*
* @typedef {function(this: ol.Feature, number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api stable
*/
ol.FeatureStyleFunction;
/**
* {@link ol.source.Vector} sources use a function of this type to get the url
* to load features from.
*
* This function takes an {@link ol.Extent} representing the area to be loaded,
* a `{number}` representing the resolution (map units per pixel) and an
* {@link ol.proj.Projection} for the projection as arguments and returns a
* `{string}` representing the URL.
* @api
* @typedef {function(ol.Extent, number, ol.proj.Projection) : string}
*/
ol.FeatureUrlFunction;
/**
* A function that is called to trigger asynchronous canvas drawing. It is
* called with a "done" callback that should be called when drawing is done.
* If any error occurs during drawing, the "done" callback should be called with
* that error.
*
* @typedef {function(function(Error))}
*/
ol.ImageCanvasLoader;
/**
* A function that takes an {@link ol.Image} for the image and a `{string}` for
* the src as arguments. It is supposed to make it so the underlying image
* {@link ol.Image#getImage} is assigned the content specified by the src. If
* not specified, the default is
*
* function(image, src) {
* image.getImage().src = src;
* }
*
* Providing a custom `imageLoadFunction` can be useful to load images with
* post requests or - in general - through XHR requests, where the src of the
* image element would be set to a data URI when the content is loaded.
*
* @typedef {function(ol.Image, string)}
* @api
*/
ol.ImageLoadFunctionType;
/**
* One of `all`, `bbox`, `tile`.
*
* @typedef {function(ol.Extent, number): Array.<ol.Extent>}
* @api
*/
ol.LoadingStrategy;
/**
* @typedef {{controls: ol.Collection.<ol.control.Control>,
* interactions: ol.Collection.<ol.interaction.Interaction>,
* keyboardEventTarget: (Element|Document),
* logos: (Object.<string, (string|Element)>),
* overlays: ol.Collection.<ol.Overlay>,
* rendererConstructor:
* function(new: ol.renderer.Map, Element, ol.Map),
* values: Object.<string, *>}}
*/
ol.MapOptionsInternal;
/**
* An array with two elements, representing a pixel. The first element is the
* x-coordinate, the second the y-coordinate of the pixel.
* @typedef {Array.<number>}
* @api stable
*/
ol.Pixel;
/**
* @typedef {function(ol.Map, ?olx.FrameState): boolean}
*/
ol.PostRenderFunction;
/**
* Function to perform manipulations before rendering. This function is called
* with the {@link ol.Map} as first and an optional {@link olx.FrameState} as
* second argument. Return `true` to keep this function for the next frame,
* `false` to remove it.
* @typedef {function(ol.Map, ?olx.FrameState): boolean}
* @api
*/
ol.PreRenderFunction;
/**
* @typedef {function((number|undefined), number, number): (number|undefined)}
*/
ol.ResolutionConstraintType;
/**
* @typedef {function((number|undefined), number): (number|undefined)}
*/
ol.RotationConstraintType;
/**
* An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Size;
/**
* An array of three numbers representing the location of a tile in a tile
* grid. The order is `z`, `x`, and `y`. `z` is the zoom level.
* @typedef {Array.<number>} ol.TileCoord
* @api
*/
ol.TileCoord;
/**
* A function that takes an {@link ol.Tile} for the tile and a `{string}` for
* the url as arguments.
*
* @typedef {function(ol.Tile, string)}
* @api
*/
ol.TileLoadFunctionType;
/**
* @typedef {function(ol.Tile, string, ol.Coordinate, number): number}
*/
ol.TilePriorityFunction;
/**
* @typedef {{
* dirty: boolean,
* renderedRenderOrder: (null|function(ol.Feature, ol.Feature):number),
* renderedTileRevision: number,
* renderedRevision: number,
* replayGroup: ol.render.IReplayGroup,
* skippedFeatures: Array.<string>}}
*/
ol.TileReplayState;
/**
* {@link ol.source.Tile} sources use a function of this type to get the url
* that provides a tile for a given tile coordinate.
*
* This function takes an {@link ol.TileCoord} for the tile coordinate, a
* `{number}` representing the pixel ratio and an {@link ol.proj.Projection} for
* the projection as arguments and returns a `{string}` representing the tile
* URL, or undefined if no tile should be requested for the passed tile
* coordinate.
*
* @typedef {function(ol.TileCoord, number,
* ol.proj.Projection): (string|undefined)}
* @api
*/
ol.TileUrlFunctionType;
/**
* A transform function accepts an array of input coordinate values, an optional
* output array, and an optional dimension (default should be 2). The function
* transforms the input coordinate values, populates the output array, and
* returns the output array.
*
* @typedef {function(Array.<number>, Array.<number>=, number=): Array.<number>}
* @api stable
*/
ol.TransformFunction;
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a
* `{boolean}`. If the condition is met, true should be returned.
*
* @typedef {function(ol.MapBrowserEvent): boolean}
* @api stable
*/
ol.events.ConditionType;
/**
* @typedef {EventTarget|ol.events.EventTarget|
* {addEventListener: function(string, Function, boolean=),
* removeEventListener: function(string, Function, boolean=),
* dispatchEvent: function(string)}}
*/
ol.events.EventTargetLike;
/**
* Key to use with {@link ol.Observable#unByKey}.
*
* @typedef {{bindTo: (Object|undefined),
* boundListener: (ol.events.ListenerFunctionType|undefined),
* callOnce: boolean,
* deleteIndex: (number|undefined),
* listener: ol.events.ListenerFunctionType,
* target: (EventTarget|ol.events.EventTarget),
* type: string}}
* @api
*/
ol.events.Key;
/**
* Listener function. This function is called with an event object as argument.
* When the function returns `false`, event propagation will stop.
*
* @typedef {function(ol.events.Event)|function(ol.events.Event): boolean}
* @api
*/
ol.events.ListenerFunctionType;
/**
* @typedef {{x: number, xunits: (ol.style.IconAnchorUnits|undefined),
* y: number, yunits: (ol.style.IconAnchorUnits|undefined)}}
*/
ol.format.KMLVec2_;
/**
* @typedef {{flatCoordinates: Array.<number>,
* whens: Array.<number>}}
*/
ol.format.KMLGxTrackObject_;
/**
* @typedef {{type: number, value: (number|string|undefined), position: number}}
*/
ol.format.WKTToken;
/**
* A function that takes a {@link ol.MapBrowserEvent} and two
* {@link ol.Pixel}s and returns a `{boolean}`. If the condition is met,
* true should be returned.
* @typedef {function(ol.MapBrowserEvent, ol.Pixel, ol.Pixel):boolean}
* @api
*/
ol.interaction.DragBoxEndConditionType;
/**
* Function that takes coordinates and an optional existing geometry as
* arguments, and returns a geometry. The optional existing geometry is the
* geometry that is returned when the function is called without a second
* argument.
* @typedef {function(!(ol.Coordinate|Array.<ol.Coordinate>|
* Array.<Array.<ol.Coordinate>>), ol.geom.SimpleGeometry=):
* ol.geom.SimpleGeometry}
* @api
*/
ol.interaction.DrawGeometryFunctionType;
/**
* @typedef {{depth: (Array.<number>|undefined),
* feature: ol.Feature,
* geometry: ol.geom.SimpleGeometry,
* index: (number|undefined),
* segment: Array.<ol.Extent>}}
*/
ol.interaction.SegmentDataType;
/**
* A function that takes an {@link ol.Feature} or {@link ol.render.Feature} and
* an {@link ol.layer.Layer} and returns `true` if the feature may be selected
* or `false` otherwise.
* @typedef {function((ol.Feature|ol.render.Feature), ol.layer.Layer):
* boolean}
* @api
*/
ol.interaction.SelectFilterFunction;
/**
* @typedef {{
* snapped: {boolean},
* vertex: (ol.Coordinate|null),
* vertexPixel: (ol.Pixel|null)
* }}
*/
ol.interaction.SnapResultType;
/**
* @typedef {{
* feature: ol.Feature,
* segment: Array.<ol.Coordinate>
* }}
*/
ol.interaction.SnapSegmentDataType;
/**
* @typedef {{layer: ol.layer.Layer,
* opacity: number,
* sourceState: ol.source.State,
* visible: boolean,
* managed: boolean,
* extent: (ol.Extent|undefined),
* zIndex: number,
* maxResolution: number,
* minResolution: number}}
*/
ol.layer.LayerState;
/**
* A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
* @api stable
*/
ol.proj.ProjectionLike;
/**
* A function that takes an array of input data, performs some operation, and
* returns an array of ouput data. For `'pixel'` type operations, functions
* will be called with an array of {@link ol.raster.Pixel} data and should
* return an array of the same. For `'image'` type operations, functions will
* be called with an array of {@link ImageData
* https://developer.mozilla.org/en-US/docs/Web/API/ImageData} and should return
* an array of the same. The operations are called with a second "data"
* argument, which can be used for storage. The data object is accessible
* from raster events, where it can be initialized in "beforeoperations" and
* accessed again in "afteroperations".
*
* @typedef {function((Array.<ol.raster.Pixel>|Array.<ImageData>), Object):
* (Array.<ol.raster.Pixel>|Array.<ImageData>)}
* @api
*/
ol.raster.Operation;
/**
* An array of numbers representing pixel values.
* @typedef {Array.<number>} ol.raster.Pixel
* @api
*/
ol.raster.Pixel;
/**
* @typedef {{fillStyle: ol.ColorLike}}
*/
ol.render.canvasFillState;
/**
* @typedef {{lineCap: string,
* lineDash: Array.<number>,
* lineJoin: string,
* lineWidth: number,
* miterLimit: number,
* strokeStyle: string}}
*/
ol.render.canvasStrokeState;
/**
* @typedef {{font: string,
* textAlign: string,
* textBaseline: string}}
*/
ol.render.canvasTextState;
/**
* @typedef {{magFilter: number, minFilter: number, texture: WebGLTexture}}
*/
ol.renderer.webglTextureCacheEntry;
/**
* @typedef {function(ol.Extent, number, number) : ol.ImageBase}
*/
ol.reproj.ImageFunctionType;
/**
* @typedef {function(number, number, number, number) : ol.Tile}
*/
ol.reproj.TileFunctionType;
/**
* Single triangle; consists of 3 source points and 3 target points.
*
* @typedef {{source: Array.<ol.Coordinate>,
* target: Array.<ol.Coordinate>}}
*/
ol.reproj.Triangle;
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* extent: (null|ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* projection: ol.proj.ProjectionLike,
* resolutions: (Array.<number>|undefined),
* state: (ol.source.State|undefined)}}
*/
ol.source.ImageOptions;
/**
* @typedef {{revision: number,
* resolution: number,
* extent: ol.Extent}}
*/
ol.source.RasterRenderedState;
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* logo: (string|olx.LogoOptions|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.SourceOptions;
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* cacheSize: (number|undefined),
* extent: (ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* opaque: (boolean|undefined),
* tilePixelRatio: (number|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.TileOptions;
/**
* @typedef {{attributions: (ol.AttributionLike|undefined),
* cacheSize: (number|undefined),
* extent: (ol.Extent|undefined),
* logo: (string|olx.LogoOptions|undefined),
* opaque: (boolean|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined),
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* tileLoadFunction: ol.TileLoadFunctionType,
* tilePixelRatio: (number|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined),
* url: (string|undefined),
* urls: (Array.<string>|undefined),
* wrapX: (boolean|undefined)}}
*/
ol.source.UrlTileOptions;
/**
* @typedef {{key_: string,
* newer: ol.structs.LRUCacheEntry,
* older: ol.structs.LRUCacheEntry,
* value_: *}}
*/
ol.structs.LRUCacheEntry;
/**
* @typedef {{x: number, y: number, width: number, height: number}}
*/
ol.style.AtlasBlock;
/**
* Provides information for an image inside an atlas.
* `offsetX` and `offsetY` are the position of the image inside
* the atlas image `image`.
* @typedef {{offsetX: number, offsetY: number, image: HTMLCanvasElement}}
*/
ol.style.AtlasInfo;
/**
* Provides information for an image inside an atlas manager.
* `offsetX` and `offsetY` is the position of the image inside
* the atlas image `image` and the position of the hit-detection image
* inside the hit-detection atlas image `hitImage`.
* @typedef {{offsetX: number, offsetY: number, image: HTMLCanvasElement,
* hitImage: HTMLCanvasElement}}
*/
ol.style.AtlasManagerInfo;
/**
* @typedef {{strokeStyle: (string|undefined), strokeWidth: number,
* size: number, lineDash: Array.<number>}}
*/
ol.style.CircleRenderOptions;
/**
* @typedef {{opacity: number,
* rotateWithView: boolean,
* rotation: number,
* scale: number,
* snapToPixel: boolean}}
*/
ol.style.ImageOptions;
/**
* A function that takes an {@link ol.Feature} as argument and returns an
* {@link ol.geom.Geometry} that will be rendered and styled for the feature.
*
* @typedef {function((ol.Feature|ol.render.Feature)):
* (ol.geom.Geometry|ol.render.Feature|undefined)}
* @api
*/
ol.style.GeometryFunction;
/**
* @typedef {{
* strokeStyle: (string|undefined),
* strokeWidth: number,
* size: number,
* lineCap: string,
* lineDash: Array.<number>,
* lineJoin: string,
* miterLimit: number
* }}
*/
ol.style.RegularShapeRenderOptions;
/**
* A function that takes an {@link ol.Feature} and a `{number}` representing
* the view's resolution. The function should return a {@link ol.style.Style}
* or an array of them. This way e.g. a vector layer can be styled.
*
* @typedef {function((ol.Feature|ol.render.Feature), number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api
*/
ol.style.StyleFunction;
/**
* @typedef {{buf: ol.webgl.Buffer,
* buffer: WebGLBuffer}}
*/
ol.webgl.BufferCacheEntry;
/**
* When using {@link ol.xml.makeChildAppender} or
* {@link ol.xml.makeSimpleNodeFactory}, the top `objectStack` item needs to
* have this structure.
* @typedef {{node:Node}}
*/
ol.xml.NodeStackItem;
/**
* @typedef {function(Node, Array.<*>)}
*/
ol.xml.Parser;
/**
* @typedef {function(Node, *, Array.<*>)}
*/
ol.xml.Serializer;
src/ol/vectortile.js
-12
View File
@@ -6,18 +6,6 @@ goog.require('ol.dom');
goog.require('ol.proj.Projection');
/**
* @typedef {{
* dirty: boolean,
* renderedRenderOrder: (null|function(ol.Feature, ol.Feature):number),
* renderedTileRevision: number,
* renderedRevision: number,
* replayGroup: ol.render.IReplayGroup,
* skippedFeatures: Array.<string>}}
*/
ol.TileReplayState;
/**
* @constructor
* @extends {ol.Tile}
src/ol/webgl/context.js
-7
View File
@@ -10,13 +10,6 @@ goog.require('ol.webgl.Buffer');
goog.require('ol.webgl.WebGLContextEventType');
/**
* @typedef {{buf: ol.webgl.Buffer,
* buffer: WebGLBuffer}}
*/
ol.webgl.BufferCacheEntry;
/**
* @classdesc
* A WebGL context for accessing low-level WebGL capabilities.
src/ol/xml.js
-21
View File
@@ -5,27 +5,6 @@ goog.require('goog.dom.NodeType');
goog.require('ol.array');
/**
* When using {@link ol.xml.makeChildAppender} or
* {@link ol.xml.makeSimpleNodeFactory}, the top `objectStack` item needs to
* have this structure.
* @typedef {{node:Node}}
*/
ol.xml.NodeStackItem;
/**
* @typedef {function(Node, Array.<*>)}
*/
ol.xml.Parser;
/**
* @typedef {function(Node, *, Array.<*>)}
*/
ol.xml.Serializer;
/**
* This document should be used when creating nodes for XML serializations. This
* document is also used by {@link ol.xml.createElementNS} and