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

Adding XYZOptions to objectliterals.jsdoc

Browse Source 
I remain uncertain about when to use the @exportClass annotation and when to use the @exportSymbol.  osmsource.exports seems to get away with simply @exportSymbol, but many other sources use @exportProperty.
This commit is contained in:
Tim Schaub
2013-09-10 18:23:48 -06:00
parent 0df6cebff9
commit 8d7d1412c9
3 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/objectliterals.jsdoc
View File

@@ -605,6 +605,24 @@
* @property {Array.<string>|undefined} urls Urls.
*/
/**
* @typedef {Object} ol.source.XYZOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin Cross origin setting for image
* requests.
* @property {ol.Extent|undefined} extent Extent.
* @property {string|undefined} logo Logo.
* @property {ol.ProjectionLike} projection Projection.
* @property {number} maxZoom Max zoom.
* @property {number|undefined} minZoom Unsupported (TODO: remove this).
* @property {ol.TileUrlFunctionType|undefined} tileUrlFunction Optional
* function to get tile URL given a tile coordinate and the projection.
* Required if url or urls are not provided.
* @property {string|undefined} url URL template. Must include '{x}', '{y}',
* and '{z}' placeholders.
* @property {Array.<string>|undefined} urls An array of URL templates.
*/
/**
* @typedef {Object} ol.style.IconOptions
* @property {string|ol.expr.Expression} url Icon image url.