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

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

@@ -102,7 +102,7 @@ ol.layer.Vector.prototype.getRenderBuffer = function() {
* order.
*/
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));
};
@@ -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.
*/
ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {

11
src/ol/typedefs.js
View File

@@ -442,6 +442,15 @@ ol.RasterOperation;
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}
*/
@@ -631,7 +640,7 @@ ol.TilePriorityFunction;
/**
* @typedef {{
* dirty: boolean,
* renderedRenderOrder: (null|function(ol.Feature, ol.Feature):number),
* renderedRenderOrder: (null|ol.RenderOrderFunction),
* renderedTileRevision: number,
* renderedRevision: number,
* replayGroup: ol.render.ReplayGroup}}