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

Add ol.RenderOrderFunction typedef

Browse Source
This commit is contained in:
Ilia Choly
2017-03-09 12:50:37 -05:00
parent 1e3462d476
commit 2dc656c098
3 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
externs/olx.js
View File

@@ -3881,7 +3881,7 @@ olx.layer.TileOptions.prototype.useInterimTilesOnError;
/** /**
* @typedef {{renderOrder: (function(ol.Feature, ol.Feature):number|null|undefined), * @typedef {{renderOrder: (ol.RenderOrderFunction|null|undefined),
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* opacity: (number|undefined), * opacity: (number|undefined),
@@ -3900,7 +3900,7 @@ olx.layer.VectorOptions;
* Render order. Function to be used when sorting features before rendering. By * Render order. Function to be used when sorting features before rendering. By
* default features are drawn in the order that they are created. Use `null` to * default features are drawn in the order that they are created. Use `null` to
* avoid the sort, but get an undefined draw order. * avoid the sort, but get an undefined draw order.
* @type {function(ol.Feature, ol.Feature):number|null|undefined} * @type {ol.RenderOrderFunction|null|undefined}
* @api * @api
*/ */
olx.layer.VectorOptions.prototype.renderOrder; olx.layer.VectorOptions.prototype.renderOrder;
@@ -4015,7 +4015,7 @@ olx.layer.VectorOptions.prototype.visible;
* preload: (number|undefined), * preload: (number|undefined),
* renderBuffer: (number|undefined), * renderBuffer: (number|undefined),
* renderMode: (ol.layer.VectorTileRenderType|string|undefined), * renderMode: (ol.layer.VectorTileRenderType|string|undefined),
* renderOrder: (function(ol.Feature, ol.Feature):number|undefined), * renderOrder: (ol.RenderOrderFunction|undefined),
* source: (ol.source.VectorTile|undefined), * source: (ol.source.VectorTile|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined),
* updateWhileAnimating: (boolean|undefined), * updateWhileAnimating: (boolean|undefined),
@@ -4058,7 +4058,7 @@ olx.layer.VectorTileOptions.prototype.renderMode;
/** /**
* Render order. Function to be used when sorting features before rendering. By * Render order. Function to be used when sorting features before rendering. By
* default features are drawn in the order that they are created. * default features are drawn in the order that they are created.
* @type {function(ol.Feature, ol.Feature):number|undefined} * @type {ol.RenderOrderFunction|undefined}
* @api * @api
*/ */
olx.layer.VectorTileOptions.prototype.renderOrder; olx.layer.VectorTileOptions.prototype.renderOrder;

4
src/ol/layer/vector.js
View File

@@ -102,7 +102,7 @@ ol.layer.Vector.prototype.getRenderBuffer = function() {
* order. * order.
*/ */
ol.layer.Vector.prototype.getRenderOrder = function() { ol.layer.Vector.prototype.getRenderOrder = function() {
return /** @type {function(ol.Feature, ol.Feature):number|null|undefined} */ ( return /** @type {ol.RenderOrderFunction|null|undefined} */ (
this.get(ol.layer.Vector.Property_.RENDER_ORDER)); this.get(ol.layer.Vector.Property_.RENDER_ORDER));
}; };
@@ -157,7 +157,7 @@ ol.layer.Vector.prototype.getUpdateWhileInteracting = function() {
/** /**
* @param {function(ol.Feature, ol.Feature):number|null|undefined} renderOrder * @param {ol.RenderOrderFunction|null|undefined} renderOrder
* Render order. * Render order.
*/ */
ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) { ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {

11
src/ol/typedefs.js
View File

@@ -442,6 +442,15 @@ ol.RasterOperation;
ol.RegularShapeRenderOptions; ol.RegularShapeRenderOptions;
/**
* A function to be used when sorting features before rendering.
* It takes two instances of {@link ol.Feature} and returns a `{number}`.
*
* @typedef {function(ol.Feature, ol.Feature):number}
*/
ol.RenderOrderFunction;
/** /**
* @typedef {function(ol.Extent, number, number) : ol.ImageBase} * @typedef {function(ol.Extent, number, number) : ol.ImageBase}
*/ */
@@ -631,7 +640,7 @@ ol.TilePriorityFunction;
/** /**
* @typedef {{ * @typedef {{
* dirty: boolean, * dirty: boolean,
* renderedRenderOrder: (null|function(ol.Feature, ol.Feature):number), * renderedRenderOrder: (null|ol.RenderOrderFunction),
* renderedTileRevision: number, * renderedTileRevision: number,
* renderedRevision: number, * renderedRevision: number,
* replayGroup: ol.render.ReplayGroup}} * replayGroup: ol.render.ReplayGroup}}