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

Add comments for the canvasFunction option

Browse Source
This commit is contained in:
Éric Lemoine
2014-01-28 21:36:32 +01:00
parent 0eb72667c9
commit d49d96d651
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/objectliterals.jsdoc
View File

@@ -652,7 +652,14 @@
/**
* @typedef {Object} olx.source.ImageCanvasOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {ol.CanvasFunctionType} canvasFunction Canvas function.
* @property {ol.CanvasFunctionType} canvasFunction Canvas function. The function
* returning the canvas element used by the source as an image. The arguments
* passed to the function are: `{ol.Extent}` the image extent, `{number}` the
* image resolution, `{number}` the device pixel ratio, `{ol.Size}` the image
* size, and `{ol.proj.Projection}` the image projection. The canvas returned
* by this function is cached by the source. If the value returned by the
* function is later changed then `dispatchChangeEvent` should be called on
* the source for the source to invalidate the current cached image.
* @property {ol.Extent|undefined} extent Extent.
* @property {string|undefined} logo Logo.
* @property {ol.proj.ProjectionLike} projection Projection.